Skip to content

Commit 3b9f832

Browse files
committed
update
1 parent c0721c7 commit 3b9f832

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

ydb/docs/ru/core/reference/ydb-cli/topic-consumer-add.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
`--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), полученного после указанного времени. Если время не задано, то чтение начнется с самого старого сообщения в топике.
2727
`--supported-codecs` | Поддерживаемые методы сжатия данных.<br/>Значение по умолчанию — `raw`.<br/>Возможные значения:<ul><li>`RAW` — без сжатия;</li><li>`ZSTD` — сжатие [zstd](https://ru.wikipedia.org/wiki/Zstandard);</li><li>`GZIP` — сжатие [gzip](https://ru.wikipedia.org/wiki/Gzip);</li><li>`LZOP` — сжатие [lzop](https://ru.wikipedia.org/wiki/Lzop).</li></ul>
2828
`--important` | Указывает, является ли читатель важным.<br/>Значение по умолчанию — `false`.<br/>Для важных читателей:<ul><li>не применяется ограничение по периоду доступности (`--availability-period`);</li><li>данные в топике не удаляются, пока они не прочитаны всеми важными читателями;</li><li>это влияет на процесс очистки данных в топике.</li></ul>Используйте этот параметр для критически важных читателей, которые должны гарантированно прочитать все сообщения.
29-
`--availability-period VAL` | Период, в течение которого сохраняются незакоммиченные данные в топике.<br/>Формат: положительное число с указанием единицы измерения времени (без пробелов).<br/>Поддерживаются следующие единицы измерения:<ul><li>`s` — секунды (например, `30s`, `120s`);</li><li>`m` — минуты (например, `5m`, `1440m`);</li><li>`h` — часы (например, `1h`, `72h`);</li><li>`d` — дни (например, `1d`, `7d`).</li></ul>Примеры: `72h`, `1440m`, `2d`, `3600s`.<br/>Для важных читателей (с параметром `--important`) этот параметр не применяется.
29+
`--availability-period VAL` | Время хранения данных в топике, для которых читатель ещё не потдвердил их обработку.<br/>Непрочитанные данные, возраст которых меньше указанного значения, не удаляются из топика.<br/>Формат: положительное число с указанием единицы измерения времени (без пробелов).<br/>Поддерживаются следующие единицы измерения:<ul><li>`s` — секунды (например, `30s`, `120s`);</li><li>`m` — минуты (например, `5m`, `1440m`);</li><li>`h` — часы (например, `1h`, `72h`);</li><li>`d` — дни (например, `1d`, `7d`).</li></ul>Примеры: `72h`, `1440m`, `2d`, `3600s`.<br/>Для важных читателей (с параметром `--important`) этот параметр не применяется.
3030

3131
## Примеры {#examples}
3232

@@ -62,7 +62,7 @@ Consumers:
6262
└──────────────┴─────────────────┴───────────────────────────────┴───────────┘
6363
```
6464

65-
**Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности незакоммиченных данных 3 дня:**
65+
**Создайте читателя с именем `backup-consumer` для топика `my-topic` с периодом доступности данных 3 дня:**
6666

6767
```bash
6868
{{ ydb-cli }} -p quickstart topic consumer add \
@@ -71,6 +71,9 @@ Consumers:
7171
my-topic
7272
```
7373

74+
В случае, если читатель успевает обрабатывать и подтверждать чтение, то данные в топике будут храниться в течение 2-х часов, в соответствии со значением параметра `retention-period` топика.
75+
Однако при временной остановке чтения, время хранения данных в топике, для которых читатель `backup-consumer` ещё не подтвердил обработку, будет увеличено вплоть до 3-х дней, в соответствии с параметром `availability-period`.
76+
7477
**Создайте важного читателя с именем `critical-consumer` для топика `my-topic` с дополнительной поддержкой кодека `ZSTD`:**
7578

7679
```bash

0 commit comments

Comments
 (0)