Команды 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 без указания команды.

Команда / подкоманда Краткое описание
admin cluster bootstrap Инициализация подготовленного кластера
admin cluster config fetch Получение текущей динамической конфигурации кластера
admin cluster config generate Генерация динамической конфигурации из статической конфигурации запуска
admin cluster config replace Замена динамической конфигурации кластера
admin cluster config resolve Вычисление итоговой динамической конфигурации кластера на основе базовой конфигурации и селекторов переопределения
admin cluster config version Отображение версии конфигурации кластера на узлах
admin cluster dump Выгрузка метаданных кластера в файловую систему
admin cluster restore Восстановление метаданных кластера из файловой системы
admin database config fetch Получение текущей динамической конфигурации базы данных
admin database config generate Генерация динамической конфигурации базы данных из статической конфигурации запуска
admin database config replace Замена динамической конфигурации базы данных
admin database config resolve Вычисление итоговой динамической конфигурации базы данных на основе базовой конфигурации и селекторов переопределения
admin database config version Отображение версии конфигурации базы данных
admin database dump Выгрузка метаданных и данных базы данных в файловую систему
admin database restore Восстановление метаданных и данных базы данных из файловой системы
admin node config init Инициализация конфигурации узла
auth get-token Получение аутентификационного токена из параметров аутентификации
config info Просмотр параметров соединения
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 Проверка доступности YDB
discovery list Список эндпоинтов
discovery whoami Проверка аутентификации
export s3 Экспорт данных в хранилище S3
import file csv Импорт данных из CSV-файла
import file json Импорт данных из JSON-файла
import file parquet Импорт данных из Parquet-файла
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 index rename Переименование вторичного индекса для указанной таблицы
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 describe Описание читателя топика
topic consumer drop Удаление читателя из топика
topic consumer offset commit Сохранение смещения чтения
topic read Чтение сообщений из топика
topic write Запись сообщений в топик
update Обновление YDB CLI
version Вывод информации о версии YDB CLI
workload clickbench init Создание и инициализация таблиц для нагрузки Clickbench
workload clickbench import files Загрузка набора данных Clickbench из файлов
workload clickbench run Выполнение бенчмарка Clickbench
workload clickbench clean Удаление таблиц, созданных на этапе инициализации нагрузки Clickbench
workload kv init Создание и инициализация таблиц для Key-Value нагрузки
workload kv run upsert Вставка случайных кортежей в таблицу при помощи конструкции UPSERT в Key-Value нагрузке
workload kv run insert Вставка случайных кортежей в таблицу при помощи конструкции INSERT в Key-Value нагрузке
workload kv run mixed Одновременная вставка и чтение кортежей с проверкой успешности чтения записанных данных в Key-Value нагрузке
workload kv run read-rows Выполнение ReadRows запросов, возвращающих строки по точному совпадению первичного ключа в Key-Value нагрузке
workload kv run select Выборка данных, возвращающих строки по точному совпадению первичного ключа в Key-Value нагрузке
workload kv clean Удаление таблиц, созданных на этапе инициализации Key-Value нагрузки
workload log init Создание и инициализация таблиц для Log нагрузки
workload log import generator Генератор случайных данных в Log нагрузке
workload log run bulk_upsert Массовая вставка случайных строк в таблицу около текущего времени в Log нагрузке
workload log run delete Удаление случайных строк из таблицы около текущего времени в Log нагрузке
workload log run insert Вставка случайных строк в таблицу около текущего времени в Log нагрузке с помощью команды INSERT
workload log run upsert Вставка случайных строк в таблицу около текущего времени в Log нагрузке с помощью команды UPSERT
workload log run select Выполнение набора аналитических запросов для анализа логов: подсчет записей, агрегация по уровням, сервисам и компонентам, анализ метаданных и временные диапазоны в Log нагрузке
workload log clean Удаление таблиц, созданных на этапе инициализации Log нагрузки
workload mixed init Создание и инициализация таблиц для Mixed нагрузки
workload mixed run bulk_upsert Массовая вставка случайных строк в таблицу около текущего времени с помощью команды BULK_UPSERT в Mixed нагрузке
workload mixed run insert Вставка случайных строк в таблицу около текущего времени с помощью команды INSERT в Mixed нагрузке
workload mixed run upsert Обновление случайных строк в таблице около текущего времени с помощью команды UPSERT в Mixed нагрузке
workload mixed run select Выборка случайных строк из таблицы в Mixed нагрузке
workload mixed clean Удаление таблиц, созданных на этапе инициализации Mixed нагрузки
workload query init Инициализация таблиц и их конфигураций для Query нагрузки
workload query import Заполнение таблиц данными для Query нагрузки
workload query run Запуск нагрузочного тестирования Query нагрузки
workload query clean Удаление таблиц, используемых для Query нагрузки
workload stock init Создание и инициализация таблиц для Stock нагрузки
workload stock run add-rand-order Вставка заказов со случайным ID без их обработки в Stock нагрузке
workload stock run put-rand-order Отправка случайных заказов с обработкой в Stock нагрузке
workload stock run put-same-order Отправка заказов с одинаковыми продуктами в Stock нагрузке
workload stock run rand-user-hist Выборка заказов случайного клиента в Stock нагрузке
workload stock run user-hist Выборка заказов 10000-го клиента в Stock нагрузке
workload stock clean Удаление таблиц, созданных на этапе инициализации Stock нагрузки
workload topic init Создание и инициализация топика для Topic нагрузки
workload topic run full Выполнение полной нагрузки на топик с одновременным чтением и записью сообщений в Topic нагрузке
workload topic run read Выполнение нагрузки на чтение сообщений из топика в Topic нагрузке
workload topic run write Выполнение нагрузки на запись сообщений в топик в Topic нагрузке
workload topic clean Удаление топика, созданного на этапе инициализации Topic нагрузки
workload tpcc init Создание и инициализация таблиц для бенчмарка TPC-C
workload tpcc import Заполнение таблиц начальными данными бенчмарка TPC-C
workload tpcc check Проверка согласованности данных TPC-C
workload tpcc run Запуск бенчмарка TPC-C
workload tpcc clean Удаление таблиц, созданных бенчмарком TPC-C
workload tpcds init Создание и инициализация таблиц для бенчмарка TPC-DS
workload tpcds import generator Генерация набора данных TPC-DS с помощью встроенного генератора
workload tpcds run Выполнение бенчмарка TPC-DS
workload tpcds clean Удаление таблиц, созданных на этапе инициализации TPC-DS
workload tpch init Создание и инициализация таблиц для бенчмарка TPC-H
workload tpch import generator Генерация набора данных TPC-H с помощью встроенного генератора
workload tpch run Выполнение бенчмарка TPC-H
workload tpch clean Удаление таблиц, созданных на этапе инициализации TPC-H
workload transfer topic-to-table init Создание и инициализация топика с консьюмерами и таблиц для нагрузки на передачу данных из топика в таблицу
workload transfer topic-to-table run Запуск нагрузки с чтением сообщений из топика и записью в таблицу в транзакциях
workload transfer topic-to-table clean Удаление топика и таблиц, созданных на этапе инициализации
workload vector init Создание и инициализация таблиц для Vector нагрузки
workload vector run select Получение топ-K векторов в Vector нагрузке
workload vector run upsert Upsert векторных строк в таблицу в Vector нагрузке
workload vector clean Удаление таблиц, созданных на этапе инициализации Vector нагрузки
yql Выполнение YQL-скрипта с поддержкой стриминга (команда устарела, используйте ydb sql)
Предыдущая
Соединение с БД и аутентификация
Следующая
Сервисные команды