From d11bdaa6a0dedfacd56da3e8c4de11ee54bf5234 Mon Sep 17 00:00:00 2001 From: orange13 Date: Sat, 15 Nov 2025 17:44:44 +0300 Subject: [PATCH 1/5] initial --- .../reference/ydb-cli/topic-consumer-add.md | 27 +++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) 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..78d2fe03d4f0 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` | Указывает, является ли читатель важным.
Значение по умолчанию — `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,24 @@ 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 +``` + +**Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с поддержкой кодека `ZSTD`:** + +```bash +{{ ydb-cli }} -p quickstart topic consumer add \ + --consumer critical-consumer \ + --important \ + --supported-codecs raw,zstd \ + my-topic +``` + +Обратите внимание, что для важного читателя параметр `--availability-period` не применяется, даже если он указан. From 52dd68798b1ca5ad7fc0ee3a4c50221a0dce75ee Mon Sep 17 00:00:00 2001 From: orange13 Date: Mon, 17 Nov 2025 12:21:18 +0300 Subject: [PATCH 2/5] Update ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md Co-authored-by: ubyte --- ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 78d2fe03d4f0..8135dbf8d9b4 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 @@ -77,7 +77,7 @@ Consumers: {{ ydb-cli }} -p quickstart topic consumer add \ --consumer critical-consumer \ --important \ - --supported-codecs raw,zstd \ + --supported-codecs raw,gzip,zstd \ my-topic ``` From c0721c79af7b4b52398791091f74b4d607b658b3 Mon Sep 17 00:00:00 2001 From: orange13 Date: Mon, 17 Nov 2025 12:21:33 +0300 Subject: [PATCH 3/5] Update ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md Co-authored-by: ubyte --- ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 8135dbf8d9b4..6770a69dea11 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 @@ -71,7 +71,7 @@ Consumers: my-topic ``` -**Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с поддержкой кодека `ZSTD`:** +**Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с дополнительной поддержкой кодека `ZSTD`:** ```bash {{ ydb-cli }} -p quickstart topic consumer add \ From 3b9f832a95a1e57b17186b5f53b8822f711da05f Mon Sep 17 00:00:00 2001 From: Aleksei Moiseitsev Date: Tue, 18 Nov 2025 11:09:10 +0000 Subject: [PATCH 4/5] update --- ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) 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 6770a69dea11..11667a232451 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 @@ -26,7 +26,7 @@ `--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`.
Возможные значения:
  • `RAW` — без сжатия;
  • `ZSTD` — сжатие [zstd](https://ru.wikipedia.org/wiki/Zstandard);
  • `GZIP` — сжатие [gzip](https://ru.wikipedia.org/wiki/Gzip);
  • `LZOP` — сжатие [lzop](https://ru.wikipedia.org/wiki/Lzop).
`--important` | Указывает, является ли читатель важным.
Значение по умолчанию — `false`.
Для важных читателей:
  • не применяется ограничение по периоду доступности (`--availability-period`);
  • данные в топике не удаляются, пока они не прочитаны всеми важными читателями;
  • это влияет на процесс очистки данных в топике.
Используйте этот параметр для критически важных читателей, которые должны гарантированно прочитать все сообщения. -`--availability-period VAL` | Период, в течение которого сохраняются незакоммиченные данные в топике.
Формат: положительное число с указанием единицы измерения времени (без пробелов).
Поддерживаются следующие единицы измерения:
  • `s` — секунды (например, `30s`, `120s`);
  • `m` — минуты (например, `5m`, `1440m`);
  • `h` — часы (например, `1h`, `72h`);
  • `d` — дни (например, `1d`, `7d`).
Примеры: `72h`, `1440m`, `2d`, `3600s`.
Для важных читателей (с параметром `--important`) этот параметр не применяется. +`--availability-period VAL` | Время хранения данных в топике, для которых читатель ещё не потдвердил их обработку.
Непрочитанные данные, возраст которых меньше указанного значения, не удаляются из топика.
Формат: положительное число с указанием единицы измерения времени (без пробелов).
Поддерживаются следующие единицы измерения:
  • `s` — секунды (например, `30s`, `120s`);
  • `m` — минуты (например, `5m`, `1440m`);
  • `h` — часы (например, `1h`, `72h`);
  • `d` — дни (например, `1d`, `7d`).
Примеры: `72h`, `1440m`, `2d`, `3600s`.
Для важных читателей (с параметром `--important`) этот параметр не применяется. ## Примеры {#examples} @@ -62,7 +62,7 @@ Consumers: └──────────────┴─────────────────┴───────────────────────────────┴───────────┘ ``` -**Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности незакоммиченных данных 3 дня:** +**Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности данных 3 дня:** ```bash {{ ydb-cli }} -p quickstart topic consumer add \ @@ -71,6 +71,9 @@ Consumers: my-topic ``` +В случае, если читатель успевает обрабатывать и подтверждать чтение, то данные в топике будут храниться в течение 2-х часов, в соответствии со значением параметра `retention-period` топика. +Однако при временной остановке чтения, время хранения данных в топике, для которых читатель `backup-consumer` ещё не подтвердил обработку, будет увеличено вплоть до 3-х дней, в соответствии с параметром `availability-period`. + **Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с дополнительной поддержкой кодека `ZSTD`:** ```bash From c8ddeadb0522615dd365bcf138eb293922172c48 Mon Sep 17 00:00:00 2001 From: orange13 Date: Wed, 19 Nov 2025 13:03:42 +0300 Subject: [PATCH 5/5] Update topic-consumer-add.md --- ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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 11667a232451..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 @@ -25,14 +25,14 @@ `--consumer VAL` | Имя читателя, которого нужно добавить. `--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`.
Возможные значения:
  • `RAW` — без сжатия;
  • `ZSTD` — сжатие [zstd](https://ru.wikipedia.org/wiki/Zstandard);
  • `GZIP` — сжатие [gzip](https://ru.wikipedia.org/wiki/Gzip);
  • `LZOP` — сжатие [lzop](https://ru.wikipedia.org/wiki/Lzop).
-`--important` | Указывает, является ли читатель важным.
Значение по умолчанию — `false`.
Для важных читателей:
  • не применяется ограничение по периоду доступности (`--availability-period`);
  • данные в топике не удаляются, пока они не прочитаны всеми важными читателями;
  • это влияет на процесс очистки данных в топике.
Используйте этот параметр для критически важных читателей, которые должны гарантированно прочитать все сообщения. +`--important` | Указывает, является ли читатель [важным.](../../concepts/datamodel/topic.md#important-consumer)
Значение по умолчанию — `false`.
Для важных читателей:
  • не применяется ограничение по периоду доступности (`--availability-period`);
  • данные в топике не удаляются, пока они не прочитаны всеми важными читателями;
  • это влияет на процесс очистки данных в топике.
Используйте этот параметр для критически важных читателей, которые должны гарантированно прочитать все сообщения. `--availability-period VAL` | Время хранения данных в топике, для которых читатель ещё не потдвердил их обработку.
Непрочитанные данные, возраст которых меньше указанного значения, не удаляются из топика.
Формат: положительное число с указанием единицы измерения времени (без пробелов).
Поддерживаются следующие единицы измерения:
  • `s` — секунды (например, `30s`, `120s`);
  • `m` — минуты (например, `5m`, `1440m`);
  • `h` — часы (например, `1h`, `72h`);
  • `d` — дни (например, `1d`, `7d`).
Примеры: `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 \ @@ -62,7 +62,7 @@ Consumers: └──────────────┴─────────────────┴───────────────────────────────┴───────────┘ ``` -**Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности данных 3 дня:** +#### Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности данных 3 дня ```bash {{ ydb-cli }} -p quickstart topic consumer add \ @@ -74,7 +74,7 @@ Consumers: В случае, если читатель успевает обрабатывать и подтверждать чтение, то данные в топике будут храниться в течение 2-х часов, в соответствии со значением параметра `retention-period` топика. Однако при временной остановке чтения, время хранения данных в топике, для которых читатель `backup-consumer` ещё не подтвердил обработку, будет увеличено вплоть до 3-х дней, в соответствии с параметром `availability-period`. -**Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с дополнительной поддержкой кодека `ZSTD`:** +#### Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с дополнительной поддержкой кодека `ZSTD` ```bash {{ ydb-cli }} -p quickstart topic consumer add \