You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/developing/pages/astream-cdc.adoc
+11-25Lines changed: 11 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -265,7 +265,7 @@ Later, you will insert some rows to test your CDC connection and sink.
265
265
266
266
After you <<create-tenant,create a tenant>> and <<create-table,create tables>>, enable CDC on your tables.
267
267
268
-
For <<multi-region-cdc,multi-region databases>>, you must use the xref:astra-db-serverless:api-reference:devops-api.adoc[{astra} {devops-api}] to enable CDC in secondary regions.
268
+
You can use these options to enable single-region CDC and <<multi-region-cdc,multi-region CDC>>.
269
269
270
270
==== Enable CDC in the {astra-ui}
271
271
@@ -276,36 +276,22 @@ If you created the demo table in <<create-table>>, select the database where you
276
276
. Click the *CDC* tab, and then click *Enable CDC*.
277
277
278
278
. Select a tenant, keyspace, and table, and then click *Enable CDC*.
279
+
+
280
+
For multi-region databases, you must select a tenant for each region where you want to enable CDC.
279
281
280
282
. Refresh the page to get the updated list of CDC-enabled tables in this database.
281
283
282
284
. Repeat to enable CDC on additional tables.
283
285
284
-
[IMPORTANT]
285
-
====
286
-
Enabling CDC on any table disables the *Add a region* functionality in the {astra-ui} for that database.
287
-
You must use the {astra} {devops-api} to add a region after enabling CDC.
288
-
====
289
-
290
286
==== Enable CDC with the {astra} {devops-api}
291
287
292
-
[IMPORTANT]
293
-
====
294
-
CDC for multi-region {astra-db} {db-serverless-vector} databases is available only to qualified participants in this private preview release.
295
-
Development is ongoing, and the features and functionality are subject to change.
296
-
This private preview is governed by your Agreement and the https://www.ibm.com/docs/en/astra-streaming?topic=astra-streaming-annual-price-plans[{company} Preview Terms].
288
+
Use the xref:astra-db-serverless:api-reference:devops-api.adoc[{astra} {devops-api}] to enable CDC on one or more tables in the same database in the same request.
297
289
298
-
If you're interested in this private preview feature, contact your {company} account representative.
299
-
====
300
-
301
-
Use the {astra} {devops-api} to enable CDC on one or more tables in the same database in the same request.
302
-
303
-
You can use the following endpoints to enable CDC in single-region and multi-region databases.
304
290
To check the CDC configuration for a database or table, see <<get-cdc>>.
305
291
306
-
Enable CDC after deploying a region::
307
-
Use these steps to enable CDC in a single-region database or in previously-deployed regions of a multi-region database.
308
-
You can also use this configuration to enable CDC on new tables.
292
+
`/v3/databases/$DB_ID/cdc`::
293
+
Use the `/v3/databases/$DB_ID/cdc` endpoint to enable CDC on single-region and multi-region databases.
294
+
It supports initial CDC setup and extending CDC to new tables in databases where you enabled CDC previously.
309
295
+
310
296
. Use `{devops-api-ref-url}#tag/Database-Operations/operation/getCDC[GET /v3/databases/**DB_ID**/cdc]` to check the database's existing CDC configuration:
311
297
+
@@ -374,11 +360,11 @@ For multi-region databases, only include regions where you want to enable CDC.
374
360
** `**DATACENTER_REGION**`: The name of the region where the database and {product} tenant are deployed, such as `us-east1`.
375
361
You can only enable CDC in xref:operations:astream-regions.adoc[regions that support {product}].
376
362
** `**STREAMING_CLUSTER_NAME**` and `**STREAMING_TENANT_NAME**`: The name of your {product} tenant and cluster.
377
-
Tenant must be deployed to the same region as the database.
363
+
The tenant must be deployed to the same region as the database.
378
364
You can get these names with the xref:apis:index.adoc#astra-streaming-devops-api-tenant-operations[{product} {devops-api}] or from the **{product}** dashboard in the {astra-ui} (click icon:grip[name="Applications"], and then select *Streaming*).
379
365
380
-
Deploy a secondary region with CDC enabled::
381
-
Use `{devops-api-ref-url}#tag/Database-Operations/operation/addDatacenters[POST /v2/databases/**DB_ID**/datacenters]` to add a region to a multi-region database and enable CDC in the same command:
366
+
`/v2/databases/$DB_ID/datacenters`::
367
+
Use `{devops-api-ref-url}#tag/Database-Operations/operation/addDatacenters[POST /v2/databases/**DB_ID**/datacenters]` to add a region to a multi-region database _and_ enable CDC in the same command:
382
368
+
383
369
[source,curl,subs="+quotes"]
384
370
----
@@ -743,7 +729,7 @@ If your database is deployed to a region that doesn't support {product}, contact
743
729
744
730
. <<create-table,Create tables>> in your database, if you haven't done so already.
745
731
746
-
. Use the {astra} {devops-api} to <<enable-cdc-on-a-table,enable CDC on all applicable tables and regions>>.
732
+
. <<enable-cdc-on-a-table,Enable CDC on all applicable tables and regions>>.
747
733
748
734
. <<connect-a-sink,Connect a sink>> to transmit messages from all tenants to your sink service deployment.
0 commit comments