Add docs for backup checksums (#13666)

ydb-platform · Feb 2, 2025 · caeddac · caeddac
1 parent 46b9294
commit caeddac
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 3 deletions.
diff --git a/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md b/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/file_structure.md
@@ -26,6 +26,23 @@ The format of data files is `.csv`, where each row corresponds to a record in th
 1,"%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82"
 ```
 
+## Checksums {#checksums}
+
+{% note info %}
+
+File checksums are only generated when exporting to S3-compatible object storage.
+
+{% endnote %}
+
+{{ ydb-short-name }} generates a checksum for each export file and saves it to a corresponding file with the `.sha256` suffix.
+
+The file checksum can be validated using the `sha256sum` console utility:
+
+```sh
+$ sha256sum -c scheme.pb.sha256
+scheme.pb: OK
+```
+
 ## Examples {#example}
 
 ### Tables {#example-table}

diff --git a/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_import.md b/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_import.md
@@ -29,8 +29,9 @@ To run the command to import data from an S3 storage, specify the [S3 connection
 
 ### Additional parameters {#aux}
 
-`--description STRING`: A text description of the operation saved in the operation history
+`--description STRING`: A text description of the operation saved in the operation history.
 `--retries NUM`: The number of import retries to be made by the server. The default value is 10.
+`--skip-checksum-validation`: Skip the validating imported objects' checksums step.
 `--format STRING`: The format of the results.
 
 - `pretty`: Human-readable format (default).

diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/file-structure.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/file-structure.md
@@ -25,6 +25,23 @@
 1,"%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82"
 ```
 
+## Контрольные суммы {#checksums}
+
+{% note info %}
+
+Контрольные суммы файлов создаются только при выгрузке в S3-совместимое объектное хранилище.
+
+{% endnote %}
+
+{{ ydb-short-name }} генерирует контрольную сумму для каждого файла выгрузки и сохраняет ее в соответствующем файле с суффиксом `.sha256`.
+
+Контрольные суммы файлов можно проверить с помощью консольной утилиты `sha256sum`:
+
+```sh
+$ sha256sum -c scheme.pb.sha256
+scheme.pb: OK
+```
+
 ## Примеры {#example}
 
 ### Таблицы {#example-table}

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
@@ -29,9 +29,10 @@
 
 ### Дополнительные параметры {#aux}
 
-`--description STRING`: Текстовое описание операции, сохраняемое в истории операций
+`--description STRING`: Текстовое описание операции, сохраняемое в истории операций.
 `--retries NUM`: Количество повторных попыток загрузки, которые будет предпринимать сервер. По умолчанию 10.
-`--format STRING`: Формат вывода результата
+`--skip-checksum-validation`: Пропустить этап валидации контрольных сумм загружаемых объектов.
+`--format STRING`: Формат вывода результата.
 
 - `pretty`: Человекочитаемый формат (по умолчанию)
 - `proto-json-base64`: Protobuf в формате json, бинарные строки закодированы в base64