ydb cli docs - scheme mkdir/rmdir

ydb cli docs - scheme mkdir/rmdir

ref:50d740414b7cc71cafcf418055052d4ef6aeab91

14 files changed, 90 insertions, 25 deletions

diff --git a/ydb/docs/ru/core/concepts/_includes/datamodel/folder.md b/ydb/docs/ru/core/concepts/_includes/datamodel/dir.md
index 123a1a54add..1ff3ad54f3a 100644
--- a/ydb/docs/ru/core/concepts/_includes/datamodel/folder.md
+++ b/ydb/docs/ru/core/concepts/_includes/datamodel/dir.md
@@ -1,2 +1,2 @@
-## Директории
+## Директории {#dir}
 Для удобства организации поддерживается создание директорий по аналогии с файловой системой, то есть вся база состоит из дерева директорий, а таблицы и другие сущности находятся в листах этого дерева (аналогично файлам файловой системы). В одной директории могут быть несколько поддиректорий и несколько таблиц. Имена у сущностей внутри одной директории уникальны.
diff --git a/ydb/docs/ru/core/concepts/datamodel.md b/ydb/docs/ru/core/concepts/datamodel.md
index 934fb314961..36d7fde82c7 100644
--- a/ydb/docs/ru/core/concepts/datamodel.md
+++ b/ydb/docs/ru/core/concepts/datamodel.md
@@ -2,7 +2,7 @@
 
 {% include [Table](_includes/datamodel/table.md) %}
 
-{% include [Folder](_includes/datamodel/folder.md) %}
+{% include [Folder](_includes/datamodel/dir.md) %}
 
 {% include [Persistent Queue](_includes/datamodel/pq.md) %}
 
diff --git a/ydb/docs/ru/core/reference/ydb-cli/_includes/index.md b/ydb/docs/ru/core/reference/ydb-cli/_includes/index.md
index cce01229012..cc47c57fd43 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/_includes/index.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/_includes/index.md
@@ -10,11 +10,11 @@
 
 Полное описание команд {{ ydb-short-name }} CLI опубликовано в других статьях раздела, включая:
 
-* [Листинг объектов](../commands/scheme-ls.md).
+* [Список объектов](../commands/scheme-ls.md).
 * [Получение информации об объекте схемы](../commands/scheme-describe.md).
-* [Получение списка эндпоинтов для базы данных](../commands/discovery-list.md).
+* [Работа с директориями](../commands/dir.md).
 * [Выполнение запроса к данным](../commands/query.md).
 * [Потоковое чтение таблицы](../commands/readtable.md).
 * [Работа со вторичными индексами](../commands/operations-index.md).
-* [Работа с директориями](../commands/scheme-mkdir.md).
-* [Работа с профилями](../profile/index.md).
+* [Получение списка эндпоинтов для базы данных](../commands/discovery-list.md).
+* [Нагрузочное тестирование](../commands/workload/index.md).
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/conn_options_ref.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/conn_options_ref.md
new file mode 100644
index 00000000000..41705cee0e3
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/conn_options_ref.md
@@ -0,0 +1 @@
+, где [connection options] - опции [соединения с БД](../../connect.md#command-line-pars)
\ No newline at end of file
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
new file mode 100644
index 00000000000..e9c185a650d
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/dir.md
@@ -0,0 +1,75 @@
+# Директории
+
+База данных YDB поддерживает внутри иерархическую структуру [директорий](../../../../concepts/datamodel.md#dir), в которых могут размещаться объекты БД.
+
+YDB CLI поддерживает операции изменения структуры директорий, а также указание директории при обращении к объектам схемы.
+
+## Создание директории {#mkdir}
+
+Команда `scheme mkdir` создает директории:
+
+``` bash
+{{ ydb-cli }} [connection options] scheme mkdir <path>
+```
+
+{% include [conn_options_ref.md](conn_options_ref.md) %}
+
+В параметре `path` указывается относительный путь создаваемой директории от корня директорий базы данных. Будут созданы все директории на этом пути, которые не существовали до момента вызова команды.
+
+Также поддерживается синтаксис указания полного пути, начинающегося с символа `/`, который должен в этом случае содержать в начале [размещение базы данных](../../../../concepts/connect.md#database), указанной в параметрах соединения, или с которой разрешаются операции через установленное соединение с кластером.
+
+Примеры:
+
+- Создание директории в корне базы данных
+
+  ``` bash
+  {{ ydb-cli }} --profile db1 scheme mkdir dir1
+  ```
+
+- Создание директорий на указанном пути от корня базы данных
+
+  ``` bash
+  {{ ydb-cli }} --profile db1 scheme mkdir dir1/dir2/dir3
+  ```
+
+## Удаление директории {#rmdir}
+
+Команда `scheme rmdir` удаляет директорию:
+
+``` bash
+{{ ydb-cli }} [connection options] scheme rmdir <path>
+```
+
+{% include [conn_options_ref.md](conn_options_ref.md) %}
+
+В параметре `path` указывается путь до директории, которая должна быть удалена. Эта директория не должна содержать объектов (включая таблицы и поддиректории), иначе команда не будет выполнена с выдачей ошибки:
+
+``` text
+Status: SCHEME_ERROR
+Issues: 
+<main>: Error: path table fail checks, path: /<database>/<path>: path has children, request 
+doesn't accept it, pathId: [OwnerId: <some>, LocalPathId: <some>], path type: 
+EPathTypeDir, path state: EPathStateNoChanges, alive children: <count>
+```
+
+## Использование директорий в других командах CLI {#use}
+
+Во всех командах CLI, в которые передается параметром имя объекта, оно может быть указано с директорией, например в [`scheme describe`](../scheme-describe.md):
+
+``` bash
+{{ ydb-cli }} --profile db1 scheme describe dir1/table_a
+```
+
+Команда [`scheme ls`](../scheme-ls.md) поддерживает передачу пути к директории в качестве параметра:
+
+``` bash
+{{ ydb-cli }} --profile db1 scheme ls dir1/dir2
+```
+
+## Использование директорий в YQL {#yql}
+
+Имена объектов в запросах на [языке YQL](../../../../yql/reference/index.md) могут содержать путь к директории, где находится этот объект. Этот путь будет конкатенирован с базовым путем, задаваемым [прагмой `TablePathPrefix`](../../../../yql/reference/syntax/pragma.md#table-path-prefix). Если прагма не указана, имя объекта разрешается относительно корня базы данных.
+
+## Неявное создание директорий при импорте {#import}
+
+При выполнении команды импорта данных создается дерево директорий по образцу каталога, из которого выполняется импорт.
\ No newline at end of file
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md
index 4350b0cf812..adc811f6a8a 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-list.md
@@ -6,7 +6,7 @@
 {{ ydb-cli }} [connection options] discovery list
 ```
 
-, где [connection options] - опции [соединения с БД](../../connect.md#command-line-pars)
+{% include [conn_options_ref.md](conn_options_ref.md) %}
 
 В выводимых в ответ строках содержится следующая информация:
 1. Эндпоинт, включая протокол и порт
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md
index f75938b1889..d8ea4e3b623 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/discovery-whoami.md
@@ -6,7 +6,7 @@
 {{ ydb-cli }} [connection options] discovery whoami [-g]
 ```
 
-, где [connection options] - опции [соединения с БД](../../connect.md#command-line-pars)
+{% include [conn_options_ref.md](conn_options_ref.md) %}
 
 В ответ выводится имя учетной записи (User SID) и, если указана опция `-g`, то информация о принадлежности учетной записи группам.
 
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/index.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/index.md
deleted file mode 100644
index 25e7da27211..00000000000
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/index.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Обзор
-
-В разделе приведены описания команд {{ ydb-short-name }} CLI, а также примеры их использования для выполнения следующих операций в БД:
-
-* [Листинг объектов](../../commands/scheme-ls.md).
-* [Получение информации об объекте схемы](../../commands/scheme-describe.md).
-* [Получение списка эндпоинтов для базы данных](../../commands/discovery-list.md).
-* [Выполнение запроса к данным](../../commands/query.md).
-* [Потоковое чтение таблицы](../../commands/readtable.md).
-* [Работа со вторичными индексами](../../commands/operations-index.md).
-* [Работа с директориями](../../commands/scheme-mkdir.md).
-* [Нагрузочное тестирование](../../commands/workload.md).
\ No newline at end of file
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls/intro.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls.md
index 332e7df0c87..332e7df0c87 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls/intro.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/scheme-ls.md
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/tools/rename.md b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/tools/rename.md
index 4e92c2131f8..a0d9ec547d6 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/tools/rename.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/_includes/tools/rename.md
@@ -23,7 +23,7 @@
 
 Имя параметра | Описание параметра
 ---|---
-`--item <свойство>=<значение>,...` | Описание операции переменования. Может быть указан несколько раз, если необходимо выполнить несколько операций переименования в одной транзакции.</br></br>Обязательные свойства:</br><ul><li>`source`, `src`, `s` — путь до таблицы источника.</li><li>`destination`, `dst`, `d` —  путь до таблицы назначения. Если путь назначения содержит директории, они должны быть созданы заранее.</li></ul>Дополнительные свойства:</br><ul> <li>`replace`, `force` — перезаписывать таблицу назначения. Если значение `True`, то таблица назначения будет перезаписана, а существованые в ней данные удалены. `False` — если таблица назначения существует, то будет выдана ошибка, и транзакция переименования будет целиком откачена. Значение по умолчанию: `False`.</li></ul>
+`--item <свойство>=<значение>,...` | Описание операции переменования. Может быть указан несколько раз, если необходимо выполнить несколько операций переименования в одной транзакции.</br></br>Обязательные свойства:</br><ul><li>`source`, `src`, `s` — путь до таблицы источника.</li><li>`destination`, `dst`, `d` —  путь до таблицы назначения. Если путь назначения содержит директории, они должны быть [созданы заранее](../../dir.md#mkdir).</li></ul>Дополнительные свойства:</br><ul> <li>`replace`, `force` — перезаписывать таблицу назначения. Если значение `True`, то таблица назначения будет перезаписана, а существованые в ней данные удалены. `False` — если таблица назначения существует, то будет выдана ошибка, и транзакция переименования будет целиком откачена. Значение по умолчанию: `False`.</li></ul>
 `--timeout <значение>` | Таймаут операции, мс. 
 
 При включении нескольких операций переименования в один вызов `tools rename` они исполняются в заданном порядке, но в рамках одной транзакции, что позволяет ротировать таблицу под нагрузкой без потери данных: первой операцией идет переименование рабочей таблицы в резервную, второй -- переименование новой таблицы в рабочую.
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/dir.md b/ydb/docs/ru/core/reference/ydb-cli/commands/dir.md
new file mode 100644
index 00000000000..adee551a77a
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/dir.md
@@ -0,0 +1 @@
+{% include [dir.md](_includes/dir.md) %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-ls.md b/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-ls.md
index d00a69f08ec..e5cacf169fc 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-ls.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-ls.md
@@ -1 +1 @@
-{% include [intro.md](_includes/scheme-ls/intro.md) %}
+{% include [intro.md](_includes/scheme-ls.md) %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-mkdir.md b/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-mkdir.md
index 0f08eef2772..63c24957488 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-mkdir.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/commands/scheme-mkdir.md
@@ -1 +1 @@
-{% include [intro.md](_includes/scheme-mkdir/intro.md) %}
+Данная страница удалена, контент перемещен в [новое размещение](dir.md).
\ No newline at end of file
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 567232f9839..98d3bda3ac0 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
+++ b/ydb/docs/ru/core/reference/ydb-cli/toc_i.yaml
@@ -15,6 +15,8 @@ items:
       href: commands/scheme-ls.md
     - name: Информация об объекте
       href: commands/scheme-describe.md
+    - name: Директории
+      href: commands/dir.md
     - name: Переименование таблиц
       href: commands/tools/rename.md
   - name: Работа с данными
@@ -25,8 +27,6 @@ items:
       href: commands/readtable.md
     - name: Работа со вторичными индексами
       href: commands/operations-index.md
-    - name: Работа с директориями
-      href: commands/scheme-mkdir.md
     - name: Скан запросы
       href: commands/scan-query.md
 #  - name: Утилиты