aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorilnaz <ilnaz@ydb.tech>2023-03-24 10:54:26 +0300
committerilnaz <ilnaz@ydb.tech>2023-03-24 10:54:26 +0300
commit1fe76182b67548e4e141d495ba5be3c19940176b (patch)
treebdfaa33bc8e655d33faec0c10a6c25f6d8f010c6
parentbaf4ccf438a3abeb6530ad6d10b1dd3468784c89 (diff)
downloadydb-1fe76182b67548e4e141d495ba5be3c19940176b.tar.gz
Docs: recursive rmdir
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md60
1 files changed, 55 insertions, 5 deletions
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
index f39f375209..54ec6cf1cf 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
@@ -45,13 +45,31 @@ pathId: [OwnerId: <some>, LocalPathId: <some>], path type: EPathTypeDir, path st
Команда `scheme rmdir` удаляет директорию:
-``` bash
-{{ ydb-cli }} [connection options] scheme rmdir <path>
+```bash
+{{ ydb-cli }} [global options...] scheme rmdir [options...] <path>
```
-{% include [conn_options_ref.md](conn_options_ref.md) %}
+* `global options` — [глобальные параметры](../../commands/global-options.md).
+* `options` — [параметры подкоманды](#rmdir-options).
+* `path` — путь до удаляемой директории.
+
+Посмотрите описание команды для удаления директории:
+
+```bash
+{{ ydb-cli }} scheme rmdir --help
+```
+
+### Параметры подкоманды {#rmdir-options}
-В параметре `path` указывается путь до директории, которая должна быть удалена. Эта директория не должна содержать объектов (включая таблицы и поддиректории), иначе команда не будет выполнена с выдачей ошибки:
+Имя | Описание
+---|---
+`-r`, `--recursive` | Рекурсивное удаление директории вместе с дочерними объектами (поддиректориями, таблицами, топиками). При указании этого параметра по умолчанию будет запрошено подтверждение.
+`-f`, `--force` | Не запрашивать никаких подтверждений.
+`-i` | Запрашивать подтверждение на удаление каждого объекта.
+`-I` | Однократно запросить подтверждение.
+`--timeout <значение>` | Таймаут операции, мс.
+
+При попытке удалить непустую директорию без указания параметра `-r` или `--recursive` команда не будет выполнена с выдачей ошибки:
``` text
Status: SCHEME_ERROR
@@ -61,6 +79,38 @@ doesn't accept it, pathId: [OwnerId: <some>, LocalPathId: <some>], path type:
EPathTypeDir, path state: EPathStateNoChanges, alive children: <count>
```
+### Примеры {#rmdir-examples}
+
+- Удаление пустой директории:
+
+ ```bash
+ {{ ydb-cli }} scheme rmdir dir1
+ ```
+
+- Удаление пустой директории с запросом подтверждения:
+
+ ```bash
+ {{ ydb-cli }} scheme rmdir -I dir1
+ ```
+
+- Рекурсивное удаление непустой директории с запросом подтверждения:
+
+ ```bash
+ {{ ydb-cli }} scheme rmdir -r dir1
+ ```
+
+- Рекурсивное удаление непустой директории без запроса подтверждения:
+
+ ```bash
+ {{ ydb-cli }} scheme rmdir -rf dir1
+ ```
+
+- Рекурсивное удаление непустой директории с запросом подтверждения на каждый объект:
+
+ ```bash
+ {{ ydb-cli }} scheme rmdir -ri dir1
+ ```
+
## Использование директорий в других командах CLI {#use}
Во всех командах CLI, в которые передается параметром имя объекта, оно может быть указано с директорией, например в [`scheme describe`](../scheme-describe.md):
@@ -81,4 +131,4 @@ EPathTypeDir, path state: EPathStateNoChanges, alive children: <count>
## Неявное создание директорий при импорте {#import}
-При выполнении команды импорта данных создается дерево директорий по образцу каталога, из которого выполняется импорт. \ No newline at end of file
+При выполнении команды импорта данных создается дерево директорий по образцу каталога, из которого выполняется импорт.