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. For more information, see the Oracle documentation page.

Supported versions

  • 21.3.0
  • 19.9.0
  • 18.4.0
  • 18.3.0
  • 12c
  • 11g

Verification level

Guaranteed: All applicable Liquibase Open Source and Liquibase Pro functionality works with this database. Verified by automated and real-world testing from Liquibase. The Liquibase support team provides best-effort usage, bug-fix, and prioritized feature request support to Commercial users.

Note: A database's verification level indicates how well it works with different features in Liquibase and across different products, such as Liquibase Open Source and Liquibase Pro. For more information, see Liquibase Database Tutorials.

Prerequisites

Install Drivers

To use Liquibase and Oracle, you need the JDBC driver JAR file (Maven download).

The latest version of Liquibase has a pre-installed driver for this database in the liquibase/internal/lib directory. Read more: Adding and Updating Liquibase Drivers.

If you use Maven, you must include the driver JAR as a dependency in your pom.xml file. Read more: Configuring Liquibase Attributes in your Maven POM File.

<dependency>
    <groupId>com.oracle.database.jdbc</groupId>
    <artifactId>ojdbc8</artifactId>
    <version>21.5.0.0</version>
</dependency>

Test your connection

  1. Ensure Oracle is configured
  2. Specify the database URL in the Liquibase properties file. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard JDBC format:
  1. Create a text file called changelog (.xml, .sql, .json, or .yaml) in your project directory and add a changeset.
  2. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful:
  3. liquibase --username=test --password=test --changelog-file=<changelog.xml> status

    Note: You can pass arguments in the CLI or keep them in the Liquibase properties file.

  4. Inspect the SQL with the update-sql command. Then make changes to your database with the update command.
  5. liquibase --changelog-file=<changelog.xml> update-sql
    liquibase --changelog-file=<changelog.xml> update
  6. From a database UI tool, ensure that your database contains the test_table you added along with the DATABASECHANGELOG table and DATABASECHANGELOGLOCK table.

Oracle Server

  • Check the status by using SRVCTL, SQL*Plus, or Oracle Enterprise Manager. Also, you can run the following query:
  • SELECT INSTANCE_NAME, STATUS, DATABASE_STATUS FROM V$INSTANCE;
  • Specify the database URL in the Liquibase properties file. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard JDBC format:
    url: jdbc:oracle:thin:@<host>:<port>/<service_name>
  • Tip: To apply a Liquibase Pro key to your project, add the following property to the Liquibase properties file: liquibaseProLicenseKey: <paste code here>

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: user_name represents your DB instance administrator, and 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, as follows: 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. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard JDBC format:

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

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

Related links