Using Liquibase with SAP HANA

SAP HANA (High-performance ANalytic Appliance) is an in-memory, column-oriented relational database management system. For more information, see SAP HANA Documentation and SAP HANA Help Portal.

Supported versions

• 2.0

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 Liquibase.
• Create a Liquibase project folder to store all Liquibase files. You can do this manually or with the init project command.
• Create a new Liquibase properties file or use the liquibase.properties file included in the installation package. For more information, see Specifying Properties in a Connection Profile.

Install drivers

To use Liquibase and SAP HANA, you need two files:

• The SAP HANA JDBC driver JAR file (Maven download). If you used the SAP HANA client software package, the JDBC driver JAR file is already installed as part of it.
• The SAP HANA Liquibase extension.

Place your JAR file(s) in the liquibase/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.sap.cloud.db.jdbc</groupId>
    <artifactId>ngdbc</artifactId>
    <version>2.14.7</version>
    <type>pom</type>
</dependency>
<dependency>
    <groupId>org.liquibase.ext</groupId>
    <artifactId>liquibase-hanadb</artifactId>
    <version>4.16.1</version>
</dependency>

Test your connection

1. Ensure your SAP HANA database is configured. See Installing SAP HANA for more information.
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:

url: jdbc:sap://localhost:30013/?databaseName=mydatabase&encrypt=true

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

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

<?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-latest.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-latest.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>

SQL example

-- liquibase formatted sql

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

Tip: Formatted SQL changelogs generated from Liquibase versions before 4.2 might cause issues because of the lack of space after a double dash ( -- ). To fix this, 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

YAML example

databaseChangeLog:
   - changeSet:
       id: 1
       author: Liquibase
       changes:
       - createTable:
           columns:
           - column:
               name: test_column
               type: INT
               constraints:  
                   primaryKey:  true  
                   nullable:  false  
                   tableName: test_table

JSON example

{ 
  "databaseChangeLog": [
  {
	"changeSet": {
	  "id": "1",
      "author": "Liquibase",
	  "changes": [
	    {
		  "createTable": {
		    "columns": [
			{
			  "column": 
		      {
				"name": "test_column",
				"type": "INT",
				"constraints": 
			  {
				"primaryKey": true,
				"nullable": false
				}
				}
			  }]
			,
			"tableName": "test_table"
		  }
		}]
	  }
	}]
  }

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

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.

5. Inspect the SQL with the update-sql command. Then make changes to your database with the update command.

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

• Connecting to SAP HANA Databases and Servers
• Connect to SAP HANA via JDBC
• Liquibase Change Types
• Liquibase Commands