Like other SQL databases, ScalarDB SQL also provides a command-line interface tool where you can issue SQLs interactively in a command-line shell.

This document explains how to install and use the ScalarDB SQL Command Line Interface.


We have Docker images in our repository and executable jars available in releases.

If you are interested in building from source, run the following command:

$ ./gradlew cli:shadowjar

The executable jar (scalardb-sql-cli-<version>-all.jar) is created in cli/build/libs/.


From Docker

You can start the command line interface with docker as follows:

$ docker pull<version>
$ docker run --rm -it -v <your local configuration file>:/<version> --config /

You can use the same configuration of ScalarDB SQL. Please refer to ScalarDB SQL Configurations for more details on the configurations of this tool.

From executable jar

You can also start the command line interface with the following command:

$ java -jar scalardb-sql-cli-<version>-all.jar --config <your local configuration file>


You can see the command line interface usage with the -h option as follows:

$ java -jar scalardb-sql-cli-<version>-all.jar -h
Usage: java -jar scalardb-sql-cli-<version>-all.jar [-hs] -c=PROPERTIES_FILE
       [-e=COMMAND] [-f=FILE] [-l=LOG_FILE] [-o=<outputFormat>]
Starts ScalarDB SQL CLI.
  -c, --config=PROPERTIES_FILE
                          A configuration file in properties format.
  -e, --execute=COMMAND   A command to execute.
  -f, --file=FILE         A script file to execute.
  -h, --help              Display this help message.
  -l, --log=LOG_FILE      A file to write output.
  -o, --output-format=<outputFormat>
                          Format mode for result display. You can specify
  -s, --silent            Reduce the amount of informational messages displayed.