Command line tools

Tools for interacting with, configuring, and managing YugabyteDB

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

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

For information about YugabyteDB API clients (YSQL shell and YCQL shell), refer to Client shells.

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

yb-admin

Administer YugabyteDB cluster configuration and features.

yb-ts-cli

Perform advanced operations on tablet servers.

ysql_dump

Extract a single YugabyteDB database into an SQL script file.

ysql_dumpall

Extract all YugabyteDB databases into an SQL script file.

yb-ctl

Create and manage local clusters on macOS or Linux.