diff options
| author | azevaykin <[email protected]> | 2023-03-21 18:41:46 +0300 |
|---|---|---|
| committer | azevaykin <[email protected]> | 2023-03-21 18:41:46 +0300 |
| commit | 751318419f46b087006ea91243d5cc9674040f5d (patch) | |
| tree | e701fbd3b31aa663e4c5567958c70310563559dc | |
| parent | 2c6e3dd02e91c6fe15024fdc9cfb45e32c85ff3c (diff) | |
Remove 'consumer-name' from examples
9 files changed, 18 insertions, 18 deletions
diff --git a/ydb/docs/en/core/best_practices/cdc.md b/ydb/docs/en/core/best_practices/cdc.md index 1be4fa0efdc..80ad1f79f8c 100644 --- a/ydb/docs/en/core/best_practices/cdc.md +++ b/ydb/docs/en/core/best_practices/cdc.md @@ -25,7 +25,7 @@ Before reading data, add a [consumer](../concepts/topic.md#consumer). Below is a ```bash {{ ydb-cli }} topic consumer add \ my/table/updates_feed \ - --consumer-name=my_consumer + --consumer=my_consumer ``` Next, you can use the created consumer to start tracking changes. Below is a sample command for tracking data changes in the CLI: @@ -71,7 +71,7 @@ As a load generator, you can use the feature of [emulating an online store](../r ```bash {{ ydb-cli }} topic consumer add \ orders/updates \ - --consumer-name=my_consumer + --consumer=my_consumer ``` 1. Start tracking changes: diff --git a/ydb/docs/en/core/reference/ydb-cli/topic-consumer-drop.md b/ydb/docs/en/core/reference/ydb-cli/topic-consumer-drop.md index bc230dcb1e4..9e959dfa76f 100644 --- a/ydb/docs/en/core/reference/ydb-cli/topic-consumer-drop.md +++ b/ydb/docs/en/core/reference/ydb-cli/topic-consumer-drop.md @@ -22,7 +22,7 @@ View the description of the delete consumer command: | Name | Description | ---|--- -| `--consumer-name VAL` | Name of the consumer to be deleted. | +| `--consumer VAL` | Name of the consumer to be deleted. | ## Examples {#examples} @@ -32,6 +32,6 @@ Delete the [previously created](#consumer-add) consumer with the `my-consumer` n ```bash {{ ydb-cli }} -p db1 topic consumer drop \ - --consumer-name my-consumer \ + --consumer my-consumer \ my-topic ``` 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 606a8ca547e..b7fd21b50fb 100644 --- a/ydb/docs/en/core/reference/ydb-cli/topic-read.md +++ b/ydb/docs/en/core/reference/ydb-cli/topic-read.md @@ -3,7 +3,7 @@ The `topic read` command reads messages from a topic and outputs them to a file or the command-line terminal: ```bash -{{ ydb-cli }} [connection options] topic read <topic-path> --consumer-name STR \ +{{ ydb-cli }} [connection options] topic read <topic-path> --consumer STR \ [--format STR] [--wait] [--limit INT] \ [--transform STR] [--file STR] [--commit BOOL] \ [additional parameters...] @@ -24,7 +24,7 @@ Three command modes are supported: | Name | Description | ---|--- | `<topic-path>` | Topic path | -| `-c VAL`, `--consumer-name 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). | +| `-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). | ### Basic optional parameters diff --git a/ydb/docs/en/core/reference/ydb-cli/topic.md b/ydb/docs/en/core/reference/ydb-cli/topic.md index a71492e6517..8988225ef98 100644 --- a/ydb/docs/en/core/reference/ydb-cli/topic.md +++ b/ydb/docs/en/core/reference/ydb-cli/topic.md @@ -162,7 +162,7 @@ View the description of the add consumer command: | Name | Description | ---|--- -| `--consumer-name VAL` | Name of the consumer to be created. | +| `--consumer VAL` | Name of the consumer to be created. | | `--starting-message-timestamp VAL` | Time in [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) format. Consumption starts as soon as the first [message](../../concepts/topic.md#message) is received after the specified time. If the time is not specified, consumption will start from the oldest message in the topic. | ### Examples {#consumer-add-examples} @@ -171,7 +171,7 @@ Create a consumer with the `my-consumer` name for the [previously created](#topi ```bash {{ ydb-cli }} -p db1 topic consumer add \ - --consumer-name my-consumer \ + --consumer my-consumer \ --starting-message-timestamp 1660568400 \ my-topic ``` @@ -221,7 +221,7 @@ View the description of the delete consumer command: | Name | Description | ---|--- -| `--consumer-name VAL` | Name of the consumer to be deleted. | +| `--consumer VAL` | Name of the consumer to be deleted. | ### Examples {#consumer-drop-examples} @@ -229,6 +229,6 @@ Delete the [previously created](#consumer-add) consumer with the `my-consumer` n ```bash {{ ydb-cli }} -p db1 topic consumer drop \ - --consumer-name my-consumer \ + --consumer my-consumer \ my-topic ``` diff --git a/ydb/docs/ru/core/best_practices/cdc.md b/ydb/docs/ru/core/best_practices/cdc.md index d4e3eceed40..6364ccc7714 100644 --- a/ydb/docs/ru/core/best_practices/cdc.md +++ b/ydb/docs/ru/core/best_practices/cdc.md @@ -25,7 +25,7 @@ CDC представлен объектом схемы данных — пото ```bash {{ ydb-cli }} topic consumer add \ my/table/updates_feed \ - --consumer-name=my_consumer + --consumer=my_consumer ``` Теперь можно воспользоваться созданным потребителем данных и запустить процесс отслеживания. Ниже приведен пример команды, с помощью которой можно отслеживать изменения данных в интерфейсе командной строки: @@ -71,7 +71,7 @@ CDC представлен объектом схемы данных — пото ```bash {{ ydb-cli }} topic consumer add \ orders/updates \ - --consumer-name=my_consumer + --consumer=my_consumer ``` 1. Запустите процесс отслеживания: diff --git a/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-drop.md b/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-drop.md index 99994dbe20f..f731703bc33 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-drop.md +++ b/ydb/docs/ru/core/reference/ydb-cli/topic-consumer-drop.md @@ -22,7 +22,7 @@ Имя | Описание ---|--- -`--consumer-name VAL` | Имя читателя, которого нужно удалить. +`--consumer VAL` | Имя читателя, которого нужно удалить. ## Примеры {#examples} @@ -32,6 +32,6 @@ ```bash {{ ydb-cli }} -p db1 topic consumer drop \ - --consumer-name my-consumer \ + --consumer my-consumer \ my-topic ``` 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 4079866f35c..cf5b24f1ad8 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/topic-read.md +++ b/ydb/docs/ru/core/reference/ydb-cli/topic-read.md @@ -3,7 +3,7 @@ Командой `topic read` выполняется чтение сообщений из топика с выводом их в файл или в терминал командной строки: ```bash -{{ ydb-cli }} [connection options] topic read <topic-path> --consumer-name STR \ +{{ ydb-cli }} [connection options] topic read <topic-path> --consumer STR \ [--format STR] [--wait] [--limit INT] \ [--transform STR] [--file STR] [--commit BOOL] \ [дополнительные параметры...] @@ -24,7 +24,7 @@ Имя | Описание ---|--- `<topic-path>` | Путь топика -`-c VAL`, `--consumer-name VAL` | Имя читателя топика.<br>Чтение сообщений будет начато с текущей рабочей позиции (offset) для данного читателя (если не указан параметр `--timestamp`).<br>Текущая рабочая позиция будет передвигаться по мере чтения и вывода сообщений (если не указано значение параметра `--commit=false`). +`-c VAL`, `--consumer VAL` | Имя читателя топика.<br>Чтение сообщений будет начато с текущей рабочей позиции (offset) для данного читателя (если не указан параметр `--timestamp`).<br>Текущая рабочая позиция будет передвигаться по мере чтения и вывода сообщений (если не указано значение параметра `--commit=false`). ### Основные опциональные параметры diff --git a/ydb/public/sdk/cpp/examples/topic_reader/eventloop/main.cpp b/ydb/public/sdk/cpp/examples/topic_reader/eventloop/main.cpp index 3b801149ffe..df103524409 100644 --- a/ydb/public/sdk/cpp/examples/topic_reader/eventloop/main.cpp +++ b/ydb/public/sdk/cpp/examples/topic_reader/eventloop/main.cpp @@ -23,7 +23,7 @@ struct TOptions { .StoreResult(&Database); opts.AddLongOption('t', "topic-path", "Topic path for reading").Required().RequiredArgument("PATH") .StoreResult(&TopicPath); - opts.AddLongOption('c', "consumer-name", "Consumer name").Required().RequiredArgument("CONSUMER") + opts.AddLongOption('c', "consumer", "Consumer name").Required().RequiredArgument("CONSUMER") .StoreResult(&ConsumerName); opts.AddLongOption("commit-after-processing", "Commit data after processing") .SetFlag(&CommitAfterProcessing).NoArgument(); diff --git a/ydb/public/sdk/cpp/examples/topic_reader/simple/main.cpp b/ydb/public/sdk/cpp/examples/topic_reader/simple/main.cpp index 4e0d07d3c60..d0fc7c8527b 100644 --- a/ydb/public/sdk/cpp/examples/topic_reader/simple/main.cpp +++ b/ydb/public/sdk/cpp/examples/topic_reader/simple/main.cpp @@ -23,7 +23,7 @@ struct TOptions { .StoreResult(&Database); opts.AddLongOption('t', "topic-path", "Topic path for reading").Required().RequiredArgument("PATH") .StoreResult(&TopicPath); - opts.AddLongOption('c', "consumer-name", "Consumer name").Required().RequiredArgument("CONSUMER") + opts.AddLongOption('c', "consumer", "Consumer name").Required().RequiredArgument("CONSUMER") .StoreResult(&ConsumerName); opts.AddLongOption("commit-after-processing", "Commit data after processing") .SetFlag(&CommitAfterProcessing).NoArgument(); |
