|
3 | 3 | Командой `topic read` выполняется чтение сообщений из топика с выводом их в файл или в терминал командной строки:
|
4 | 4 |
|
5 | 5 | ```bash
|
6 |
| -{{ ydb-cli }} [connection options] topic read <topic-path> --consumer STR \ |
| 6 | +{{ ydb-cli }} [connection options] topic read <topic-path> [--consumer STR] \ |
7 | 7 | [--format STR] [--wait] [--limit INT] \
|
8 | 8 | [--transform STR] [--file STR] [--commit BOOL] \
|
9 | 9 | [дополнительные параметры...]
|
|
21 | 21 |
|
22 | 22 | ### Обязательные параметры
|
23 | 23 |
|
24 |
| -Имя | Описание |
25 |
| ----|--- |
26 |
| -`<topic-path>` | Путь топика |
27 |
| -`-c VAL`, `--consumer VAL` | Имя читателя топика.<br/>Чтение сообщений будет начато с текущей рабочей позиции (offset) для данного читателя (если не указан параметр `--timestamp`).<br/>Текущая рабочая позиция будет передвигаться по мере чтения и вывода сообщений (если не указано значение параметра `--commit=false`). |
| 24 | +`<topic-path>`: Путь топика |
28 | 25 |
|
29 | 26 | ### Основные опциональные параметры
|
30 | 27 |
|
| 28 | +`-c VAL`, `--consumer VAL`: Имя читателя топика. |
| 29 | + |
| 30 | +- Если имя читателя не задано, то необходимо указать значение параметра `--partition-ids`. Только в этом случае возможно чтение из топика без указания имени читателя. |
| 31 | +- Чтение сообщений будет начато с текущей рабочей позиции (offset) |
| 32 | +для данного читателя (если не указан параметр `--timestamp`). Если не указать имя читателя, то чтение сообщений начнется с первого сообщения в партиции |
| 33 | + |
31 | 34 | `--format STR`: Формат вывода
|
32 | 35 |
|
33 | 36 | - Задает правило оформления сообщений на выходе. Не все форматы могут работать в потоковом режиме.
|
|
63 | 66 |
|
64 | 67 | `--file VAL` (`-f VAL`): Записывать читаемые сообщения в указанный файл. Если параметр не задан, то сообщения выводятся в `stdout`.
|
65 | 68 |
|
66 |
| -`--commit BOOL`: Подтверждение чтения. |
| 69 | +`--commit BOOL`: Подтверждение чтения. Значение по умолчанию - `false` |
67 | 70 |
|
68 |
| -1. Если установлено значение `true` (по умолчанию), то текущая рабочая позиция (offset) читателя в топике будет передвигаться по мере чтения сообщений из топика. |
69 |
| -2. Возможные значения: `true`, `false`. |
| 71 | +- Возможные значения: `true`, `false`. |
| 72 | +- Если установлено значение `true`, то текущая рабочая позиция (offset) читателя в топике будет сохраняться по мере чтения сообщений из топика. |
| 73 | +- Если установлено значение `false`, то сообщения будут вычитываться, но прогресс чтения не будет сохраняться и при перезапуске сообщения будут вычитаны заново. Эта функциональность полезна при дебаге: для вычитывания сообщений без влияния на продуктовую систему (без смещение offset). |
70 | 74 |
|
71 | 75 | ### Другие опциональные параметры
|
72 | 76 |
|
|
0 commit comments