YugabyteDB Clients

Shells for interacting with, configuring, and managing YugabyteDB

YugabyteDB ships with command line interface (CLI) shells for interacting with each YugabyteDB API.

Client API Description
ysqlsh YSQL SQL shell for interacting with YugabyteDB using PostgreSQL-compatible YSQL API.
ycqlsh YCQL CQL shell for interacting with YugabyteDB using Cassandra-compatible YCQL API.

Installation

The YugabyteDB clients are installed with YugabyteDB and located in the bin directory of the YugabyteDB home directory.

Clients work best with servers of the same or an older major version. The general functionality of running SQL statements and displaying query results should also work with servers of a newer major version, but this cannot be guaranteed in all cases.

If you are running multiple versions of YugabyteDB, use the newest version of the client to connect. You can keep and use the matching version of a client to use with each version of YugabyteDB, but in practice, this shouldn't be necessary.

You can install a standalone version using any of the following methods:

curl -O https://downloads.yugabyte.com/releases/2024.1.3.0/yugabyte-client-2024.1.3.0-b105-darwin-x86_64.tar.gz
tar xvfz yugabyte-client-2024.1.3.0-b105-darwin-x86_64.tar.gz && cd yugabyte-client-2024.1.3.0/

wget https://downloads.yugabyte.com/releases/2024.1.3.0/yugabyte-client-2024.1.3.0-b105-linux-x86_64.tar.gz
tar xvfz yugabyte-client-2024.1.3.0-b105-linux-x86_64.tar.gz
cd yugabyte-client-2024.1.3.0
./bin/post_install.sh

wget https://downloads.yugabyte.com/releases/2024.1.3.0/yugabyte-client-2024.1.3.0-b105-linux-aarch64.tar.gz
tar xvfz yugabyte-client-2024.1.3.0-b105-linux-aarch64.tar.gz
cd yugabyte-client-2024.1.3.0
./bin/post_install.sh

docker pull yugabytedb/yugabyte-client:latest

Release notes

The YugabyteDB clients are released with every version of YugabyteDB. Only versions with client-specific changes are listed.

v2.23.0.0 - September 13, 2024

  • Documents the limitations of retry logic when using -c flag in ysqlsh command. #21804

  • Allows the deletion of the Cassandra role in ycqlsh without it regenerating upon cluster restart, by adding a flag to mark if the role was previously created. #21057

v2024.1.1.0 - July 31, 2024

  • Automated SQL/CQL Shell binary. Along with full binary, added separate downloadable SQL/CQL Shell binary.