diff --git a/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md b/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md index 6fd081dc4ab2..44ae7815a417 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md +++ b/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md @@ -23,14 +23,16 @@ Имя | Описание ---|--- `--consumer VAL` | Имя читателя, которого нужно добавить. -`--starting-message-timestamp VAL` | Время в формате [UNIX timestamp](https://ru.wikipedia.org/wiki/Unix-время). Чтение начнется с первого [сообщения](../../concepts/datamodel/topic.md#message), полученного после указанного времени. Если время не задано, то чтение начнется с самого старого сообщения в топике. +`--starting-message-timestamp VAL` | Время в формате [UNIX timestamp](https://ru.wikipedia.org/wiki/Unix-время) (секунды с 1970.01.01) или в формате ISO-8601 (например, `2020-07-10T15:00:00Z`). Чтение начнется с первого [сообщения](../../concepts/datamodel/topic.md#message), полученного после указанного времени. Если время не задано, то чтение начнется с самого старого сообщения в топике. `--supported-codecs` | Поддерживаемые методы сжатия данных.
Значение по умолчанию — `raw`.
Возможные значения: +`--important` | Указывает, является ли читатель [важным.](../../concepts/datamodel/topic.md#important-consumer)
Значение по умолчанию — `false`.
Для важных читателей:Используйте этот параметр для критически важных читателей, которые должны гарантированно прочитать все сообщения. +`--availability-period VAL` | Время хранения данных в топике, для которых читатель ещё не потдвердил их обработку.
Непрочитанные данные, возраст которых меньше указанного значения, не удаляются из топика.
Формат: положительное число с указанием единицы измерения времени (без пробелов).
Поддерживаются следующие единицы измерения:Примеры: `72h`, `1440m`, `2d`, `3600s`.
Для важных читателей (с параметром `--important`) этот параметр не применяется. ## Примеры {#examples} {% include [ydb-cli-profile](../../_includes/ydb-cli-profile.md) %} -Создайте читателя с именем `my-consumer` для [созданного ранее](topic-create.md) топика `my-topic`, чтение начнется с первого сообщения, полученного после 15 августа 2022 13:00:00 GMT: +#### Создайте читателя с именем `my-consumer` для [созданного ранее](topic-create.md) топика `my-topic`, чтение начнется с первого сообщения, полученного после 15 августа 2022 13:00:00 GMT ```bash {{ ydb-cli }} -p quickstart topic consumer add \ @@ -59,3 +61,27 @@ Consumers: | my-consumer | RAW, GZIP | Mon, 15 Aug 2022 16:00:00 MSK | 0 | └──────────────┴─────────────────┴───────────────────────────────┴───────────┘ ``` + +#### Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности данных 3 дня + +```bash +{{ ydb-cli }} -p quickstart topic consumer add \ + --consumer backup-consumer \ + --availability-period 3d \ + my-topic +``` + +В случае, если читатель успевает обрабатывать и подтверждать чтение, то данные в топике будут храниться в течение 2-х часов, в соответствии со значением параметра `retention-period` топика. +Однако при временной остановке чтения, время хранения данных в топике, для которых читатель `backup-consumer` ещё не подтвердил обработку, будет увеличено вплоть до 3-х дней, в соответствии с параметром `availability-period`. + +#### Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с дополнительной поддержкой кодека `ZSTD` + +```bash +{{ ydb-cli }} -p quickstart topic consumer add \ + --consumer critical-consumer \ + --important \ + --supported-codecs raw,gzip,zstd \ + my-topic +``` + +Обратите внимание, что для важного читателя параметр `--availability-period` не применяется, даже если он указан.