Using Liquibase with SingleStoreDB

SingleStoreDB unifies transactions and analytics in a single engine to drive low-latency access to large datasets, simplifying the development of fast, modern enterprise applications.

Supported database versions

• SingleStoreDB v8.1+

Prerequisites

1. Introduction to Liquibase – Dive into Liquibase concepts.
2. Install Liquibase – Download Liquibase on your machine.
3. Get Started with Liquibase – Learn how to use Liquibase with an example database.
4. Design Your Liquibase Project – Create a new Liquibase project folder and organize your changelogs
5. How to Apply Your Liquibase Pro License Key – If you use Liquibase Pro, activate your license.

Install Drivers

To use Liquibase and SingleStoreDB you need two JAR files:

• The SingleStoreDB JDBC driver
• The Liquibase extension for SingleStoreDB

Place your JAR files in the liquibase/lib directory.

If you use Maven, you must include the driver JARs as dependencies in your pom.xml file.

<dependency>
    <groupId>com.singlestore</groupId>
    <artifactId>singlestore-jdbc-client</artifactId>
    <version>1.1.5</version>
</dependency>
<dependency>
    <groupId>org.liquibase.ext</groupId>
    <artifactId>liquibase-singlestore</artifactId>
    <version>1.0.1</version>
</dependency>

Test Your Connection

Step 1. Ensure your SingleStoreDB database is configured. See the SingleStoreDB Getting Started documentation for more information.

Step 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 JDBC format: jdbc:singlestore://localhost:3306/dev

Step 3. Create a text file called changelog (.xml, .sql, .json, or .yaml) 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.

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="INT"/>
        </createTable>
    </changeSet>

</databaseChangeLog>

SQL Example

-- liquibase formatted sql

-- changeset liquibase:1
CREATE TABLE test_table (test_id INT, test_column INT, 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.

JSON Example

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

YAML Example

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

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

liquibase status --username=test --password=test --changelog-file=<changelog.xml>

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_jdbc_url>
Liquibase command 'status' was executed successfully.

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

liquibase update-sql --changelog-file=<changelog.xml>
liquibase update --changelog-file=<changelog.xml>

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.

Step 6. From a database UI tool, ensure that your database contains the test_table you added along with the DATABASECHANGELOG table and DATABASECHANGELOGLOCK table.

Now you're ready to start making deployments with Liquibase!

Related Links

• Change Types
• Liquibase Commands