Creating a changefeed for a table

Table changefeed, or Change Data Capture (CDC), keeps you informed about changes in a particular table. When you add, update, or delete a table row, the CDC mechanism generates a change record where it specifies the primary key of the row and writes it to the topic partition corresponding to this key. A topic is an entity for storing unstructured messages and delivering them to multiple subscribers. Basically, a topic is a named set of messages.

Description of the yandex_ydb_table_changefeed resourceDescription of the yandex_ydb_table_changefeed resource

You can create a changefeed for a table using the yandex_ydb_table_changefeed resource:

resource "yandex_ydb_table_changefeed" "ydb_changefeed" {
  table_id = yandex_ydb_table.test_table_2.id
  name = "changefeed"
  mode = "NEW_IMAGE"
  format = "JSON"

  consumer {
    name = "test_consumer"
  }
}

We used the following fields to create a table changefeed:

• table_id: ID of the table you create a changefeed for.
• name: Changefeed name.
• mode: Changefeed operating mode. The available changefeed operating modes are presented in the documentation.
• format: Changefeed format. Only JSON format is available.

Full description of all yandex_ydb_table_changefeed resource fields:

When initializing the yandex_ydb_table_changefeed resource, you can specify only one connection field: connection_string, table_path, or table_id. If you specify multiple connection fields, they will come into conflict. For example, the table_id field with a relative link in <recourse>.<ID>.<parameter> format: yandex_ydb_table.test_table_2.id.

The consumer section resides inside the changefeed resource. A consumer is a named entity for reading data from the topic. A consumer has several fields of settings. The main field is name, which is the consumer's name. When initializing the yandex_ydb_table_changefeed resource, you can specify multiple readers, or you can create none, but then you cannot read data from the changefeed.

Full list of the consumer section fields:

The consumer name is used in the SDK or CLI to read data from the topic.