YDB CLI commands

General syntax for calling YDB CLI commands:

ydb [global options] <command> [<subcommand> ...] [command options]

where:

  • ydb is the command to run the YDB CLI from the OS command line.
  • [global options] are global options that are common for all YDB CLI commands.
  • <command> is the command.
  • [<subcomand> ...] are subcommands specified if the selected command contains subcommands.
  • [command options] are command options specific to each command and subcommands.

Commands

You can learn about the necessary commands by selecting the subject section in the menu on the left or using the alphabetical list below.

Any command can be run from the command line with the --help option to get help on it. You can get a list of all commands supported by the YDB CLI by running the YDB CLI with the --help option, but without any command.

Command / subcommand Brief description
admin cluster bridge failover Emergency switchover when pile is unavailable
admin cluster bridge list List state of each pile in bridge mode
admin cluster bridge rejoin Returning pile to the cluster after maintenance or recovery
admin cluster bridge switchover Planned PRIMARY pile change
admin cluster bridge takedown Taking pile out of the cluster for maintenance
admin cluster config fetch Getting the current dynamic configuration of the cluster
admin cluster config generate Generating a dynamic configuration from a static startup configuration
admin cluster config replace Replacing the cluster dynamic configuration
admin cluster config resolve Computing the final cluster dynamic configuration based on the base configuration and override selectors
admin cluster config version Displaying the cluster configuration version on nodes
admin cluster dump Dumping cluster' metadata to the file system
admin cluster restore Restoring cluster' metadata from the file system
admin database config fetch Getting the current dynamic configuration of the database
admin database config generate Generating a database dynamic configuration from a static startup configuration
admin database config replace Replacing the database dynamic configuration
admin database config resolve Computing the final database dynamic configuration based on the base configuration and override selectors
admin database config version Displaying the database configuration version
admin database dump Dumping database' data and metadata to the file system
admin database restore Restoring database' data and metadata from the file system
admin node config init Initializing node configuration
auth get-token Getting an authentication token from authentication parameters
config info Viewing connection parameters
config profile activate
config profile create
config profile delete
config profile deactivate
config profile get
config profile list
config profile replace
config profile set
config profile update
debug latency
debug ping
discovery list
discovery whoami
export s3
import file csv
import file json
import file parquet
import file tsv
import s3
init
monitoring healthcheck
operation cancel
operation forget
operation get
operation list
scheme describe
scheme ls
scheme mkdir
scheme permissions chown
scheme permissions clear
scheme permissions grant
scheme permissions revoke
scheme permissions set
scheme permissions list
scheme permissions clear-inheritance
scheme permissions set-inheritance
scheme rmdir
scripting yql
sql
table attribute add
table attribute drop
table drop
table index add global-async
table index add global-sync
table index drop
table index rename
table query execute
table query explain
table read
table ttl set
table ttl reset
tools copy
tools dump
tools infer csv
tools pg-convert
tools rename
tools restore
topic create
topic alter
topic drop
topic consumer add
topic consumer describe
topic consumer drop
topic consumer offset commit
topic read
topic write
update
version
workload clickbench init
workload clickbench import files
workload clickbench run
workload clickbench clean
workload kv init
workload kv run upsert
workload kv run insert
workload kv run mixed
workload kv run read-rows
workload kv run select
workload kv clean
workload log init
workload log import generator
workload log run bulk-upsert
workload log run delete
workload log run insert
workload log run upsert
workload log run select
workload log clean
workload mixed init
workload mixed run bulk-upsert
workload mixed run insert
workload mixed run upsert
workload mixed run select
workload mixed clean
workload query init
workload query import
workload query run
workload query clean
workload stock init
workload stock run add-rand-order
workload stock run put-rand-order
workload stock run put-same-order
workload stock run rand-user-hist
workload stock run user-hist
workload stock clean
workload topic init
workload topic run full
workload topic run read
workload topic run write
workload topic clean
workload tpcc init
workload tpcc import
workload tpcc check
workload tpcc run
workload tpcc clean
workload tpcds init
workload tpcds import generator
workload tpcds run
workload tpcds clean
workload tpch init
workload tpch import generator
workload tpch run
workload tpch clean
workload transfer topic-to-table init
workload transfer topic-to-table run
workload transfer topic-to-table clean
workload vector init
workload vector run select
workload vector run upsert
workload vector clean
workload fulltext init
workload fulltext import files
workload fulltext import generator
workload fulltext run select
workload fulltext run upsert
workload fulltext clean
workload fulltext model
yql