Skip to main content
Version: 3.10

Getting Started with ScalarDB Cluster SQL via JDBC

This tutorial describes how to create a sample application by using ScalarDB Cluster SQL via JDBC. You'll be using the same sample application as found in the ScalarDB SQL (JDBC) Sample.


  • Java (OpenJDK 8 or higher)
  • Gradle

In this tutorial, we assume that you have a ScalarDB Cluster running on a Kubernetes cluster that you deployed by following the instructions in Set Up ScalarDB Cluster on Kubernetes by Using a Helm Chart.

In addition, you need access to the ScalarDB Cluster GitHub repository, packages in the ScalarDB Cluster repository, and packages in the ScalarDB SQL repository. These repositories are available only to users with a commercial license and permission. To get a license and permission, please contact us.

You also need to set the gpr.user property to your GitHub username and the gpr.key property to your personal access token. To do so, you must either add these properties in ~/.gradle/ or specify the properties by using the -P option when running the ./gradlew command as follows:

$ ./gradlew run ... -Pgpr.user=<YOUR_GITHUB_USERNAME> -Pgpr.key=<YOUR_PERSONAL_ACCESS_TOKEN>

Or you can use environment variables, such as USERNAME for your GitHub username and TOKEN for your personal access token.


For more details, see Developer Guide for ScalarDB Cluster with the Java API.

Sample application

This tutorial illustrates the process of creating a sample e-commerce application, where items can be ordered and paid for with a credit card by using ScalarDB. For details about the sample application, see the sample application for ScalarDB SQL (JDBC).

The following diagram shows the system architecture of the sample application:

| [Kubernetes Cluster] |
| |
| [Pod] [Pod] [Pod] |
+------------------------+ | |
| SQL CLI | | +-------+ +-----------------------+ |
| (indirect client mode) | --+ | +---> | Envoy | ---+ +---> | ScalarDB Cluster Node | ---+ |
+------------------------+ | | | +-------+ | | +-----------------------+ | |
| | | | | | |
| | +---------+ | +-------+ | +--------------------+ | +-----------------------+ | +------------+ |
+--+-> | Service | ---+---> | Envoy | ---+---> | Service | ---+---> | ScalarDB Cluster Node | ---+---> | PostgreSQL | |
| | | (Envoy) | | +-------+ | | (ScalarDB Cluster) | | +-----------------------+ | +------------+ |
+------------------------+ | | +---------+ | | +--------------------+ | | |
| Sample application | | | | +-------+ | | +-----------------------+ | |
| with ScalarDB JDBC | --+ | +---> | Envoy | ---+ +---> | ScalarDB Cluster Node | ---+ |
| (indirect client mode) | | +-------+ +-----------------------+ |
+------------------------+ | |

Step 1. Clone the ScalarDB Samples repository

$ git clone
$ cd scalardb-samples/scalardb-sql-jdbc-sample

Step 2. Modify build.gradle

To use ScalarDB Cluster, you need to modify build.gradle:

$ vim build.gradle

First, add the following repository for ScalarDB Cluster to the repositories section:

repositories {

maven {
url = uri("")
credentials {
username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")

Then, delete the existing dependency for com.scalar-labs:scalardb-sql-direct-mode:3.10.3 from the dependencies section, and add the following dependency to the dependencies section:

dependencies {

implementation 'com.scalar-labs:scalardb-cluster-client:3.10.3'

Step 3. Modify

You need to modify to connect to ScalarDB Cluster as well. But before doing so, you need to get the EXTERNAL-IP address of the service resource of Envoy (scalardb-cluster-envoy) as follows:

$ kubectl get svc scalardb-cluster-envoy
scalardb-cluster-envoy LoadBalancer localhost 60053:30641/TCP 16h

In this case, the EXTERNAL-IP address is localhost.

Next, open

$ vim

Then, modify as follows:


To connect to ScalarDB Cluster, you need to specify cluster for the scalar.db.sql.connection_mode property. In addition, you will use the indirect client mode and connect to the service resource of Envoy in this tutorial. For details about the client modes, see Developer Guide for ScalarDB Cluster with the Java API.

Step 4. Load a schema

To load a schema via ScalarDB Cluster SQL, you need to use the dedicated SQL CLI for ScalarDB Cluster (SQL CLI for Cluster). Using the SQL CLI for Cluster is basically the same as using the ScalarDB SQL Command Line Interface except the name of the JAR file is different. You can download the SQL CLI for Cluster from Releases. After downloading the JAR file, you can use SQL CLI for Cluster by running the following command:

$ java -jar scalardb-cluster-sql-cli-3.10.3-all.jar --config --file schema.sql

Step 5. Load the initial data

Before running the sample application, you need to load the initial data by running the following command:

$ ./gradlew run --args="LoadInitialData"

After the initial data has loaded, the following records should be stored in the tables:

  • For the sample.customers table:
1Yamada Taro100000
2Yamada Hanako100000
3Suzuki Ichiro100000
  • For the sample.items table:

Step 6. Run the sample application

Let's start with getting information about the customer whose ID is 1:

$ ./gradlew run --args="GetCustomerInfo 1"
{"id": 1, "name": "Yamada Taro", "credit_limit": 10000, "credit_total": 0}

Then, place an order for three apples and two oranges by using customer ID 1. Note that the order format is <Item ID>:<Count>,<Item ID>:<Count>,...:

$ ./gradlew run --args="PlaceOrder 1 1:3,2:2"
{"order_id": "454f9c97-f456-44fd-96da-f527187fe39b"}

You can see that running this command shows the order ID.

Let's check the details of the order by using the order ID:

$ ./gradlew run --args="GetOrder 454f9c97-f456-44fd-96da-f527187fe39b"
{"order": {"order_id": "454f9c97-f456-44fd-96da-f527187fe39b","timestamp": 1685602722821,"customer_id": 1,"customer_name": "Yamada Taro","statement": [{"item_id": 1, "name": "Apple", "price": 1000, "count": 3},{"item_id": 2, "name": "Orange", "price": 2000, "count": 2}],"total": 7000}}

Then, let's place another order and get the order history of customer ID 1:

$ ./gradlew run --args="PlaceOrder 1 5:1"
{"order_id": "3f40c718-59ec-48aa-a6fe-2fdaf12ad094"}
$ ./gradlew run --args="GetOrders 1"
{"order": [{"order_id": "454f9c97-f456-44fd-96da-f527187fe39b","timestamp": 1685602722821,"customer_id": 1,"customer_name": "Yamada Taro","statement": [{"item_id": 1, "name": "Apple", "price": 1000, "count": 3},{"item_id": 2, "name": "Orange", "price": 2000, "count": 2}],"total": 7000},{"order_id": "3f40c718-59ec-48aa-a6fe-2fdaf12ad094","timestamp": 1685602811718,"customer_id": 1,"customer_name": "Yamada Taro","statement": [{"item_id": 5, "name": "Melon", "price": 3000, "count": 1}],"total": 3000}]}

This order history is shown in descending order by timestamp.

The customer's current credit_total is 10000. Since the customer has now reached their credit_limit, which was shown when retrieving their information, they cannot place anymore orders.

$ ./gradlew run --args="GetCustomerInfo 1"
{"id": 1, "name": "Yamada Taro", "credit_limit": 10000, "credit_total": 10000}
$ ./gradlew run --args="PlaceOrder 1 3:1,4:1"
java.lang.RuntimeException: Credit limit exceeded
at sample.Sample.placeOrder(
at picocli.CommandLine.executeUserObject(
at picocli.CommandLine.access$1500(
at picocli.CommandLine$RunLast.executeUserObjectOfLastSubcommandWithSameParent(
at picocli.CommandLine$RunLast.handle(
at picocli.CommandLine$RunLast.handle(
at picocli.CommandLine$AbstractParseResultHandler.execute(
at picocli.CommandLine$RunLast.execute(
at picocli.CommandLine.execute(
at sample.command.SampleCommand.main(

After making a payment, the customer will be able to place orders again.

$ ./gradlew run --args="Repayment 1 8000"
$ ./gradlew run --args="GetCustomerInfo 1"
{"id": 1, "name": "Yamada Taro", "credit_limit": 10000, "credit_total": 2000}
$ ./gradlew run --args="PlaceOrder 1 3:1,4:1"
{"order_id": "fb71279d-88ea-4974-a102-0ec4e7d65e25"}

Source code of the sample application

To learn more about ScalarDB Cluster SQL JDBC, you can check the source code of the sample application.

Next steps

If you have not tried the other ScalarDB Cluster tutorials, we encourage you to read the following:

For details about developing applications that use ScalarDB Cluster with the Java API, refer to the following:

For details about the ScalarDB Cluster gRPC API, refer to the following: