docs: index-population-mode & include-index-data (#45064)

Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Ilnaz Nizametdinov <[email protected]>

5 files changed, 15 insertions, 0 deletions

diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-additional-params.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-additional-params.md
index 5360fa91617..6f0ee4f28ba 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-additional-params.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/export-additional-params.md
@@ -4,6 +4,7 @@
 
     - `zstd` — сжатие алгоритмом Zstandard c уровнем сжатия по умолчанию (`3`);
     - `zstd-N` — сжатие алгоритмом Zstandard, `N` — уровень сжатия (`1` — `22`).
+- `--include-index-data BOOL`: Выгружать данные индексных таблиц. По умолчанию выгружаются только метаданные индексов, а сами индексы строятся при импорте — это экономит место и сокращает время выгрузки, но может увеличить время импорта. При включении данной опции данные индексных таблиц выгружаются в полном объёме, что позволяет при импорте загрузить их вместо построения. Значение по умолчанию: `false`.
 - `--encryption-algorithm ALGORITHM`: Шифровать выгружаемые данные используя указанный алгоритм. Поддерживаемые значения: `AES-128-GCM`, `AES-256-GCM`, `ChaCha20-Poly1305`.
 - `--encryption-key-file PATH`: Путь к файлу, содержащему ключ шифрования (только для зашифрованных выгрузок). Данный файл является бинарным и должен содержать точное количество байт, соответствующее длине ключа в выбранном алгоритме шифрования (16 байт для `AES-128-GCM`, 32 байта для `AES-256-GCM` и `ChaCha20-Poly1305`). Ключ также может быть передан через переменную окружения `YDB_ENCRYPTION_KEY`, в шестнадцатеричном строковом представлении.
 - `--format STRING`: Формат вывода результата. Допустимые значения:
diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-additional-params.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-additional-params.md
index 2dba29a0984..8c41fec7332 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-additional-params.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-additional-params.md
@@ -1,6 +1,11 @@
 - `--description STRING`: Текстовое описание операции, сохраняемое в истории операций.
 - `--retries NUM`: Количество повторных попыток загрузки, которые будет предпринимать сервер. Значение по умолчанию: `10`.
 - `--skip-checksum-validation`: Пропустить этап валидации [контрольных сумм](../file-structure.md#checksums) загружаемых объектов.
+- `--index-population-mode STRING`: Режим наполнения индексов при импорте. Допустимые значения:
+
+    - `build` — построить индексы с нуля (значение по умолчанию);
+    - `import` — загрузить данные индексных таблиц (если выгрузка была выполнена с опцией `--include-index-data`);
+    - `auto` — попытаться загрузить данные индексных таблиц, при отсутствии данных построить индексы.
 - `--encryption-key-file PATH`: Путь к файлу, содержащему ключ шифрования (только для зашифрованных выгрузок). Данный файл является бинарным и должен содержать точное количество байт, соответствующее длине ключа в выбранном алгоритме шифрования (16 байт для `AES-128-GCM`, 32 байта для `AES-256-GCM` и `ChaCha20-Poly1305`). Ключ также может быть передан через переменную окружения `YDB_ENCRYPTION_KEY`, в шестнадцатеричном строковом представлении.
 - `--format STRING`: Формат вывода результата. Допустимые значения:
 
diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-resource-broker-note.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-resource-broker-note.md
new file mode 100644
index 00000000000..c27995ef58f
--- /dev/null
+++ b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-resource-broker-note.md
@@ -0,0 +1,5 @@
+{% note info %}
+
+Использование режима `--index-population-mode=import` позволяет максимально задействовать ресурсы и быстро восстановить индексы, либо наоборот — ограничить ресурсы и скопировать индексные таблицы с минимальным влиянием на пользовательскую нагрузку. Для ограничения ресурсов импорта используется [очередь `queue_restore`](../../../configuration/resource_broker_config.md) брокера ресурсов.
+
+{% endnote %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md
index 4dfdd36be1a..c8916cd8120 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-s3.md
@@ -48,6 +48,8 @@
 {% include [import-additional-params.md](import-additional-params.md) %}
 - `--list`: Перечислить объекты в существующей выгрузке.
 
+{% include [import-resource-broker-note.md](import-resource-broker-note.md) %}
+
 ## Выполнение загрузки {#exec}
 
 {% include [server-import-workflow.md](server-import-workflow.md) %}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/import-nfs.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/import-nfs.md
index 373f7b6fdd5..249f9d05576 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/export-import/import-nfs.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/export-import/import-nfs.md
@@ -41,6 +41,8 @@
 
 {% include [import-additional-params.md](_includes/import-additional-params.md) %}
 
+{% include [import-resource-broker-note.md](_includes/import-resource-broker-note.md) %}
+
 ## Выполнение загрузки {#exec}
 
 {% include [server-import-workflow.md](_includes/server-import-workflow.md) %}