Command line tools

Tools for interacting with, configuring, and managing YugabuyteDB

This page documents the preview version (v2.23). Preview includes features under active development and is for development and testing only. For production, use the stable version (v2024.1). To learn more, see Versioning.

YugabyteDB ships with a variety of tools to interact with, manage, and configure your cluster. Each tool has been designed for a specific purpose. The following illustration shows which tools operate on which parts of the cluster.

Tools and their purpose

Note

For information about yugabyted and configuring YB-Master and YB-TServer services, refer to Configuration.

Specifying values that have a hypen

For all the command line tools, when passing in an argument with a value that starts with a hyphen (for example, -1), add a double hyphen (--) at the end of other arguments followed by the argument name and value. This tells the binary to treat those arguments as positional. For example, to specify set_flag ysql_select_parallelism -1, you need to do the following:

yb-ts-cli [other arguments] -- set_flag ysql_select_parallelism -1

Tools

ysqlsh

Interact with YugabyteDB, including querying data, creating and modifying database objects, and executing SQL commands and scripts using YSQL.

ycqlsh

Interact with YugabyteDB, including querying data, creating and modifying database objects, and executing CQL commands and scripts using YCQL.

yb-admin

Administer YugabyteDB cluster configuration and features.

yb-ctl

Create and manage local clusters on macOS or Linux.

ysql_dump

Extract a single YugabyteDB database into an SQL script file.

ysql_dumpall

Extract all YugabyteDB databases into an SQL script file.

yb-ts-cli

Perform advanced operations on tablet servers.