aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIlnaz Nizametdinov <ilnaz@ydb.tech>2025-04-23 14:36:08 +0300
committerGitHub <noreply@github.com>2025-04-23 14:36:08 +0300
commit198b18c91e33d34bec3216bbaf468effd6a8bb71 (patch)
tree0d412248e9cf387e9198165369d0bdb02efe639e
parent3b555dcb2fd05aa19b19e02b0c572a76f7b86164 (diff)
downloadydb-198b18c91e33d34bec3216bbaf468effd6a8bb71.tar.gz
Describe options of CDC-topic (#15306)
-rw-r--r--ydb/docs/en/core/concepts/cdc.md23
-rw-r--r--ydb/docs/en/core/dev/cdc.md12
-rw-r--r--ydb/docs/ru/core/concepts/cdc.md23
-rw-r--r--ydb/docs/ru/core/dev/cdc.md12
4 files changed, 46 insertions, 24 deletions
diff --git a/ydb/docs/en/core/concepts/cdc.md b/ydb/docs/en/core/concepts/cdc.md
index d98f453df0f..e38f0d19967 100644
--- a/ydb/docs/en/core/concepts/cdc.md
+++ b/ydb/docs/en/core/concepts/cdc.md
@@ -247,6 +247,29 @@ Currently, the ability to explicitly specify the number of topic partitions is a
You can add a changefeed to an existing table or erase it using the [ADD CHANGEFEED and DROP CHANGEFEED](../yql/reference/syntax/alter_table/changefeed.md) directives of the YQL `ALTER TABLE` statement. When erasing a table, the changefeed added to it is also deleted.
+## Getting and Updating Topic Settings {#topic-settings}
+
+You can get the settings using an [SDK](../reference/ydb-sdk/topic.md#describe-topic) or the [{{ ydb-short-name }} CLI](../reference/ydb-cli/commands/scheme-describe.md) by passing the path to the changefeed in the arguments, which has the following format:
+
+```txt
+path/to/table/changefeed_name
+```
+
+For example, if a table named `table` contains a changefeed named `updates_feed` in the `my` directory, its path looks as follows:
+
+```text
+my/table/updates_feed
+```
+
+The topic settings can be updated using the expression [ALTER TOPIC](../yql/reference/syntax/alter-topic.md). Supported actions:
+
+* [updating settings](../yql/reference/syntax/alter-topic.md#updating-topic-settings):
+
+ * `retention_period`;
+ * `retention_storage_mb`;
+
+* [updating consumers](../yql/reference/syntax/alter-topic.md#updating-a-set-of-consumers).
+
## CDC Purpose and Use {#best_practices}
For information about using CDC when developing apps, see [best practices](../dev/cdc.md).
diff --git a/ydb/docs/en/core/dev/cdc.md b/ydb/docs/en/core/dev/cdc.md
index 857301a06d9..cf04a6b3703 100644
--- a/ydb/docs/en/core/dev/cdc.md
+++ b/ydb/docs/en/core/dev/cdc.md
@@ -8,18 +8,6 @@ CDC is represented as a data schema object: a changefeed that can be added to a
## Reading data from a topic {#read}
-You can read data using an [SDK](../reference/ydb-sdk/index.md) or the [{{ ydb-short-name }} CLI](../reference/ydb-cli/index.md). As with any other data schema object, you can access a changefeed using its path that has the following format:
-
-```txt
-path/to/table/changefeed_name
-```
-
-For example, if a table named `table` contains a changefeed named `updates_feed` in the `my` directory, its path looks as follows:
-
-```text
-my/table/updates_feed
-```
-
Before reading data, add a [consumer](../concepts/topic.md#consumer). Below is a sample command that adds a consumer named `my_consumer` to the `updates_feed` changefeed of the `table` table in the `my` directory:
```bash
diff --git a/ydb/docs/ru/core/concepts/cdc.md b/ydb/docs/ru/core/concepts/cdc.md
index f8baf058b1a..b0e74622962 100644
--- a/ydb/docs/ru/core/concepts/cdc.md
+++ b/ydb/docs/ru/core/concepts/cdc.md
@@ -247,6 +247,29 @@ Change Data Capture (CDC) обеспечивает захват изменени
Поток изменений может быть добавлен к существующей таблице или удален директивами [ADD CHANGEFEED и DROP CHANGEFEED](../yql/reference/syntax/alter_table/changefeed.md) операции YQL `ALTER TABLE`. При удалении таблицы добавленный к ней поток изменений также будет удален.
+## Получение и изменение параметров топика {#topic-options}
+
+Для получения параметров топика можно воспользоваться [SDK](../reference/ydb-sdk/topic.md#describe-topic) или [{{ ydb-short-name }} CLI](../reference/ydb-cli/commands/scheme-describe.md), передав в аргументах путь до потока изменений, который формируется следующим образом:
+
+```txt
+путь/до/строковой_таблицы/имя_потока_изменений
+```
+
+>Например, если у строковой таблицы `table` в директории `my` есть поток изменений с именем `updates_feed`, то путь к нему будет выглядеть так:
+>
+>```text
+>my/table/updates_feed
+>```
+
+Параметры топика могут быть изменены с использованием выражения [ALTER TOPIC](../yql/reference/syntax/alter-topic.md). Поддерживаемые действия:
+
+* [изменение параметров](../yql/reference/syntax/alter-topic.md#alter-topic):
+
+ * `retention_period`;
+ * `retention_storage_mb`;
+
+* [управление читателями](../yql/reference/syntax/alter-topic.md#consumer).
+
## Назначение и применение CDC {#best_practices}
Об использовании CDC при разработке приложений смотрите в [рекомендациях](../dev/cdc.md).
diff --git a/ydb/docs/ru/core/dev/cdc.md b/ydb/docs/ru/core/dev/cdc.md
index 4fe657a8990..7e4f75f04e6 100644
--- a/ydb/docs/ru/core/dev/cdc.md
+++ b/ydb/docs/ru/core/dev/cdc.md
@@ -10,18 +10,6 @@ CDC представлен объектом схемы данных — пото
## Чтение из топика {#read}
-Для чтения данных можно воспользоваться [SDK](../reference/ydb-sdk/) или [{{ ydb-short-name }} CLI](../reference/ydb-cli/). Как и к любому другому объекту схемы данных, к потоку изменений можно обратиться по его пути, который формируется следующим образом:
-
-```txt
-путь/до/строковой_таблицы/имя_потока_данных
-```
-
->Например, если у строковой таблицы `table` в директории `my` есть поток изменений с именем `updates_feed`, то путь к нему будет выглядеть так:
->
->```text
->my/table/updates_feed
->```
-
Прежде чем приступить к чтению данных, необходимо добавить [потребителя данных (consumer)](../concepts/topic.md#consumer). Ниже приведен пример команды, которая добавит потребителя данных с именем `my_consumer` в поток данных с именем `updates_feed` строковой таблицы `table` в директории `my`:
```bash