Команды YDB CLI

Общий синтаксис вызова команд YDB CLI:

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

, где:

  • ydb - команда запуска YDB CLI из командной строки операционной системы
  • [global options] - глобальные опции, одинаковые для всех команд YDB CLI
  • <command> - команда
  • [<subcomand> ...] - подкоманды, указываемые в случае если выбранная команда содержит подкоманды
  • [command options] - опции команды, специфичные для каждой команды и подкоманд

Команды

Вы можете ознакомиться с нужными командами выбрав тематический раздел в меню слева, или воспользовавшись алфавитным перечнем ниже.

Любая команда может быть вызвана в командной строке с опцией --help для получения справки по ней. Перечень всех поддерживаемых YDB CLI команд может быть получен запуском YDB CLI с опцией --help без указания команды.

Команда / подкоманда Краткое описание
config info Просмотр параметров соединения
config profile activate Активация профиля
config profile create Создание профиля
config profile delete Удаление профиля
config profile get Получение параметров профиля
config profile list Список профилей
config profile set Активация профиля
discovery list Список эндпоинтов
discovery whoami Проверка аутентификации
export s3 Экспорт данных в хранилище S3
import file csv Импорт данных из CSV-файла
import file tsv Импорт данных из TSV-файла
import s3 Импорт данных из хранилища S3
init Инициализация CLI, создание профиля
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 Выполнение YQL-скрипта (команда устарела, используйте ydb sql)
sql Выполнение любого запроса
table attribute add Добавление атрибута для строкой или колоночной таблицы
table attribute drop Удаление атрибута у строковой или колоночной таблицы
table drop Удаление строковой или колоночной таблицы
table index add global-async Добавление асинхронного индекса для строковых таблиц
table index add global-sync Добавление синхронного индекса для строковых таблиц
table index drop Удаление индекса у строковых таблиц
table query execute Исполнение YQL-запроса (команда устарела, используйте ydb sql)
table query explain Получение плана исполнения YQL-запроса (команда устарела, используйте ydb sql --explain)
table read Потоковое чтение строковой таблицы
table ttl set Установка параметров TTL для строковых и колоночных таблиц
table ttl reset Сброс параметров TTL для строковых и колоночных таблиц
tools copy Копирование таблиц
tools dump Выгрузка директории или таблиц в файловую систему
tools pg-convert Конвертация дампа PostgreSQL, полученного утилитой pg_dump, в формат, понятный YDB
tools rename Переименование строковых таблиц
tools restore Восстановление из файловой системы
topic create Создание топика
topic alter Модификация параметров топика и перечня читателей
topic drop Удаление топика
topic consumer add Добавление читателя в топик
topic consumer drop Удаление читателя из топика
topic consumer offset commit Сохранение позиции чтения
topic read Чтение сообщений из топика
topic write Запись сообщений в топик
update Обновление YDB CLI
version Вывод информации о версии YDB CLI
workload Генерация нагрузки
yql Выполнение YQL-скрипта с поддержкой стриминга (команда устарела, используйте ydb sql)
Предыдущая
Соединение с БД и аутентификация
Следующая
Сервисные команды