Using Liquibase with Oracle

Oracle Database is an object-relational database that offers market-leading performance, scalability, reliability, and security, both on-premises and in the cloud.

Note: For more information, see the Oracle documentation page.

Supported Versions

  • 11g – officially certified
  • 12c – officially certified
  • 18.4.0 – officially supported and tested with Test Harness
  • 19.9.0 – officially supported and tested with Test Harness

Prerequisites

Before using Liquibase and Oracle, ensure you have completed the following:

Driver Information

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

  1. Ensure you have 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. Place the ojdbc<version>.jar file in the liquibase/lib directory.

Note: If you put the ojdbc<version>.jar file in any other directory, specify the path to it in the liquibase.properties file: classpath:../path_to_drivers/ojdbc<version>.jar. For more information, see Creating and configuring a liquibase.properties file.

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.database.jdbc</groupId>
<artifactId>ojdbc8</artifactId>
<version>19.3.0.0</version>
</dependency>

Testing Your Connection

For Liquibase and Oracle to work, you need to:

  1. Ensure Oracle is configured. See the following:
  1. Specify the database URL in the liquibase.properties file or as a parameter to the command in the CLI. See the following:
  1. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.

  1. Run the status command to see whether the connection is successful. Specify the name of the changelog you created in place of changelog.xml. Also, to run Liquibase commands, you need to specify your username and password in the liquibase.properties file or on the command line. However, the username and password attributes are not required for connections and systems which use alternate means of authentication.
  2. liquibase --username=test --password=test --changeLogFile=changelog.xml status

    Note: Alternatively, you can add the changeLogFile attribute to your liquibase.properties file.

  1. Run your first update with the Liquibase update command, which will make changes to your database. You can also run the updateSQL command if you want to inspect the SQL before running the update command.
  2. liquibase --changeLogFile=changelog.xml updateSQL
    liquibase --changeLogFile=changelog.xml update

After your first update, you will see a new table along with the DATABASECHANGELOG and DATABASECHANGELOGLOCK tables added to the database:

  • DATABASECHANGELOG table. This table keeps a record of all the changesets that were deployed. When you deploy, the changesets in the changelog are compared with the DATABASECHANGELOG tracking table, and only the new changesets that were not found in the DATABASECHANGELOG will be deployed.
  • DATABASECHANGELOGLOCK table. This table is used internally by Liquibase to manage access to the DATABASECHANGELOG table during deployment and ensure only one instance of Liquibase is updating the database at a time, whether that is creating, updating or deleting changes.

Oracle Server

  • Specify the database URL in your liquibase.properties file:
    url: jdbc:oracle:thin:@<host>:<port>/<service_name>
  • Tip: If you already have a Liquibase Pro key and want to apply it to your project, add the following property to your liquibase.properties file: liquibaseProLicenseKey: <paste license key>.

Oracle on AWS RDS

Check the connection by using any standard SQL client application, including SQL*Plus, and running the following:

Linux, macOS, or Unix

sqlplus 'user_name@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dns_name)(PORT=port))(CONNECT_DATA=(SID=database_name)))'

Windows

sqlplus user_name@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=dns_name)(PORT=port))(CONNECT_DATA=(SID=database_name)))

Note: The user name represents your DB instance administrator, and the DNS name stands for your DB instance. Also, replace the port number and the Oracle SID with your values. The Oracle SID is the name of the DB instance's database that you specified when you created the DB instance.

Tip: The alternative way is to connect with Oracle SQL Developer.

You can find the connection information in the AWS Management Console:

  1. Sign in to the AWS Management Console and open the Amazon RDS console.
  2. In the upper-right corner of the console, choose the AWS Region of your DB instance.
  3. Find the DNS name and port number for your DB Instance:
    • Select Databases and choose the needed Oracle DB instance to display the instance details.
    • Select Connectivity & security. You will see all information under Endpoint & Port.

Note: To find the connection information using the AWS CLI, call the describe-db-instances command: aws rds describe-db-instances. In the output, you will see the Port line and the Address line containing the DNS name.

Specify the database URL in the liquibase.properties file as follows:

url: jdbc:oracle:thin:@<endpoint>:<port>:<sid>

Example: url: jdbc:oracle:thin:@myrds.cz1j1vh9uvuo.us-east-1.rds.amazonaws.com:3306:orcl

Supported Commands and Change Types

Change Type Supported Command Supported
addAutoIncrement Not Supported calculateCheckSum <id> Supported
addCheckConstraint Supported changelogSync Supported
addColumn Supported changelogSyncSQL Supported
addDefaultValue Supported changelogSyncToTag Supported
addForeignKeyConstraint Supported changelogSyncToTagSQL Supported
addLookupTable Supported clearCheckSums Supported
addNotNullConstraint Supported dbDoc Supported
addPrimaryKey Supported deactivateChangeLog Supported
addUniqueConstraint Supported diff Supported
alterSequence Supported diff JSON Supported
createFunction Supported diffChangeLog Supported
createIndex Supported dropAll Supported
createPackage Supported futureRollbackCountSQL <value> Supported
createPackageBody Supported future-rollback-from-tag-sql <tag> Supported
createProcedure Supported futureRollbackSQL Supported
createSequence Supported generateChangeLog Supported
createSynonym Supported help Supported
createTable Supported history Supported
createTrigger Supported listLocks Supported
createView Supported markNextChangeSetRan Supported
customChange Supported markNextChangeSetRanSQL Supported
delete Supported registerChangeLog Supported
disableCheckConstraint Supported releaseLocks Supported
disableTrigger Supported rollback <tag> Supported
dropAllForeignKeyConstraints Supported rollbackCount <value> Supported
dropCheckConstraint Supported rollbackCountSQL <value> Supported
dropColumn Supported rollbackOneChangeSet Supported
dropDefaultValue Supported rollbackOneChangeSetSQL Supported
dropForeignKeyConstraint Supported rollbackOneUpdate Supported
dropFunction Supported rollbackOneUpdateSQL Supported
dropIndex Supported rollbackSQL <tag> Supported
dropNotNullConstraint Supported rollbackToDate Supported
dropPackage Supported rollbackToDateSQL Supported
dropPackageBody Supported snapshot Supported
dropPrimaryKey Supported snapshotReference Supported
dropProcedure Supported status --verbose Supported
dropSequence Supported syncHub Supported
dropSynonym Supported tag <tag string> Supported
dropTable Supported tagExists <tag string> Supported
dropTrigger Supported unexpectedChangeSets Supported
dropUniqueConstraint Supported update Supported
dropView Supported updateSQL Supported
empty Supported updateCount <value> Supported
enableCheckConstraint Supported updateCountSQL <value> Supported
enableTrigger Supported updateTestingRollback Supported
executeCommand Supported updateToTag <tag> Supported
insert Supported updateToTagSQL <tag> Supported
loadData Supported validate 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    

Related Links