aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorilnaz <ilnaz@ydb.tech>2023-09-14 14:29:43 +0300
committerilnaz <ilnaz@ydb.tech>2023-09-14 14:51:05 +0300
commitc3a576c8d16fbd457f297937ca83c88280bbffda (patch)
tree1a5a03094bf0ffbd83c630515ee43095a64e7fce
parentf644185b251e81167bde04340e942851924f3a2c (diff)
downloadydb-c3a576c8d16fbd457f297937ca83c88280bbffda.tar.gz
Docs
-rw-r--r--ydb/docs/en/core/reference/ydb-cli/topic-read.md1
-rw-r--r--ydb/docs/ru/core/reference/ydb-cli/topic-read.md1
2 files changed, 2 insertions, 0 deletions
diff --git a/ydb/docs/en/core/reference/ydb-cli/topic-read.md b/ydb/docs/en/core/reference/ydb-cli/topic-read.md
index 7537b1763a..82db0fb335 100644
--- a/ydb/docs/en/core/reference/ydb-cli/topic-read.md
+++ b/ydb/docs/en/core/reference/ydb-cli/topic-read.md
@@ -75,6 +75,7 @@ Three command modes are supported:
| `--idle-timeout VAL` | Timeout for deciding if a topic is empty, meaning that it contains no messages for processing. <br>The time is counted from the point when a connection is established once the command is run or when the last message is received. If no new messages arrive from the server during the specified timeout, the topic is considered to be empty.<br>Defaults to `1s` (1 second). |
| `--timestamp VAL` | Message consumption starts from the point in time specified in [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) format.<br>If not set, messages are consumed starting from the consumer's current offset in the topic.<br>If set, consumption starts from the first [message](../../concepts/topic.md#message) received after the specified time. |
| `--with-metadata-fields VAL` | List of [message attributes](../../concepts/topic.md#message) whose values should be output in columns with metadata in `pretty` format. If not set, columns with all attributes are output. <br>Possible values:<ul><li>`write_time`: The time a message is written to the server in [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) format.</li><li>`meta`: Message metadata.</li><li>`create_time`: The time a message is created by the source in [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) format.</li><li>`seq_no`: Message [sequence number](../../concepts/topic.md#seqno).</li><li>`offset`: [Message sequence number within a partition](../../concepts/topic.md#offset).</li><li>`message_group_id`: [Message group ID](../../concepts/topic.md#producer-id).</li><li>`body`: Message body.</li></ul> |
+| `--partition-ids VAL` | Comma-separated list of [partition](../../concepts/topic.md#partitioning) identifiers to read from.<br>If not specified, messages are read from all partitions. |
## Examples {#examples}
diff --git a/ydb/docs/ru/core/reference/ydb-cli/topic-read.md b/ydb/docs/ru/core/reference/ydb-cli/topic-read.md
index 0d4c91cf80..402de741f4 100644
--- a/ydb/docs/ru/core/reference/ydb-cli/topic-read.md
+++ b/ydb/docs/ru/core/reference/ydb-cli/topic-read.md
@@ -75,6 +75,7 @@
`--idle-timeout VAL` | Таймаут принятия решения о том что топик пуст, то есть новые сообщения для обработки отсутствуют. <br>Замеряется время с момента установки соединения при запуске команды, или получения последнего сообщения. Если в течение заданного таймаута с сервера не приходит новых сообщений, топик считается пустым.<br>Значение по умолчанию — `1s` (1 секунда).
`--timestamp VAL` | Чтение с заданного в формате [UNIX timestamp](https://ru.wikipedia.org/wiki/Unix-время) времени.<br>Если параметр не указан, то чтение выполняется с текущей рабочей позиции читателя в топике.<br>Если параметр указан, то чтение начнется с первого [сообщения](../../concepts/topic.md#message), полученного после указанного времени.
`--with-metadata-fields VAL` | Список [атрибутов сообщения](../../concepts/topic.md#message), значения которых нужно выводить в колонках с метаинформацией в формате `pretty`. Если параметр не указан, то выводятся колонки со всеми атрибутами. <br>Возможные значения:<ul><li>`write_time` — время записи сообщения на сервер в формате [UNIX timestamp](https://ru.wikipedia.org/wiki/Unix-время);</li><li>`meta` — метаданные сообщения;</li><li>`create_time` — время создания сообщения источником в формате [UNIX timestamp](https://ru.wikipedia.org/wiki/Unix-время);</li><li>`seq_no` — [порядковый номер](../../concepts/topic.md#seqno) сообщения;</li><li>`offset` — [порядковый номер сообщения внутри партиции](../../concepts/topic.md#offset);</li><li>`message_group_id` — [идентификатор группы сообщений](../../concepts/topic.md#producer-id);</li><li>`body` — тело сообщения.</li></ul>
+`--partition-ids VAL` | Идентификаторы (порядковые номера) [партиций](../../concepts/topic.md#partitioning), из которых будет производиться чтение.<br>Если параметр не указан, то чтение производится из всех партиций.
## Примеры {#examples}