Using Liquibase with Oracle ATP & ADW

Oracle Autonomous Database is an Oracle Cloud product with a set of services that deliver automated patching, upgrades, and tuning. It includes:

  • Autonomous Transaction Processing (ATP) – an Autonomous Database service that can instantly scale to meet demands of mission critical transaction processing and mixed workload applications.
  • Autonomous Data Warehouse (ADW) – a fully autonomous data warehousing environment that scales elastically, delivers fast query performance, and requires no database administration.

For more information, see the Oracle Cloud documentation page.

Supported Versions

  • 19c – officially supported

Prerequisites

Before using Liquibase with your database, ensure you have:

Driver Information

To use Liquibase and Oracle ATP or Oracle ADW, you need to have the JDBC jar file:

  1. Ensure you downloaded the Oracle JDBC driver jar file to connect to the Oracle database. You can download ojdbc8.jar or ojdbc10.jar. The ojdbc10.jar file is certified with JDK10 and JDK11, and the ojdbc8.jar file is certified with JDK8, JDK9, and JDK11.

    2. Note: It is best practice to use the Oracle Database 18c (or higher) drivers. Also, the following additional .jar files are required: oraclepki.jar, osdt_cert.jar, and osdt_core.jar. For more information, see Using Oracle Autonomous Database on Shared Exadata Infrastructure.

  2. Place the ojdbc<version>.jar file in the liquibase/lib directory.

Note: If you place the ojdbc<version>.jar file in a different directory, specify the path in the Liquibase properties file, as follows: classpath:../path_to_drivers/ojdbc<version>.jar. For more information, see Specifying Properties in a Connection Profile.

If you use Maven, you also need to download the Oracle driver jar file and put the driver in a location that your Maven build can access. Configure the Maven pom.xml file to use the local copy of the driver jar file. For example:

<dependency>
    <groupId>com.oracle.ojdbc</groupId>
    <artifactId>ojdbc8</artifactId>
    <version>19.3.0.0</version>
</dependency>

Testing Your Connection

For Liquibase and Oracle ATP or Oracle ADW to work, you need to:

  1. Ensure that you created:
  1. Download the Wallet to connect to the database:
    1. Log into your Oracle Cloud account.
    2. Navigate to the Autonomous Database details page and select DB Connection.
    3. Select Wallet Type, and then select Download.
    4. Enter a secure password for the Wallet and download the .zip file to save the client security credentials.
    5. Unzip the Wallet and place it somewhere safe in your file system to prevent unauthorized database access.
    6. Navigate to the Wallet folder and update the ojdbc.properties file with the following:
      • Comment out the oracle.net.wallet_location line.
      • Set javax.net.ssl.trustStorePassword to the Wallet password that you entered to download the Wallet.
      • Set javax.net.ssl.keyStorePassword to the Wallet password that you entered to download the Wallet.
      #oracle.net.wallet_location=(SOURCE=(METHOD=FILE)(METHOD_DATA=(DIRECTORY=${TNS_ADMIN})))
javax.net.ssl.trustStore=${TNS_ADMIN}/truststore.jks
javax.net.ssl.trustStorePassword=my_wallet_password
javax.net.ssl.keyStore=${TNS_ADMIN}/keystore.jks
javax.net.ssl.keyStorePassword=my_wallet_password
    7. In the Wallet folder, open the sqlnet.ora and ensure that SSL_SERVER_DN_MATCH=yes.

Note: You can use other methods to securely connect to Autonomous Database. For more information, see Connecting to Autonomous Database.

  1. Specify the database URL in the Liquibase properties file, as follows:
    2. url: jdbc:oracle:thin:@<database_name>_high?TNS_ADMIN=/path/to/Wallet_<database_name>

    Note: If you use Windows, ensure the TNS_ADMIN path to your wallet folder includes double dashes in the URL property.

    Example: url: jdbc:oracle:thin:@databaseName_high?TNS_ADMIN=path//to//Wallet_databaseName

  1. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.

<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
	xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
	xmlns:pro="http://www.liquibase.org/xml/ns/pro"
	xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
		http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.9.xsd
		http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
		http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-4.9.xsd">
    <changeSet id="1" author="Liquibase">
    <createTable tableName="test_table">
           <column name="test_id" type="int">
                 <constraints primaryKey="true"/>
           </column>
           <column name="test_column" type="varchar"/>
    </createTable>
    </changeSet>
</databaseChangeLog>
-- liquibase formatted sql

-- changeset liquibase:1
CREATE TABLE test_table (test_id INT, test_column VARCHAR, PRIMARY KEY (test_id))

Note: Formatted SQL changelogs generated by using Liquibase versions previous to 4.2 might cause issues because of the lack of space after a double dash ( -- ).

Tip: To fix those issues, add a space after the double dash. For example: -- liquibase formatted sql instead of --liquibase formatted sql and -- changeset myname:create-table instead of --changeset myname:create-table

databaseChangeLog:
   - changeSet:
       id: 1
       author: Liquibase
       changes:
       - createTable:
           columns:
           - column:
               name: test_column
               type: INT
               constraints:  
                   primaryKey:  true  
                   nullable:  false  
                   tableName: test_table
{ 
  "databaseChangeLog": [
  {
	"changeSet": {
	  "id": "1",
      "author": "Liquibase",
	  "changes": [
	    {
		  "createTable": {
		    "columns": [
			{
			  "column": 
		      {
				"name": "test_column",
				"type": "INT",
				"constraints": 
			  {
				"primaryKey": true,
				"nullable": false
				}
				}
			  }]
			,
			"tableName": "test_table"
		  }
		}]
	  }
	}]
  }
  1. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful. You can pass arguments in the CLI or keep them in the Liquibase properties file.
    2. liquibase --username=test --password=test --changelog-file=<changelog.xml> status
  2. Run your first update with the update command, which makes changes to your database. You can also run the update-sql command to inspect the SQL before running the update command.
    3. liquibase --changelog-file=<changelog.xml> update-sql
liquibase --changelog-file=<changelog.xml> update

From a database UI tool, ensure that your database contains the table you added along with the DATABASECHANGELOG table and DATABASECHANGELOGLOCK table.

Change Type Supported
addAutoIncrement Not Supported
addCheckConstraint Supported
addColumn Supported
addDefaultValue Supported
addForeignKeyConstraint Supported
addLookupTable Supported
addNotNullConstraint Supported
addPrimaryKey Supported
addUniqueConstraint Supported
alterSequence Supported
createFunction Supported
createIndex Supported
createPackage Supported
createPackageBody Supported
createProcedure Supported
createSequence Supported
createSynonym Supported
createTable Supported
createTrigger Supported
createView Supported
customChange Supported
delete Supported
disableCheckConstraint Supported
disableTrigger Supported
dropAllForeignKeyConstraints Supported
dropCheckConstraint Supported
dropColumn Supported
dropDefaultValue Supported
dropForeignKeyConstraint Supported
dropFunction Supported
dropIndex Supported
dropNotNullConstraint Supported
dropPackage Supported
dropPackageBody Supported
dropPrimaryKey Supported
dropProcedure Supported
dropSequence Supported
dropSynonym Supported
dropTable Supported
dropTrigger Supported
dropUniqueConstraint Supported
dropView Supported
empty Supported
enableCheckConstraint Supported
enableTrigger Supported
executeCommand Supported
insert Supported
loadData Supported
loadUpdateData Supported
markUnused Supported
mergeColumns Supported
modifyDataType Supported
output Supported
renameColumn Supported
renameSequence Supported
renameTable Supported
renameTrigger Supported
renameView Supported
setColumnRemarks Supported
setTableRemarks Supported
sql Supported
sqlFile Supported
stop Supported
tagDatabase Supported
update Supported
Command Supported
calculate-checksum Supported
changelog-sync Supported
changelog-sync-sql Supported
changelog-sync-to-tag Supported
changelog-sync-to-tag-sql Supported
clear-checksums Supported
db-doc Supported
deactivate-changelog Supported
diff Supported
diff JSON Supported
diff-changelog Supported
drop-all Supported
future-rollback-count-sql Supported
future-rollback-from-tag-sql Supported
future-rollback-sql Supported
generate-changelog Supported
help Supported
history Supported
list-locks Supported
mark-next-changeset-ran Supported
mark-next-changeset-ran-sql Supported
register-changelog Supported
release-locks Supported
rollback Supported
rollback-count Supported
rollback-count-sql Supported
rollback-one-changeset Supported
rollback-one-changeset-sql Supported
rollback-one-update Supported
rollback-one-update-sql Supported
rollback-sql Supported
rollback-to-date Supported
rollback-to-date-sql Supported
snapshot Supported
snapshot-reference Supported
status Supported
sync-hub Supported
tag Supported
tag-exists Supported
unexpected-changesets Supported
update Supported
update-sql Supported
update-count Supported
update-count-sql Supported
update-testing-rollback Supported
update-to-tag Supported
update-to-tag-sql Supported
validate Supported

Related Links