YDB CLI commands

General syntax for calling YDB CLI commands:

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

Structure of YDB CLI commands - 图1

, 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 supported YDB CLI of commands by running the YDB CLI with the --help option with no command specified.

Command / subcommandBrief description
config profile activateActivating a profile
config profile createCreating a profile
config profile deleteDeleting a profile
config profile getGetting parameters of a profile
config profile listList of profiles
config profile setActivating a profile
discovery listList of endpoints
discovery whoamiAuthentication
export s3Exporting data to S3 storage
import file csvImporting data from a CSV file
import file tsvImporting data from a TSV file
import s3Importing data from S3 storage
initInitializing the CLI, creating a profile
operation cancelAborting a background operation
operation forgetRemoving a background operation from history
operation getBackground operation status
operation listList of background operations
scheme describeDescription of a data schema object
scheme lsList of data schema objects
scheme mkdirCreating a directory
scheme permissions addGranting permissions
scheme permissions chownChanging the owner of an object
scheme permissions clearClearing permissions
scheme permissions grantGranting permissions
scheme permissions removeRemoving a permission
scheme permissions revokeRevoking a permission
scheme permissions setSetting permissions
scheme rmdirDeleting a directory
scripting yqlExecuting a YQL script
table attribute addAdding a table attribute
table attribute dropDeleting a table attribute
table dropDeleting a table
table index add global-asyncAdding an asynchronous index
table index add global-syncAdding a synchronous index
table index dropDeleting an index
table query executeExecuting a YQL query
table query explainYQL query execution plan
table readtableStreaming table reads
table ttl dropDeleting TTL parameters
table ttl setSetting TTL parameters
tools copyCopying tables
tools dumpDumping a directory or table to the file system
tools renameRenaming tables
tools restoreRestoring data from the file system

update | Updating the YDB CLI
version | Displaying the version of the YDB CLI
workload | Generating YQL load | Running a YQL script (with streaming support)