Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for backup checksums #13666

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}

Checksums of exported files are only available for export to S3-compatible object storage for now.

{% endnote %}

For each export file there is a paired file with the extension `.sha256`, which stores its checksum.
pixcc marked this conversation as resolved.
Show resolved Hide resolved

File checksum can be validated using the `sha256sum` console utility:
pixcc marked this conversation as resolved.
Show resolved Hide resolved
pixcc marked this conversation as resolved.
Show resolved Hide resolved

```sh
$ sha256sum -c scheme.pb.sha256
scheme.pb: OK
```

## Examples {#example}

### Tables {#example-table}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ To run the command to import data from an S3 storage, specify the [S3 connection

`--description STRING`: A text description of the operation saved in the operation history
pixcc marked this conversation as resolved.
Show resolved Hide resolved
`--retries NUM`: The number of import retries to be made by the server. The default value is 10.
`--skip-checksum-validation`: Skip the step of validating imported objects checksums
pixcc marked this conversation as resolved.
Show resolved Hide resolved
pixcc marked this conversation as resolved.
Show resolved Hide resolved
`--format STRING`: The format of the results.

- `pretty`: Human-readable format (default).
Expand Down
pixcc marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,23 @@
1,"%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82"
```

## Чексуммы {#checksums}

{% note info %}

Чексуммы файлов выгрузки пока что доступны только для выгрузки в S3-совместимое объектное хранилище.
pixcc marked this conversation as resolved.
Show resolved Hide resolved

{% endnote %}

Для каждого файла выгрузки есть парный файл с расширением `.sha256`, в котором хранится его чексумма.

Чексуммы файлов можно провалидировать с помощью консольной утилиты `sha256sum`:
pixcc marked this conversation as resolved.
Show resolved Hide resolved

```sh
$ sha256sum -c scheme.pb.sha256
scheme.pb: OK
```

## Примеры {#example}

### Таблицы {#example-table}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@

`--description STRING`: Текстовое описание операции, сохраняемое в истории операций
pixcc marked this conversation as resolved.
Show resolved Hide resolved
`--retries NUM`: Количество повторных попыток загрузки, которые будет предпринимать сервер. По умолчанию 10.
`--skip-checksum-validation`: Пропустить этап валидации чексумм загружаемых объектов
pixcc marked this conversation as resolved.
Show resolved Hide resolved
`--format STRING`: Формат вывода результата

- `pretty`: Человекочитаемый формат (по умолчанию)
Expand Down
Loading