Connecting Liquibase with Oracle Database

If you're running Liquibase using the Maven plugin using mvn liquibase:update installing the extension with Maven ensures the right files are available and everything works together automatically. You can manage these extensions by adding them as dependencies in your project’s pom.xml file. When configured this way, Maven automatically downloads the specified JAR files from Maven Central during the build process.

1. Ensure Oracle is configured

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;

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.

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.

4. Select Databases and choose the needed Oracle DB instance to display the instance details.

5. 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.

The alternative way is to connect with Oracle SQL Developer.

2. Specify the database URL in the liquibase.properties file (defaults file), along with other properties you want to set a default value for. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard connection format:

Oracle Server

Specify the database URL in the liquibase.properties file (defaults file), along with other properties you want to set a default value for. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard connection format:

url: jdbc:oracle:thin:@<host>:<port>/<service_name>

Oracle on AWS RDS

Specify the database URL in the liquibase.properties file (defaults file), along with other properties you want to set a default value for. Liquibase does not parse the URL. You can either specify the full database connection string or specify the URL using your database's standard connection format:

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

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

If you already created a changelog using the init project command, you can use that instead of creating a new file. When adding onto an existing changelog, be sure to only add the changeset and to not duplicate the changelog header.

2. Navigate to your project folder in the CLI and run the Liquibase status command to see whether the connection is successful:

liquibase status

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

If your connection is successful, you'll see a message like this:

4 changesets have not been applied to <your_connection_url> Liquibase command 'status' was executed successfully.

3. Inspect the deployment SQL with the update-sql command

liquibase update-sql

If the SQL that Liquibase generates isn't what you expect, you should review your changelog file and make any necessary adjustments.

4. Then execute these changes to your database with the update command:

liquibase update

If your update is successful, Liquibase runs each changeset and displays a summary message ending with:

Liquibase: Update has been successful. Liquibase command 'update' was executed successfully.

5. Verify that the database contains your test_table and the DATABASECHANGELOG, and DATABASECHANGELOGLOCK tables.