Using Liquibase with DB2 on z/OS

DB2 on z/OS is a relational database management system that runs on the mainframe. For more information, see the DB2 for z/OS documentation page.

Supported versions

  • 11.5.7+

Verification level

Unverified: Liquibase does not have enough information to know how well this extension or integration works.

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

Prerequisites

Install drivers

To use Liquibase and DB2 on z/OS, you need the DB2JCC driver (Maven download) and the license JAR file, which is required when connecting to a mainframe DB2 database. You must purchase the DB2 Connect product. The license file is contained within the activation package for it. For more information regarding the license file, see Location of the db2jcc_license_cisuz.jar file. Place the license JAR file in the liquibase/lib directory.

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.ibm.db2</groupId>
    <artifactId>jcc</artifactId>
    <version>11.5.7.0</version>
</dependency>
<dependency>
    <groupId>org.liquibase.ext</groupId>
    <artifactId>liquibase-db2i</artifactId>
    <version>4.16.1</version>
</dependency>

Test your connection

  1. Ensure your DB2 on z/OS database is configured. You can check the status by running the DISPLAY DATABASE command, which displays status information about DB2 databases.
  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:
  3. url: jdbc:db2://<servername>:<port>/<dbname>

    Note: The URL for DB2 on z/OS may have different formats, such as jdbc:db2j:net:, jdbc:ibmdb:, and jdbc:ids:, depending on your connection type. For more information, see URL format for IBM Data Server Driver for JDBC and SQLJ type 4 connectivity.

    Tip: To apply a Liquibase Pro key to your project, add the following property to the Liquibase properties file: liquibaseProLicenseKey: <paste code here>

  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.

Related links