Added ydb operation docs

updated

6 files changed, 166 insertions, 4 deletions

diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
index 871fcf858ef..4fcc6146dd8 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/commands.md
@@ -35,10 +35,10 @@
 [import file tsv](../export_import/import-file.md) | Импорт данных из TSV-файла
 [import s3](../export_import/s3_import.md) | Импорт данных из хранилища S3
 [init](../profile/create.md) | Инициализация CLI, создание [профиля](../profile/index.md)
-operation cancel | Прерывание исполнения фоновой операции
-operation forget | Удаление фоновой операции из истории
-operation get | Статус фоновой операции
-operation list | Список фоновых операций
+[operation cancel](../operation-cancel.md) | Прерывание исполнения фоновой операции
+[operation forget](../operation-forget.md) | Удаление фоновой операции из списка
+[operation get](../operation-get.md) | Статус фоновой операции
+[operation list](../operation-list.md) | Список фоновых операций
 [scheme describe](../commands/scheme-describe.md) | Описание объекта схемы данных
 [scheme ls](../commands/scheme-ls.md) | Список объектов схемы данных
 [scheme mkdir](../commands/dir.md#mkdir) | Создание директории
diff --git a/ydb/docs/ru/core/reference/ydb-cli/operation-cancel.md b/ydb/docs/ru/core/reference/ydb-cli/operation-cancel.md
new file mode 100644
index 00000000000..9f1aed3bd30
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/operation-cancel.md
@@ -0,0 +1,23 @@
+# Отмена фоновой операции
+
+С помощью подкоманды `ydb operation cancel` вы можете инициировать отмену указанной фоновой операции. Можно отменить только незавершенную операцию.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] operation cancel <id>
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+* `id` — идентификатор фоновой операции. Идентификатор содержит символы, которые могут быть интерпретированы вашей командной оболочкой. При необходимости используйте экранирование, например `'<id>'` для bash.
+
+Посмотрите описание команды получения статуса фоновой операции:
+
+```bash
+{{ ydb-cli }} operation cancel --help
+```
+
+## Примеры {examples}
+
+{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/operation-forget.md b/ydb/docs/ru/core/reference/ydb-cli/operation-forget.md
new file mode 100644
index 00000000000..0aa30641666
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/operation-forget.md
@@ -0,0 +1,30 @@
+# Удаление фоновой операции из списка
+
+С помощью подкоманды `ydb operation forget` вы можете удалить информацию об указанной фоновой операции из списка. Операция должна быть завершена.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] operation forget <id>
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+* `id` — идентификатор фоновой операции. Идентификатор содержит символы, которые могут быть интерпретированы вашей командной оболочкой. При необходимости используйте экранирование, например `'<id>'` для bash.
+
+Посмотрите описание команды удаления информации об указанной фоновой операции:
+
+```bash
+{{ ydb-cli }} operation forget --help
+```
+
+## Примеры {examples}
+
+{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
+
+Удалите из списка фоновую операцию с идентификатором `ydb://buildindex/7?id=281489389055514`:
+
+```bash
+ydb -p db1 operation forget \
+  'ydb://buildindex/7?id=281489389055514'
+```
diff --git a/ydb/docs/ru/core/reference/ydb-cli/operation-get.md b/ydb/docs/ru/core/reference/ydb-cli/operation-get.md
new file mode 100644
index 00000000000..053aa2b557d
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/operation-get.md
@@ -0,0 +1,46 @@
+# Получение статуса фоновой операции
+
+С помощью подкоманды `ydb operation get` вы можете получить статус указанной фоновой операции.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] operation get [options...] <id>
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+* `id` — идентификатор фоновой операции. Идентификатор содержит символы, которые могут быть интерпретированы вашей командной оболочкой. При необходимости используйте экранирование, например `'<id>'` для bash.
+
+Посмотрите описание команды получения статуса фоновой операции:
+
+```bash
+{{ ydb-cli }} operation get --help
+```
+
+## Параметры подкоманды {#options}
+
+Имя | Описание
+---|---
+`--format` | Формат вывода.<br>Значение по умолчанию — `pretty`.<br>Возможные значения:<ul><li>`pretty` — человекочитаемый формат;</li><li>`proto-json-base64` — вывод Protobuf в формате [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}, бинарные строки закодированы в [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}.</li></ul>
+
+## Примеры {examples}
+
+{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
+
+Получите статус фоновой операции с идентификатором `ydb://buildindex/7?id=281489389055514`:
+
+```bash
+ydb -p db1 operation get \
+  'ydb://buildindex/7?id=281489389055514'
+```
+
+Результат:
+
+```text
+┌───────────────────────────────────────┬───────┬─────────┬───────┬──────────┬─────────────────────┬─────────────┐
+| id                                    | ready | status  | state | progress | table               | index       |
+├───────────────────────────────────────┼───────┼─────────┼───────┼──────────┼─────────────────────┼─────────────┤
+| ydb://buildindex/7?id=281489389055514 | true  | SUCCESS | Done  | 100.00%  | /my-database/series | idx_release |
+└───────────────────────────────────────┴───────┴─────────┴───────┴──────────┴─────────────────────┴─────────────┘
+```
diff --git a/ydb/docs/ru/core/reference/ydb-cli/operation-list.md b/ydb/docs/ru/core/reference/ydb-cli/operation-list.md
new file mode 100644
index 00000000000..2638e3b40c8
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/operation-list.md
@@ -0,0 +1,53 @@
+# Получение списка фоновых операций
+
+С помощью подкоманды `ydb operation list` вы можете получить список фоновых операций указанного типа.
+
+Общий вид команды:
+
+```bash
+{{ ydb-cli }} [global options...] operation list [options...] <kind>
+```
+
+* `global options` — [глобальные параметры](commands/global-options.md).
+* `options` — [параметры подкоманды](#options).
+* `kind` — тип операции. Возможные значения:
+  * `buildindex` — операции построения индекса;
+  * `export/s3` — операции экспорта;
+  * `import/s3` — операции импорта.
+
+Посмотрите описание команды получения списка фоновых операций:
+
+```bash
+{{ ydb-cli }} operation list --help
+```
+
+## Параметры подкоманды {#options}
+
+Имя | Описание
+---|---
+`-s`, `--page-size` | Количество операций на одной странице. Если список операций содержит больше строк, чем задано в параметре `--page-size`, то вывод будет разделен на несколько страниц. Для получения следующей страницы укажите параметр `--page-token`.
+`-t`, `--page-token` | Токен страницы.
+`--format` | Формат вывода.<br>Значение по умолчанию — `pretty`.<br>Возможные значения:<ul><li>`pretty` — человекочитаемый формат;</li><li>`proto-json-base64` — вывод Protobuf в формате [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}, бинарные строки закодированы в [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}.</li></ul>
+
+## Примеры {examples}
+
+{% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %}
+
+Получите список фоновых операций построение индекса для таблицы `series`:
+
+```bash
+ydb -p db1 operation list \
+  buildindex
+```
+
+Результат:
+
+```text
+┌───────────────────────────────────────┬───────┬─────────┬───────┬──────────┬─────────────────────┬─────────────┐
+| id                                    | ready | status  | state | progress | table               | index       |
+├───────────────────────────────────────┼───────┼─────────┼───────┼──────────┼─────────────────────┼─────────────┤
+| ydb://buildindex/7?id=281489389055514 | true  | SUCCESS | Done  | 100.00%  | /my-database/series | idx_release |
+└───────────────────────────────────────┴───────┴─────────┴───────┴──────────┴─────────────────────┴─────────────┘
+
+Next page token: 0
+```
diff --git a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
index d93adccd044..469f0be2573 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -69,6 +69,16 @@ items:
     #   href: commands/tools/dump.md
     # - name: Восстановление бэкапа
     #   href: commands/tools/restore.md
+  - name: Управление фоновыми операциями
+    items:
+    - name: Получение списка фоновых операций
+      href: operation-list.md
+    - name: Получение статуса фоновой операции
+      href: operation-get.md
+    - name: Отмена фоновой операции
+      href: operation-cancel.md
+    - name: Удаление фоновой операции из списка
+      href: operation-forget.md
   - name: Управление профилями
     include: { mode: link, path: profile/toc_p.yaml }
   - name: Информационные сервисы