Enable Change Data Capture for Astra DB

Change Data Capture (CDC) for Astra DB incurs billed charges based on your Astra Streaming usage. For more information, see Astra Streaming pricing and CDC metering rates.

Change Data Capture (CDC) for Astra DB automatically captures changes in real time, de-duplicates the changes, and then streams the clean set of changed data into Astra Streaming where it can be processed by client applications or sent to downstream systems.

Astra Streaming processes data changes through an Apache Pulsar™ topic. By design, the Change Data Capture (CDC) component has a one-to-one correspondence between a table and a single Pulsar topic.

Supported data structures

CDC for Astra DB supports the following CQL data types and corresponding AVRO or logical types:

Data type AVRO type

ascii

string

bigint

long

blob

bytes

boolean

boolean

counter

long

date

int

decimal

cql_decimal

double

double

duration

cql_duration

float

float

inet

string

int

int

list

array

map

map (only string-type keys are supported)

set

array

smallint

int

text

string

time

long

timestamp

long

timeuuid

string

tinyint

int

uuid

string

varchar

string

varint

cql_varint / bytes

Static columns

Static columns are supported on the following:

  • On row-level updates, static columns are included in the message value.

  • On partition-level updates, the clustering keys are null in the message key. The message value has static columns only on INSERT and UPDATE operations.

Unsupported data types

For columns using unsupported data types, those data types are omitted from the events that CDC sends to the Astra Streaming tenant’s data- topic.

If a row update contains both supported and unsupported data types, the event includes only columns with supported data types.

AVRO interpretation

Keys from tables in Astra DB databases are strings, but CDC produces AVRO messages that are structures. The conversion for some AVRO structures requires additional tooling that can result in unexpected output.

The following table describes the conversion of AVRO logical types:

AVRO complex types
Name AVRO type Fields Explanation

collections

array

lists, sets

Sets and Lists are treated as AVRO type array, with the attribute items containing the schema of the array’s items.

decimal

record

BIG_INT, DECIMAL_SCALE

The Cassandra DECIMAL type is converted to a record with the cql_decimal logical type.

The record AVRO type is a schema containing the listed fields.

duration

record

CQL_DURATION_MONTHS, CQL_DURATION_DAYS, CQL_DURATION_NANOSECONDS

The Cassandra DURATION type is converted to a record with the cql_duration logical type.

The record AVRO type is a schema containing the listed fields.

maps

map

KEYS_CONVERTED_TO_STRINGS, VALUE_SCHEMA

The Cassandra MAP type is converted to the AVRO map type, but the keys are converted to strings. For complex types, the key is represented in JSON.

CDC for Astra DB limitations

  • Doesn’t sync data available before starting the CDC agent

  • Doesn’t replay logged batches

  • Doesn’t manage time-to-live (TTL)

  • Doesn’t support range deletes

  • Doesn’t manage table truncates

  • Doesn’t allow CQL column names that match a Pulsar primitive type name, such as INT32

  • Doesn’t support multi-table mutations

Configure CDC for Astra DB

To configure CDC for Astra DB, you must create an Astra Streaming tenant, an Astra DB database, and a table in that database. Then, you enable CDC on the table and connect a sink.

When you enable CDC on a table, CDC automatically creates a namespace and topics for that table in the streaming tenant. The connected sink consumes messages from the data- topic, and then sends them to the associated service deployment.

Prerequisites

To enable CDC for Astra DB, you need the following:

  • An active Astra account with access to an organization that has an Astra Streaming subscription plan.

    You need a role that grants permission to manage streaming tenants, such as the Organization Administrator role.

  • An active database with at least one keyspace.

  • The database’s Secure Connect Bundle (SCB).

  • An active sink service account and sink deployment connection details. For example, for Elasticsearch, you need an Elasticsearch endpoint, index name, and API key.

    This guide uses an Elasticsearch sink as an example. You can use other Astra Streaming sinks.

Create a streaming tenant

CDC operates through Astra Streaming tenants and topics. If you don’t have any Astra Streaming tenants, you must create a tenant in order to enable CDC on a table in an Astra DB database.

  1. In the Astra Portal navigation menu, select Streaming.

  2. Click Create Tenant.

  3. Enter a name for the streaming tenant.

  4. Select a cloud provider and region.

    Your Astra Streaming tenant must be in the same region as the table where you want to enable CDC.

    CDC for Astra DB is available only in regions that support Astra Streaming. If your database is deployed to an Astra DB region that doesn’t yet support Astra Streaming, contact your DataStax account representative or DataStax Support.

  5. Click Create Tenant.

    Don’t create any namespaces or topics in your tenant because CDC does this automatically.

  6. If you plan to enable CDC on multiple databases or enable CDC on a multi-region database, create one Astra Streaming tenant for each region where your databases are deployed.

    Astra Streaming allows only one tenant per region. You must use the same tenant for each table in the same region, even if those tables belong to different databases.

Create a table

If you haven’t done so already, create one or more tables in your database.

Alternatively, you can follow these steps to create a small demo table to test CDC for Astra DB before enabling it on your production tables:

  1. In the Astra Portal navigation menu, select Databases, and then select the database where you want to enable CDC.

    Make sure the database is deployed to the same region as your Astra Streaming tenant.

  2. Click CQL Console.

  3. Use the built-in CQL shell to create a table in your database.

    For example, the following command creates a cdc_demo table with two columns in the default_keyspace keyspace:

    CREATE TABLE IF NOT EXISTS default_keyspace.cdc_demo (key text PRIMARY KEY, c1 text);

    If your database doesn’t have a keyspace named default_keyspace, you must replace default_keyspace with the name of a keyspace in your database. You must also change the other commands in this guide accordingly.

  4. Run a simple select statement to verify that the table was created:

    select * from default_keyspace.cdc_demo;

    Currently, the table has no rows:

    Result
     key | c1
-----+----

(0 rows)

    Later, you will insert some rows to test your CDC connection and sink.

Enable CDC on a table

After you create a tenant and create tables, enable CDC on your tables.

For multi-region databases, you must use the Astra DevOps API to enable CDC in secondary regions.

  • Astra Portal

  • Astra DevOps API

  1. In the Astra Portal navigation menu, select Databases, and then select the database where you want to enable CDC.

    If you created the demo table in Create a table, select the database where you created that table.

  2. Click the CDC tab, and then click Enable CDC.

  3. Select a tenant, keyspace, and table, and then click Enable CDC.

  4. Refresh the page to get the updated list of CDC-enabled tables in this database.

  5. Repeat to enable CDC on additional tables.

CDC for multi-region Astra DB Serverless (Vector) databases is available only to qualified participants in this private preview release. Development is ongoing, and the features and functionality are subject to change. This private preview is governed by your Agreement and the DataStax Preview Terms.

If you’re interested in this private preview feature, contact your DataStax account representative.

Use the Astra DevOps API to enable CDC on one or more tables in the same database in the same request.

You can use these endpoints to enable CDC in single-region and multi-region databases.

  • Enable CDC after deploying a region

  • Deploy a secondary region with CDC enabled

Use these steps to enable CDC in a single-region database or in previously-deployed regions of a multi-region database. You can also use this configuration to enable CDC on new tables.

  1. Use GET /v3/databases/DB_ID/cdc to check the database’s existing CDC configuration:

    curl -sS -L -X GET "https://api.astra.datastax.com/v3/databases/DB_ID/cdc" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Accept: application/json"

    Replace the following:

  2. If the database has an existing CDC configuration, copy the tables and regions arrays from the response. You must include the existing configuration details in the subsequent POST request.

  3. Use POST /v3/databases/DB_ID/cdc to enable CDC on a table.

    This is a desired state list.

    To add regions or tables to an existing CDC configuration, make sure that you include the existing tables and regions objects in your request.

    		 
    curl -sS -L -X POST "https://api.astra.datastax.com/v3/databases/DB_ID/cdc" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Accept: application/json" \
--data '{
  "databaseID": "DB_ID",
  "databaseName": "DB_NAME",
  "tables": [
    {
      "tableName": "TABLE_NAME",
      "keyspaceName": "KEYSPACE_NAME"
    },
    {
      "tableName": "TABLE_NAME",
      "keyspaceName": "KEYSPACE_NAME"
    }
  ],
  "regions": [
    {
      "datacenterID": "DB_ID-REGION_SUFFIX",
      "datacenterRegion": "REGION_NAME",
      "streamingClusterName": "STREAMING_CLUSTER_NAME",
      "streamingTenantName": "STREAMING_TENANT_NAME"
    },
    {
      "datacenterID": "DB_ID-REGION_SUFFIX",
      "datacenterRegion": "REGION_NAME",
      "streamingClusterName": "STREAMING_CLUSTER_NAME",
      "streamingTenantName": "STREAMING_TENANT_NAME"
    }
  ]
}'

    Provide the following:

    • DB_ID: The database ID

    • APPLICATION_TOKEN: An Astra DB application token

    • tables: An array of objects where each object contains the name of a table and keyspace where you want to enable CDC. To enable CDC on multiple tables in the same database, include one object for each table in the tables array.

    • regions: An array of objects where each object contains the information necessary to enable CDC in one region of a multi-region database:

      • DATACENTER_ID: A datacenter or region ID, which is the database ID with a numerical suffix.

      • DATACENTER_REGION: The name of the region where the database and Astra Streaming tenant are deployed, such as us-east1. You can only enable CDC in regions that support Astra Streaming.

      • STREAMING_CLUSTER_NAME and STREAMING_TENANT_NAME: The name of your Astra Streaming tenant and cluster. Tenant must be deployed to the same region as the database. You can get these names from the Astra Portal on the Streaming page or with the Astra Streaming DevOps API.

Use POST /v2/databases/DB_ID/datacenters to add a region to a multi-region database and enable CDC in the same command.

curl -sS -L -X POST "https://api.astra.datastax.com/v2/databases/DB_ID/datacenters" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Accept: application/json" \
--data '{
  [
    {
      "tier": "serverless",
      "status": "ACTIVE",
      "cloudProvider": "CLOUD_PROVIDER",
      "region": "REGION_NAME",
      "streamingTenant": {
        "streamingClusterName": "STREAMING_CLUSTER_NAME",
        "streamingTenantName": "STREAMING_TENANT_NAME"
      }
    }
  ]
}'

Replace the following:

  • DB_ID: The database ID

  • APPLICATION_TOKEN: An Astra DB application token

  • CLOUD_PROVIDER: The cloud provider where the database is deployed, one of AWS, GCP, or AZURE. Astra DB doesn’t support cross-provider deployments.

  • REGION_NAME: The name of the region you want to add, such as us-east1. You can only add one region at a time. To enable CDC, you must deploy the database to regions that support Astra Streaming.

  • STREAMING_CLUSTER_NAME and STREAMING_TENANT_NAME: The name of the Astra Streaming tenant and cluster. The tenant must be in the same region as specified in region.

All tables replicated to the new region automatically have CDC enabled. The astracdc namespace and CDC topics for each table are created in the specified regional tenant.

To check the CDC configuration for a database or table, see Check CDC status.

When you enable CDC on a database for the first time, Astra DB automatically creates an astracdc namespace in your streaming tenant. For each table where you enable CDC, Astra DB creates two topics in the astracdc namespace:

  • The data- topic consumes CDC data in Astra Streaming.

  • The log- topic consumes schema changes, processes them, and then writes clean data to the data- topic. The log- topic is required for CDC functionality; it is not for direct use.

Each topic name includes the keyspace and table name in the format tenant/astracdc/data-uuid-keyspace.table. If you enable CDC on multiple tables in the same region, each table has its own topics within the corresponding regional Astra Streaming tenant.

Each topic has three partitions by default. You can increase partitions for the data- topic, as explained in Increase CDC data topic partitions.

Connect a sink

After you enable CDC, you need to connect a sink.

The sink consumes messages from the data- topics, and then sends them to the associated service deployment.

This example uses an Elasticsearch sink. You can use other Astra Streaming sinks.

  1. On the CDC tab where you just enabled CDC on a table, click the table’s name.

  2. Click Add Elastic Search Sink.

  3. For Namespace, select astracdc.

  4. For Sink Type, select Elastic Search.

  5. Enter a name for the sink.

  6. In the Connect Topics section, for the Input topic, select the data- topic in the astracdc namespace.

  7. In the Sink-Specific Configuration section, enter your Elasticsearch URL, Index name, and API key for your Elasticsearch deployment.

    Don’t enter a username, password, or token.

  8. For Ignore Record Key, Null Value Action, and Enable Schema, DataStax recommends the following values:

    • Ignore Record Key: false

    • Null Value Action: DELETE

    • Enable Schema: true

  9. Click Create.

If sink creation succeeds, a confirmation message appears in the Astra Portal, and the new sink appears on the Sinks tab.

Test the connection

Test the CDC functionality to verify that your Elasticsearch sink receives data through CDC:

  1. In the Astra Portal navigation menu, select Databases, and then select the database where you enabled CDC and added a sink.

  2. Click CQL Console.

  3. Make a change to your table. For example, the following command inserts two rows into a table:

    INSERT INTO default_keyspace.cdc_demo (key,c1) VALUES ('32a','bob3123');
INSERT INTO default_keyspace.cdc_demo (key,c1) VALUES ('32b','bob3123b');

  4. Use a select statement to verify the change.

    The following example is a simple select statement that reads the entire table. If your table has more than a few rows, use a more specific select statement to avoid resource intensive queries.

    select * from default_keyspace.cdc_demo;
    Result

    The demo table now has two rows:

     key | c1
-----+----------
 32a |  bob3123
 32b | bob3123b

(2 rows)

  5. Verify that the change was passed from CDC to your sink by fetching the data from your sink service deployment.

    For example, if you have an Elasticsearch sink, you can send a GET request to your Elasticsearch deployment:

    curl -sS -L -X POST "ELASTICSEARCH_URL/INDEX_NAME/_search?pretty" \
-header "Authorization: ApiKey 'API_KEY'"

    Replace ELASTICSEARCH_URL, INDEX_NAME, and API_KEY with the values from your Elasticsearch deployment that you used to connect the sink.

  6. Make sure the response includes your latest changes. This indicates that Astra Streaming successfully sent changes tracked by CDC to your sink service deployment.

    The following example shows a response from an Elasticsearch deployment:

    {
  "took": 1,
  "timed_out": false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 3,
      "relation": "eq"
    },
    "max_score": 1.0,
    "hits": [
      {
        "_index": "INDEX_NAME",
        "_id": "khl_hI0Bh25AUvCHghQo",
        "_score": 1.0,
        "_source": {
          "name": "foo",
          "title": "bar"
        }
      },
      {
        "_index": "INDEX_NAME",
        "_id": "32a",
        "_score": 1.0,
        "_source": {
          "c1": "bob3123"
        }
      },
      {
        "_index": "INDEX_NAME",
        "_id": "32b",
        "_score": 1.0,
        "_source": {
          "c1": "bob3123b"
        }
      }
    ]
  }
}

Increase CDC data topic partitions

When you enable CDC, Astra DB creates three data- partitions and three log- partitions in your tenant’s astracdc namespace.

Optionally, you can increase the number of partitions for the data- topic. Increasing the number of partitions creates new partitions, but existing data remains in the original partitions. New messages are distributed across the new partitions.

To increase the number of data- topic partitions, do the following:

  1. Before you make changes, use pulsar-admin to get the namespace’s existing partitions:

    bin/pulsar-admin topics list-partitioned-topics astracdc

    The response describes the existing partitions for the data- and log- topics. The default configuration has three partitions for each topic numbered 0, 1, and 2.

    persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-1
persistent://TENANT_NAME/astracdc/log-ID-KEYSPACE_NAME.TABLE_NAME-partition-2
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-0
persistent://TENANT_NAME/astracdc/log-ID-KEYSPACE_NAME.TABLE_NAME-partition-0
persistent://TENANT_NAME/astracdc/log-ID-KEYSPACE_NAME.TABLE_NAME-partition-1
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-2

    The TENANT_NAME, ID, KEYSPACE_NAME, and TABLE_NAME values are the same for each partition. The actual values depend on your CDC configuration.

  2. From the response, get a data- topic string without persistent:// and the partition number.

    For example, from persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-1, extract only TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME.

  3. Use the update-partitioned-topic command to increase the number of partitions for the data- topic:

    bin/pulsar-admin topics update-partitioned-topic DATA_TOPIC_STRING --partitions NUMBER

    Replace the following:

    • DATA_TOPIC_STRING: The data- topic string from the list-partitioned-topics response in the format of TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME.

    • NUMBER: The desired total number of partitions.

      For example, --partitions 10 increases the total number of partitions to 10. If the topic has 3 partitions, then --partitions 10 creates 7 new partitions for a total of 10.

      You can only increase the number of partitions.

      You can’t decrease the number of partitions due to potential data loss and message ordering issues.

  4. Verify the increase:

    bin/pulsar-admin topics list TENANT_NAME/astracdc

    Replace TENANT_NAME with your CDC tenant name.

  5. Make sure the response includes the desired total number of partitions.

    The following response indicates that the data- topic now has 10 total partitions numbered 0-9:

    persistent://TENANT_NAME/astracdc/log-ID-KEYSPACE_NAME.TABLE_NAME-partition-2
persistent://TENANT_NAME/astracdc/log-ID-KEYSPACE_NAME.TABLE_NAME-partition-0
persistent://TENANT_NAME/astracdc/log-ID-KEYSPACE_NAME.TABLE_NAME-partition-1
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-9
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-8
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-7
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-6
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-1
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-0
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-5
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-4
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-3
persistent://TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME-partition-2

  6. Confirm that the topic was updated to have the desired number of partitions:

    bin/pulsar-admin topics partitioned-stats persistent://**DATA_TOPIC_STRING**

    Replace DATA_TOPIC_STRING with the data- topic string in the format of TENANT_NAME/astracdc/data-ID-KEYSPACE_NAME.TABLE_NAME.

    Result 
    {
  "msgRateIn" : 0.0,
  "msgThroughputIn" : 0.0,
  "msgRateOut" : 0.0,
  "msgThroughputOut" : 0.0,
  "bytesInCounter" : 0,
  "msgInCounter" : 0,
  "bytesOutCounter" : 0,
  "msgOutCounter" : 0,
  "averageMsgSize" : 0.0,
  "msgChunkPublished" : false,
  "storageSize" : 0,
  "backlogSize" : 0,
  "publishRateLimitedTimes" : 0,
  "earliestMsgPublishTimeInBacklogs" : 0,
  "offloadedStorageSize" : 0,
  "lastOffloadLedgerId" : 0,
  "lastOffloadSuccessTimeStamp" : 0,
  "lastOffloadFailureTimeStamp" : 0,
  "publishers" : [ ],
  "waitingPublishers" : 0,
  "subscriptions" : { },
  "replication" : { },
  "nonContiguousDeletedMessagesRanges" : 0,
  "nonContiguousDeletedMessagesRangesSerializedSize" : 0,
  "compaction" : {
    "lastCompactionRemovedEventCount" : 0,
    "lastCompactionSucceedTimestamp" : 0,
    "lastCompactionFailedTimestamp" : 0,
    "lastCompactionDurationTimeInMills" : 0
  },
  "metadata" : {
    "partitions" : 10
  },
  "partitions" : { }
}

Enable CDC for multi-region databases

CDC for multi-region Astra DB Serverless (Vector) databases is available only to qualified participants in this private preview release. Development is ongoing, and the features and functionality are subject to change. This private preview is governed by your Agreement and the DataStax Preview Terms.

If you’re interested in this private preview feature, contact your DataStax account representative.

To enable CDC for Astra DB on a multi-region database, do the following:

  1. Complete the Prerequisites.

    CDC for multi-region databases is only available for Serverless (Vector) databases.

  2. Create one Astra Streaming tenant for each region where you want to enable CDC.

    If your database is deployed to a region that doesn’t support Astra Streaming, contact your DataStax account representative or DataStax Support.

  3. Create tables in your database, if you haven’t done so already.

  4. Use the Astra DevOps API to enable CDC on all applicable tables and regions.

  5. Connect a sink to transmit messages from all tenants to your sink service deployment.

Reconcile multi-region writes

For multi-region databases, you must reconcile concurrent messages transmitted by CDC to your sink service deployment.

Astra DB’s eventual consistency policy replicates changes to all regions of a multi-region database, regardless of the original region where the write occurred.

When you enable CDC on a multi-region database, CDC emits writes events for all CDC-enabled tables in all CDC-enabled regions, regardless of the original region. This means that all data- topics for the same table in all regional tenants eventually receive the same write events, and those topics pass concurrent, duplicate events for the same row to the sink.

Astra DB doesn’t reconcile concurrent modifications to the same row in multiple regions. Therefore, you are responsible for reconciling concurrent CDC messages transmitted to your sink service deployment.

To assist with reconciling messages, each CDC message contains the entire row, including the partition key and clustering keys, as well as an eventTime, which is the internal Cassandra timestamp for the mutation. You can use the primary key and timestamps to reconcile concurrent modifications to the same row in multiple regions.

However, be aware of the following limitations:

  • Cross-region writes can be received out of order or be missed.

  • Cross-region repairs don’t emit CDC events.

  • Ordering between regions isn’t guaranteed.

Check CDC status

You can check your active CDC configurations in the Astra Portal or with the Astra DevOps API.

  • Astra Portal

  • Astra DevOps API

  1. In the Astra Portal navigation menu, select a database.

  2. Click the CDC tab, and then review the list of tables where you have enabled CDC.

  3. Click a table’s name to inspect the table’s CDC configuration.

  • By database

  • By table

Use GET /v3/databases/DB_ID/cdc to get CDC configuration details for an entire database:

curl -sS -L -X GET "https://api.astra.datastax.com/v3/databases/DB_ID/cdc" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Accept: application/json"

Replace DB_ID with the database ID, and replace APPLICATION_TOKEN with an Astra DB application token.

The response includes an array of tables where CDC is enabled. For multi-region databases with CDC enabled in multiple regions, the regions array includes the Astra Streaming configuration for each region.

{
  "orgID": "8765-4321-10020012-1212",
  "databaseID": "1234-5678-90080012-2323",
  "databaseName": "test_db",
  "tables": [
    {
      "tableName": "table1",
      "keyspaceName": "default_keyspace"
    },
    {
      "tableName": "table2",
      "keyspaceName": "default_keyspace"
    },
    {
      "tableName": "table3",
      "keyspaceName": "other_keyspace"
    }
  ],
  "regions": [
    {
      "datacenterID": "1234-5678-90080012-2323-1",
      "datacenterRegion": "us-east1",
      "streamingClusterName": "pulsar-gcp-useast1-dev",
      "streamingTenantName": "cdc-streaming"
    }
  ]
}

Use GET /v3/databases/DB_ID/keyspaces/KEYSPACE_NAME/tables/TABLE_NAME/cdc to get CDC configuration details for a specific table:

curl -sS -L -X GET "https://api.astra.datastax.com/v3/databases/DB_ID/keyspaces/KEYSPACE_NAME/tables/TABLE_NAME/cdc" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Accept: application/json"

In the path, replace DB_ID with the database ID, and replace KEYSPACE_NAME and TABLE_NAME with the name of the keyspace and table where you want to check the CDC configuration. In the Authorization header, replace APPLICATION_TOKEN with an Astra DB application token.

The response includes the CDC status and, if available, the Astra Streaming configuration. For multi-region databases with CDC enabled in multiple regions, the regions array includes the Astra Streaming configuration for each region.

[
  {
    "orgID": "8765-4321-10020012-1212",
    "databaseID": "1234-5678-90080012-2323",
    "databaseName": "test_db",
    "regions": [
      {
        "datacenterID": "1234-5678-90080012-2323-1",
        "datacenterRegion": "us-east1",
        "streamingClusterName": "pulsar-gcp-useast1-dev",
        "streamingTenantName": "cdc-streaming"
      }
    ],
    "status": "Active"
  }
]

Disable CDC for a table

CDC is automatically disabled if you drop a table, terminate a database, or remove a CDC-enabled region from a multi-region database

You can use the Astra Portal or the Astra DevOps API to remove a table’s CDC configuration without deleting the table.

For multi-region databases, you cannot disable CDC for a single region. You can only disable CDC for an entire table across all regions.

Disabling CDC doesn’t remove the associated namespaces, topics, or Astra Streaming tenant.

  • Astra Portal

  • Astra DevOps API

  1. In the Astra Portal navigation menu, select the relevant database.

  2. Click the CDC tab.

  3. In the Change Data Capture list, click the table’s name.

  4. Click Disable to remove the table’s CDC configuration.

Use DELETE /v3/databases/DB_ID/cdc to disable CDC for a table:

curl -sS -L -X DELETE "https://api.astra.datastax.com/v3/databases/DB_ID/cdc" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Accept: application/json" \
--data '{
  "databaseID": "DB_ID",
  "tables": [
    {
      "tableName": "TABLE_NAME",
      "keyspaceName": "KEYSPACE_NAME"
    }
  ]
}'

Replace the following:

  • DB_ID: The database ID.

  • APPLICATION_TOKEN: An Astra DB application token.

  • TABLE_NAME and KEYSPACE_NAME: The name of table and keyspace where you want to disable CDC. If you want to disable CDC for multiple tables at once, include an object for each table in the tables array.

Disabling CDC doesn’t remove the associated namespace, topics, or Astra Streaming tenant.

If you reenable CDC for the same table, the existing topics are reused with the existing records.

If you want to discard a table’s CDC records, you must manually remove the associated Astra Streaming artifacts:

  • If you remove CDC from a table, then you can delete the table’s data- and log- topics from the astracdc namespace in the Astra Streaming tenant.

    For multi-region databases, make sure that you delete the topics in the tenant for each region where the database is deployed

  • If you remove CDC from all tables in a region, and you no longer need CDC in that region, then you can delete the astracdc namespace from the Astra Streaming tenant in that region.

    Deleting the namespace also deletes the topics within that namespace.

  • If you remove CDC from all tables and database, and you no longer need an Astra Streaming tenant for any reason, you can delete the entire tenant.

See also

Was this helpful?

Edit this page

Give Feedback

How can we improve the documentation?

© 2025 DataStax | Privacy policy | Terms of use | Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com