diff options
author | ilnaz <[email protected]> | 2023-09-05 14:11:42 +0300 |
---|---|---|
committer | ilnaz <[email protected]> | 2023-09-05 14:38:28 +0300 |
commit | d61c519131bad6ab54eaedcd218f55ee403bb83f (patch) | |
tree | cd1c29ffa8c61b072244cbff41762ef6430a5d7c | |
parent | e091d92d933bc450e1ae08a68b7f84b2ee41d892 (diff) |
Make DYNAMODB_STREAMS_JSON available for 'tech' audience
4 files changed, 16 insertions, 0 deletions
diff --git a/ydb/docs/en/core/concepts/cdc.md b/ydb/docs/en/core/concepts/cdc.md index b01822ef1f7..6c49d36af49 100644 --- a/ydb/docs/en/core/concepts/cdc.md +++ b/ydb/docs/en/core/concepts/cdc.md @@ -138,6 +138,8 @@ A [JSON](https://en.wikipedia.org/wiki/JSON) record has the following structure: {% endnote %} +{% if audience == "tech" %} + ### Amazon DynamoDB-compatible JSON format {#dynamodb-streams-json-record-structure} For [Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html)-compatible document tables, {{ ydb-short-name }} can generate change records in the [Amazon DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)-compatible format. @@ -150,6 +152,8 @@ The record structure is the same as for [Amazon DynamoDB Streams](https://docs.a * `eventSource`: Includes the `ydb:document-table` string. * `eventVersion`: Includes the `1.0` string. +{% endif %} + ## Record retention period {#retention-period} By default, records are stored in the changefeed for 24 hours from the time they are sent. Depending on usage scenarios, the retention period can be reduced or increased up to 30 days. diff --git a/ydb/docs/en/core/yql/reference/yql-core/syntax/_includes/alter_table.md b/ydb/docs/en/core/yql/reference/yql-core/syntax/_includes/alter_table.md index 30a6bc213c3..9f162c647d0 100644 --- a/ydb/docs/en/core/yql/reference/yql-core/syntax/_includes/alter_table.md +++ b/ydb/docs/en/core/yql/reference/yql-core/syntax/_includes/alter_table.md @@ -82,11 +82,15 @@ ALTER TABLE `series` RENAME INDEX `title_index` TO `title_index_new`; * `NEW_AND_OLD_IMAGES`: A combination of `NEW_IMAGE` and `OLD_IMAGE` modes. Any column values _prior to_ and _resulting from_ updates are written. * `FORMAT`: Data write format. * `JSON`: Write data in [JSON](../../../../concepts/cdc#json-record-structure) format. +{% if audience == "tech" %} * `DYNAMODB_STREAMS_JSON`: Write data in the [JSON format compatible with Amazon DynamoDB Streams](../../../../concepts/cdc#dynamodb-streams-json-record-structure). +{% endif %} * `VIRTUAL_TIMESTAMPS`: Enabling/disabling [virtual timestamps](../../../../concepts/cdc#virtual-timestamps). Disabled by default. * `RETENTION_PERIOD`: [Record retention period](../../../../concepts/cdc#retention-period). The value type is `Interval` and the default value is 24 hours (`Interval('PT24H')`). * `INITIAL_SCAN`: Enables/disables [initial table scan](../../../../concepts/cdc#initial-scan). Disabled by default. +{% if audience == "tech" %} * `AWS_REGION`: Value to be written to the `awsRegion` field. Used only with the `DYNAMODB_STREAMS_JSON` format. +{% endif %} The code below adds a changefeed named `updates_feed`, where the values of updated table columns will be exported in JSON format: diff --git a/ydb/docs/ru/core/concepts/cdc.md b/ydb/docs/ru/core/concepts/cdc.md index 1b4df2e3b8d..5b15894fb5e 100644 --- a/ydb/docs/ru/core/concepts/cdc.md +++ b/ydb/docs/ru/core/concepts/cdc.md @@ -138,6 +138,8 @@ Change Data Capture (CDC) обеспечивает захват изменени {% endnote %} +{% if audience == "tech" %} + ### JSON-формат, совместимый с Amazon DynamoDB Streams {#dynamodb-streams-json-record-structure} Для документных таблиц, совместимых с [Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html), {{ ydb-short-name }} может генерировать записи об изменениях в формате, совместимом с [Amazon DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html). @@ -150,6 +152,8 @@ Change Data Capture (CDC) обеспечивает захват изменени * `eventSource` — содержит строку `ydb:document-table`. * `eventVersion` — содержит строку `1.0`. +{% endif %} + ## Время хранения записей {#retention-period} По умолчанию записи хранятся в потоке изменений в течение 24 часов с момента отправки. В зависимости от сценариев использования время хранения можно уменьшить или увеличить до 30 дней. diff --git a/ydb/docs/ru/core/yql/reference/yql-core/syntax/_includes/alter_table.md b/ydb/docs/ru/core/yql/reference/yql-core/syntax/_includes/alter_table.md index 0580525da0b..9efc3c6ea6d 100644 --- a/ydb/docs/ru/core/yql/reference/yql-core/syntax/_includes/alter_table.md +++ b/ydb/docs/ru/core/yql/reference/yql-core/syntax/_includes/alter_table.md @@ -82,11 +82,15 @@ ALTER TABLE `series` RENAME INDEX `title_index` TO `title_index_new`; * `NEW_AND_OLD_IMAGES` - комбинация режимов `NEW_IMAGE` и `OLD_IMAGE`. Будут записаны значения всех столбцов _до_ и _в результате_ изменения. * `FORMAT` — формат данных, в котором будут записаны данные. * `JSON` — записывать данные в формате [JSON](../../../../concepts/cdc#json-record-structure). +{% if audience == "tech" %} * `DYNAMODB_STREAMS_JSON` — записывать данные в [JSON-формате, совместимом с Amazon DynamoDB Streams](../../../../concepts/cdc#dynamodb-streams-json-record-structure). +{% endif %} * `VIRTUAL_TIMESTAMPS` — включение-выключение [виртуальных меток времени](../../../../concepts/cdc#virtual-timestamps). По умолчанию выключено. * `RETENTION_PERIOD` — [время хранения записей](../../../../concepts/cdc#retention-period). Тип значения — `Interval`, значение по умолчанию — 24 часа (`Interval('PT24H')`). * `INITIAL_SCAN` — включение-выключение [первоначального сканирования](../../../../concepts/cdc#initial-scan) таблицы. По умолчанию выключено. +{% if audience == "tech" %} * `AWS_REGION` — значение, которое будет записано в поле `awsRegion`. Применимо только совместно с форматом `DYNAMODB_STREAMS_JSON`. +{% endif %} Приведенный ниже код добавит поток изменений с именем `updates_feed`, в который будут выгружаться значения изменившихся столбцов таблицы в формате JSON: |