Skip to content

Commit bc40682

Browse files
add read without consumer docs (#15883)
Co-authored-by: lopatinevgeny <[email protected]> Часть общих замечаний решили вынести в отдельный тикет: LOGBROKER-9563 Текущий текст, считаю норм. Также стоит поднять вопрос почему формат выдачи (--format) определяет алгоритм работы (--wait) - очень странное решение. Это не к документации вопрос уже, а к алгоритму работы системы. Я бы изменил поведение - алгоритм работы первичен, если какой-то формат в этом режиме не поддерживается, то должна быть ошибка при запуске команды.
1 parent 550e190 commit bc40682

File tree

2 files changed

+23
-15
lines changed

2 files changed

+23
-15
lines changed

ydb/docs/en/core/reference/ydb-cli/topic-read.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,16 @@ Three command modes are supported:
2121

2222
### Required parameters
2323

24-
| Name | Description |
25-
---|---
26-
| `<topic-path>` | Topic path |
27-
| `-c VAL`, `--consumer VAL` | Topic consumer name.<br/>Message consumption starts from the current offset for this consumer (if the `--timestamp` parameter is not specified).<br/>The current offset is shifted as messages are consumed and output (if `--commit=false` is not set). |
24+
`<topic-path>`: Topic path
2825

2926
### Basic optional parameters
3027

28+
`-c VAL`, `--consumer VAL`: Topic consumer name.
29+
30+
- If not set, then you need to specify partitions through --partition-ids to read without consumer
31+
- Message consumption starts from the current offset for this consumer (if the `--timestamp` parameter is not specified).
32+
If consumer name is not specified, message consumption will start from the first message in partition.
33+
3134
`--format STR`: Output format.
3235

3336
- Specifies how to format messages at the output. Some formats don't support streaming mode.
@@ -63,10 +66,11 @@ Three command modes are supported:
6366

6467
`--file VAL` (`-f VAL`): Write the messages read to the specified file. If not set, messages are output to `stdout`.
6568

66-
`--commit BOOL`: Commit message reads.
69+
`--commit BOOL`: Commit message reads. Default value - `false`.
6770

68-
1. If `true` (by default), a consumer's current offset is shifted as topic messages are consumed.
69-
2. Possible values: `true` or `false`.
71+
- Possible values: `true` or `false`.
72+
- If `true`, a consumer's current offset is shifted as topic messages are consumed.
73+
- If the value is set to `false`, messages will be read, but the reading progress won't be saved, and upon restart, the messages will be read again. This functionality is useful for debugging: allowing messages to be read without affecting the production system (without offset commit).
7074

7175
### Other optional parameters
7276

ydb/docs/ru/core/reference/ydb-cli/topic-read.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Командой `topic read` выполняется чтение сообщений из топика с выводом их в файл или в терминал командной строки:
44

55
```bash
6-
{{ ydb-cli }} [connection options] topic read <topic-path> --consumer STR \
6+
{{ ydb-cli }} [connection options] topic read <topic-path> [--consumer STR] \
77
[--format STR] [--wait] [--limit INT] \
88
[--transform STR] [--file STR] [--commit BOOL] \
99
[дополнительные параметры...]
@@ -21,13 +21,16 @@
2121

2222
### Обязательные параметры
2323

24-
Имя | Описание
25-
---|---
26-
`<topic-path>` | Путь топика
27-
`-c VAL`, `--consumer VAL` | Имя читателя топика.<br/>Чтение сообщений будет начато с текущей рабочей позиции (offset) для данного читателя (если не указан параметр `--timestamp`).<br/>Текущая рабочая позиция будет передвигаться по мере чтения и вывода сообщений (если не указано значение параметра `--commit=false`).
24+
`<topic-path>`: Путь топика
2825

2926
### Основные опциональные параметры
3027

28+
`-c VAL`, `--consumer VAL`: Имя читателя топика.
29+
30+
- Если имя читателя не задано, то необходимо указать значение параметра `--partition-ids`. Только в этом случае возможно чтение из топика без указания имени читателя.
31+
- Чтение сообщений будет начато с текущей рабочей позиции (offset)
32+
для данного читателя (если не указан параметр `--timestamp`). Если не указать имя читателя, то чтение сообщений начнется с первого сообщения в партиции
33+
3134
`--format STR`: Формат вывода
3235

3336
- Задает правило оформления сообщений на выходе. Не все форматы могут работать в потоковом режиме.
@@ -63,10 +66,11 @@
6366

6467
`--file VAL` (`-f VAL`): Записывать читаемые сообщения в указанный файл. Если параметр не задан, то сообщения выводятся в `stdout`.
6568

66-
`--commit BOOL`: Подтверждение чтения.
69+
`--commit BOOL`: Подтверждение чтения. Значение по умолчанию - `false`
6770

68-
1. Если установлено значение `true` (по умолчанию), то текущая рабочая позиция (offset) читателя в топике будет передвигаться по мере чтения сообщений из топика.
69-
2. Возможные значения: `true`, `false`.
71+
- Возможные значения: `true`, `false`.
72+
- Если установлено значение `true`, то текущая рабочая позиция (offset) читателя в топике будет сохраняться по мере чтения сообщений из топика.
73+
- Если установлено значение `false`, то сообщения будут вычитываться, но прогресс чтения не будет сохраняться и при перезапуске сообщения будут вычитаны заново. Эта функциональность полезна при дебаге: для вычитывания сообщений без влияния на продуктовую систему (без смещение offset).
7074

7175
### Другие опциональные параметры
7276

0 commit comments

Comments
 (0)