Changefeed Examples

On this page

This page provides step-by-step examples for using Basic and Enterprise changefeeds. Creating Enterprise changefeeds is available on CockroachDB Standard, Advanced, Basic, and with an Enterprise license on CockroachDB self-hosted clusters. Basic changefeeds are available in all products.

For a comparative summary of all Core and Enterprise changefeed features, refer to the Change Data Capture Overview page.

Note:

Cockroach Labs recommends monitoring your changefeeds to track retryable errors and protected timestamp usage. Refer to the Monitor and Debug Changefeeds page for more information.

Use the following filters to show usage examples for either Enterprise or Core changefeeds:

You can connect to the following sinks:

Kafka
Google Cloud Pub/Sub
Cloud Storage (Amazon S3, Google Cloud Storage, Azure Storage)
Webhook

Refer to the Changefeed Sinks page for more detail on forming sink URIs, available sink query parameters, and specifics on configuration.

You can set up a changefeed that uses change data capture queries to filter change data from messages.

Tip:

You can create an external connection to represent a changefeed sink URI. This allows you to specify the external connection's name in statements rather than the provider-specific URI. For detail on using external connections, see the CREATE EXTERNAL CONNECTION page.

Create a changefeed connected to Kafka

In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink. The changefeed will watch two tables.

If you do not already have one, request a trial Enterprise license.
Use the cockroach start-single-node command to start a single-node cluster:
```
cockroach start-single-node --insecure --listen-addr=localhost
```
Download and extract the Confluent Open Source platform (which includes Kafka).
In a new terminal window, go to the extracted confluent-<version> directory and start Confluent:
```
./bin/confluent local services start
```
Only zookeeper and kafka are needed. To troubleshoot Confluent, see their docs and the Quick Start Guide.
Create two Kafka topics:
```
./bin/kafka-topics \
--create \
--zookeeper localhost:2181 \
--replication-factor 1 \
--partitions 1 \
--topic office_dogs
```
```
./bin/kafka-topics \
--create \
--zookeeper localhost:2181 \
--replication-factor 1 \
--partitions 1 \
--topic employees
```
Note:

You are expected to create any Kafka topics with the necessary number of replications and partitions. Topics can be created manually or Kafka brokers can be configured to automatically create topics with a default partition count and replication factor.
As the root user, open the built-in SQL client:
```
$ cockroach sql --insecure
```
Set your organization name and Enterprise license key:
```
> SET CLUSTER SETTING cluster.organization = '<organization name>';
```
```
> SET CLUSTER SETTING enterprise.license = '<secret>';
```
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Note:

If you are working on a CockroachDB Standard or Basic cluster, the kv.rangefeed.enabled cluster setting is enabled by default.
Create a database called cdc_demo:
```
> CREATE DATABASE cdc_demo;
```
Set the database as the default:
```
> SET DATABASE = cdc_demo;
```

Create a table and add data:

> CREATE TABLE office_dogs (
     id INT PRIMARY KEY,
     name STRING);

> INSERT INTO office_dogs VALUES
   (1, 'Petee'),
   (2, 'Carl');

> UPDATE office_dogs SET name = 'Petee H' WHERE id = 1;

Create another table and add data:

> CREATE TABLE employees (
     dog_id INT REFERENCES office_dogs (id),
     employee_name STRING);

> INSERT INTO employees VALUES
   (1, 'Lauren'),
   (2, 'Spencer');

Start the changefeed:

CREATE CHANGEFEED FOR TABLE office_dogs, employees INTO 'kafka://localhost:9092';


        job_id
+--------------------+
  360645287206223873
(1 row)

NOTICE: changefeed will emit to topic office_dogs
NOTICE: changefeed will emit to topic employees

This will start up the changefeed in the background and return the job_id. The changefeed writes to Kafka.

In a new terminal, move into the extracted confluent-<version> directory and start watching the Kafka topics:
```
./bin/kafka-console-consumer \
--bootstrap-server=localhost:9092 \
--from-beginning \
--include 'office_dogs|employees'
```
```
{"after": {"id": 1, "name": "Petee H"}}
{"after": {"id": 2, "name": "Carl"}}
{"after": {"id": 1, "name": "Lauren", "rowid": 528514320239329281}}
{"after": {"id": 2, "name": "Spencer", "rowid": 528514320239362049}}
```
The initial scan displays the state of the tables as of when the changefeed started (therefore, the initial value of "Petee" is omitted).

Note:

This example only prints the value. To print both the key and value of each message in the changefeed (e.g., to observe what happens with DELETEs), use the --property print.key=true flag.
Back in the SQL client, insert more data:
```
INSERT INTO office_dogs VALUES (3, 'Ernie');
```
Back in the terminal where you're watching the Kafka topics, the following output has appeared:
```
{"after": {"id": 3, "name": "Ernie"}}
```
When you are done, exit the SQL shell (\q).

To stop cockroach:

Get the process ID of the node:

ps -ef | grep cockroach | grep -v grep

  501 21766     1   0  6:21PM ttys001    0:00.89 cockroach start-single-node --insecure --listen-addr=localhost

Gracefully shut down the node, specifying its process ID:

kill -TERM 21766

initiating graceful shutdown of server
server drained and shutdown completed

To stop Kafka, move into the extracted confluent-<version> directory and stop Confluent:
```
./bin/confluent local services stop
```

Create a changefeed connected to Kafka using Avro

In this example, you'll set up a changefeed for a single-node cluster that is connected to a Kafka sink and emits Avro records. The changefeed will watch two tables.

If you do not already have one, request a trial Enterprise license.
Use the cockroach start-single-node command to start a single-node cluster:
```
cockroach start-single-node --insecure --listen-addr=localhost
```
Download and extract the Confluent Open Source platform (which includes Kafka).
Move into the extracted confluent-<version> directory and start Confluent:
```
./bin/confluent local services start
```
Only zookeeper, kafka, and schema-registry are needed. To troubleshoot Confluent, see their docs and the Quick Start Guide.
Create two Kafka topics:
```
./bin/kafka-topics \
--create \
--zookeeper localhost:2181 \
--replication-factor 1 \
--partitions 1 \
--topic office_dogs
```
```
./bin/kafka-topics \
--create \
--zookeeper localhost:2181 \
--replication-factor 1 \
--partitions 1 \
--topic employees
```
Note:

You are expected to create any Kafka topics with the necessary number of replications and partitions. Topics can be created manually or Kafka brokers can be configured to automatically create topics with a default partition count and replication factor.
As the root user, open the built-in SQL client:
```
$ cockroach sql --insecure
```
Set your organization name and Enterprise license key:
```
> SET CLUSTER SETTING cluster.organization = '<organization name>';
```
```
> SET CLUSTER SETTING enterprise.license = '<secret>';
```
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Note:

If you are working on a CockroachDB Standard or Basic cluster, the kv.rangefeed.enabled cluster setting is enabled by default.
Create a database called cdc_demo:
```
> CREATE DATABASE cdc_demo;
```
Set the database as the default:
```
> SET DATABASE = cdc_demo;
```

Create a table and add data:

> CREATE TABLE office_dogs (
     id INT PRIMARY KEY,
     name STRING);

> INSERT INTO office_dogs VALUES
   (1, 'Petee'),
   (2, 'Carl');

> UPDATE office_dogs SET name = 'Petee H' WHERE id = 1;

Create another table and add data:

> CREATE TABLE employees (
     dog_id INT REFERENCES office_dogs (id),
     employee_name STRING);

> INSERT INTO employees VALUES
   (1, 'Lauren'),
   (2, 'Spencer');

Start the changefeed:
```
CREATE CHANGEFEED FOR TABLE office_dogs, employees INTO 'kafka://localhost:9092' WITH format = avro, confluent_schema_registry = 'http://localhost:8081';
```
To connect to Confluent Cloud, use the following URL structure: 'https://{API_KEY_ID}:{API_SECRET_URL_ENCODED}@{CONFLUENT_REGISTRY_URL}:443'. See the Stream a Changefeed to a Confluent Cloud Kafka Cluster tutorial for further detail.
```
        job_id
+--------------------+
  360645287206223873
(1 row)

NOTICE: changefeed will emit to topic office_dogs
NOTICE: changefeed will emit to topic employees
```
This will start up the changefeed in the background and return the job_id. The changefeed writes to Kafka.

In a new terminal, move into the extracted confluent-<version> directory and start watching the Kafka topics:

./bin/kafka-avro-console-consumer \
--bootstrap-server=localhost:9092 \
--from-beginning \
--include 'office_dogs|employees'

{"after":{"office_dogs":{"id":{"long":1},"name":{"string":"Petee H"}}}}
{"after":{"office_dogs":{"id":{"long":2},"name":{"string":"Carl"}}}}
{"after":{"employees":{"dog_id":{"long":1},"employee_name":{"string":"Lauren"},"rowid":{"long":528537452042682369}}}}
{"after":{"employees":{"dog_id":{"long":2},"employee_name":{"string":"Spencer"},"rowid":{"long":528537452042747905}}}}

The initial scan displays the state of the table as of when the changefeed started (therefore, the initial value of "Petee" is omitted).

Note:

This example only prints the value. To print both the key and value of each message in the changefeed (e.g., to observe what happens with DELETEs), use the --property print.key=true flag.

Back in the SQL client, insert more data:
```
INSERT INTO office_dogs VALUES (3, 'Ernie');
```
Back in the terminal where you're watching the Kafka topics, the following output has appeared:
```
{"after":{"office_dogs":{"id":{"long":3},"name":{"string":"Ernie"}}}}
```
When you are done, exit the SQL shell (\q).

To stop cockroach:

Get the process ID of the node:

ps -ef | grep cockroach | grep -v grep

  501 21766     1   0  6:21PM ttys001    0:00.89 cockroach start-single-node --insecure --listen-addr=localhost

Gracefully shut down the node, specifying its process ID:

kill -TERM 21766

initiating graceful shutdown of server
server drained and shutdown completed

To stop Kafka, move into the extracted confluent-<version> directory and stop Confluent:
```
./bin/confluent local services stop
```

Create a changefeed connected to a Google Cloud Pub/Sub sink

Note:

This feature is in preview. This feature is subject to change. To share feedback and/or issues, contact Support.

Note:

New in v23.1: Enable the changefeed.new_pubsub_sink_enabled cluster setting to improve the throughput of changefeeds emitting to Pub/Sub sinks. Enabling this setting also alters the message format to use capitalized top-level fields in changefeeds emitting JSON-encoded messages to a Pub/Sub sink. For more details, refer to the Pub/Sub sink messages section.

In this example, you'll set up a changefeed for a single-node cluster that is connected to a Google Cloud Pub/Sub sink. The changefeed will watch a table and send messages to the sink.

You'll need access to a Google Cloud Project to set up a Pub/Sub sink. In this example, the Google Cloud CLI (gcloud) is used, but you can also complete each of these steps within your Google Cloud Console.

If you do not already have one, request a trial Enterprise license.
Use the cockroach start-single-node command to start a single-node cluster:
```
cockroach start-single-node --insecure --listen-addr=localhost
```
In this example, you'll run CockroachDB's Movr application workload to set up some data for your changefeed.

First create the schema for the workload:
```
 cockroach workload init movr "postgresql://root@127.0.0.1:26257?sslmode=disable"
```
Then run the workload:
```
 cockroach workload run movr --duration=1m "postgresql://root@127.0.0.1:26257?sslmode=disable"
```
As the root user, open the built-in SQL client:
```
$ cockroach sql --insecure
```
Set your organization name and Enterprise license key:
```
> SET CLUSTER SETTING cluster.organization = '<organization name>';
```
```
> SET CLUSTER SETTING enterprise.license = '<secret>';
```
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Note:

If you are working on a CockroachDB Standard or Basic cluster, the kv.rangefeed.enabled cluster setting is enabled by default.
Next, you'll prepare your Pub/Sub sink.

In a new terminal window, create a Service Account attached to your Google Project:
```
gcloud iam service-accounts create cdc-demo --project cockroach-project
```
In this example, cdc-demo will represent the name of the service account, and cockroach-project is the name of the Google Project.

To ensure that your Service Account has the correct permissions to publish to the sink, use the following command to give the Service Account the predefined Pub/Sub Editor role:
```
gcloud projects add-iam-policy-binding cockroach-project --member='serviceAccount:cdc-demo@cockroach-project.iam.gserviceaccount.com' --role='roles/pubsub.editor'
```
Create the Pub/Sub topic to which your changefeed will emit messages:
```
gcloud pubsub topics create movr-users --project cockroach-project
```
Run the following command to create a subscription within the movr-users topic:
```
gcloud pubsub subscriptions create movr-users-sub --topic=movr-users --topic-project=cockroach-project
```
With the topic and subscription set up, you can now download your Service Account credentials. Use the gcloud iam service-accounts keys create command to specify where to download the JSON credential file (credentials.json):
```
gcloud iam service-accounts keys create credentials.json --iam-account=cdc-demo@cockroach-project.iam.gserviceaccount.com
```
Next, base64 encode the file that contains the entire JSON credential object using the command specific to your platform.

If you're working on macOS:
```
cat credentials.json | base64
```
If you're working on Linux, run the following to ensure that lines are not wrapped in the output:
```
cat credentials.json | base64 -w 0
```
Copy the output so that you can add it to your CREATE CHANGEFEED statement in the next step. When you create your changefeed, it is necessary that the credentials are base64 encoded before passing it in the URI.

Back in the SQL shell, create a changefeed that will emit messages to your Pub/Sub topic. Ensure that you have base64 encoded the entire credentials JSON object for your Service Account and then run:

CREATE CHANGEFEED FOR TABLE users INTO 'gcpubsub://cockroach-project?region=us-east1&topic_name=movr-users&AUTH=specified&CREDENTIALS={base64-encoded credentials}';

You can include the region parameter for your topic, or use the WITH unordered option for multi-region Pub/Sub. See the Changefeed Sinks page for more detail.

The output will confirm the topic where the changefeed will emit messages to.

       job_id
----------------------
756641304964792321
(1 row)

NOTICE: changefeed will emit to topic movr-users

To view all the messages delivered to your topic, you can use:

The Google Cloud Console. From the Pub/Sub menu, select Subscriptions in the left-hand navigation and then select the subscription ID from your list of subscriptions. On the subscription's overview, click Messages, and then Pull to view messages.

The gcloud CLI. From your terminal, run the following command:

gcloud pubsub subscriptions pull movr-users-sub --auto-ack --limit=10

This command will only pull these messages once per subscription. For example, if you ran this command again you would receive 10 different messages in your output. To receive more than one message at a time, pass the --limit flag. For more details, refer to the gcloud pubsub subscriptions pull documentation.

If you have enabled the changefeed.new_pubsub_sink_enabled cluster setting, the output will contain capitalized top-level fields:

┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬───────────────────┬──────────────┬────────────┬──────────────────┬────────────┐
│                                                                                                                                     DATA                                                                                                                                    │     MESSAGE_ID    │ ORDERING_KEY │ ATTRIBUTES │ DELIVERY_ATTEMPT │ ACK_STATUS │
├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────┼──────────────┼────────────┼──────────────────┼────────────┤
│ {"Key":["amsterdam", "09ee2856-5856-40c4-85d3-7d65bed978f0"],"Value":{"after": {"address": "84579 Peter Divide Apt. 47", "city": "amsterdam", "credit_card": "0100007510", "id": "09ee2856-5856-40c4-85d3-7d65bed978f0", "name": "Timothy Jackson"}},"Topic":"movr-users"}       │ 11249015757941393 │              │            │                  │ SUCCESS    │
│ {"Key":["new york", "8803ab9e-5001-4994-a2e6-68d587f95f1d"],"Value":{"after": {"address": "37546 Andrew Roads Apt. 68", "city": "new york", "credit_card": "4731676650", "id": "8803ab9e-5001-4994-a2e6-68d587f95f1d", "name": "Susan Harrington"}},"Topic":"movr-users"}        │ 11249015757941394 │              │            │                  │ SUCCESS    │
│ {"Key":["seattle", "32e27201-ca0d-4a0c-ada2-fbf47f6a4711"],"Value":{"after": {"address": "86725 Stephen Gardens", "city": "seattle", "credit_card": "3639690115", "id": "32e27201-ca0d-4a0c-ada2-fbf47f6a4711", "name": "Brad Hill"}},"Topic":"movr-users"}                      │ 11249015757941395 │              │            │                  │ SUCCESS    │
...

If you have not enabled changefeed.new_pubsub_sink_enabled, the output will contain lowercase top-level fields:

┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬──────────────────┬─────────────────────────────────────────────────────────┬────────────┬──────────────────┐
│                                                                                                                                 DATA                                                                                                                                 │    MESSAGE_ID    │                       ORDERING_KEY                      │ ATTRIBUTES │ DELIVERY_ATTEMPT │
├──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────┼─────────────────────────────────────────────────────────┼────────────┼──────────────────┤
│ {"key":["boston","40ef7cfa-5e16-4bd3-9e14-2f23407a66df"],"value":{"after":{"address":"14980 Gentry Plains Apt. 64","city":"boston","credit_card":"2466765790","id":"40ef7cfa-5e16-4bd3-9e14-2f23407a66df","name":"Vickie Fitzpatrick"}},"topic":"movr-users"}         │ 4466153049158588 │ ["boston", "40ef7cfa-5e16-4bd3-9e14-2f23407a66df"]      │            │                  │
│ {"key":["los angeles","947ae147-ae14-4800-8000-00000000001d"],"value":{"after":{"address":"35627 Chelsey Tunnel Suite 94","city":"los angeles","credit_card":"2099932769","id":"947ae147-ae14-4800-8000-00000000001d","name":"Kenneth Barnes"}},"topic":"movr-users"} │ 4466144577818136 │ ["los angeles", "947ae147-ae14-4800-8000-00000000001d"] │            │                  │
│ {"key":["amsterdam","c28f5c28-f5c2-4000-8000-000000000026"],"value":{"after":{"address":"14729 Karen Radial","city":"amsterdam","credit_card":"5844236997","id":"c28f5c28-f5c2-4000-8000-000000000026","name":"Maria Weber"}},"topic":"movr-users"}                   │ 4466151194002912 │ ["amsterdam", "c28f5c28-f5c2-4000-8000-000000000026"]   │            │                  │
...

For more detail on the changefeed.new_pubsub_sink_enabled cluster setting, refer to Pub/Sub sink messages.

Create a changefeed connected to a cloud storage sink

In this example, you'll set up a changefeed for a single-node cluster that is connected to an AWS S3 sink. The changefeed watches two tables. Note that you can set up changefeeds for any of these cloud storage providers.

If you do not already have one, request a trial Enterprise license.
Use the cockroach start-single-node command to start a single-node cluster:
```
$ cockroach start-single-node --insecure --listen-addr=localhost
```
As the root user, open the built-in SQL client:
```
$ cockroach sql --insecure
```
Set your organization name and Enterprise license key:
```
> SET CLUSTER SETTING cluster.organization = '<organization name>';
```
```
> SET CLUSTER SETTING enterprise.license = '<secret>';
```
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Note:

If you are working on a CockroachDB Standard or Basic cluster, the kv.rangefeed.enabled cluster setting is enabled by default.
Create a database called cdc_demo:
```
> CREATE DATABASE cdc_demo;
```
Set the database as the default:
```
> SET DATABASE = cdc_demo;
```

Create a table and add data:

> CREATE TABLE office_dogs (
     id INT PRIMARY KEY,
     name STRING);

> INSERT INTO office_dogs VALUES
   (1, 'Petee'),
   (2, 'Carl');

> UPDATE office_dogs SET name = 'Petee H' WHERE id = 1;

Create another table and add data:

> CREATE TABLE employees (
     dog_id INT REFERENCES office_dogs (id),
     employee_name STRING);

> INSERT INTO employees VALUES
   (1, 'Lauren'),
   (2, 'Spencer');

Start the changefeed:

> CREATE CHANGEFEED FOR TABLE office_dogs, employees INTO 's3://example-bucket-name/test?AWS_ACCESS_KEY_ID=enter_key-here&AWS_SECRET_ACCESS_KEY=enter_key_here' with updated, resolved='10s';

        job_id
+--------------------+
  360645287206223873
(1 row)

This will start up the changefeed in the background and return the job_id. The changefeed writes to AWS.

Monitor your changefeed on the DB Console. For more information, see Changefeeds Dashboard.
When you are done, exit the SQL shell (\q).

To stop cockroach:

Get the process ID of the node:

ps -ef | grep cockroach | grep -v grep

  501 21766     1   0  6:21PM ttys001    0:00.89 cockroach start-single-node --insecure --listen-addr=localhost

Gracefully shut down the node, specifying its process ID:

kill -TERM 21766

initiating graceful shutdown of server
server drained and shutdown completed

Create a changefeed connected to a webhook sink

Note:

New in v23.1: Enable the changefeed.new_webhook_sink_enabled cluster setting to improve the throughput of changefeeds emitting to webhook sinks.

In this example, you'll set up a changefeed for a single-node cluster that is connected to a local HTTP server via a webhook. For this example, you'll use an example HTTP server to test out the webhook sink.

If you do not already have one, request a trial Enterprise license.
Use the cockroach start-single-node command to start a single-node cluster:
```
$ cockroach start-single-node --insecure --listen-addr=localhost
```
In this example, you'll run CockroachDB's Movr application workload to set up some data for your changefeed.

First create the schema for the workload:
```
 cockroach workload init movr "postgresql://root@127.0.0.1:26257?sslmode=disable"
```
Then run the workload:
```
 cockroach workload run movr --duration=1m "postgresql://root@127.0.0.1:26257?sslmode=disable"
```
As the root user, open the built-in SQL client:
```
$ cockroach sql --insecure
```
Set your organization name and Enterprise license key:
```
> SET CLUSTER SETTING cluster.organization = '<organization name>';
```
```
> SET CLUSTER SETTING enterprise.license = '<secret>';
```
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Note:

If you are working on a CockroachDB Standard or Basic cluster, the kv.rangefeed.enabled cluster setting is enabled by default.
In a separate terminal window, set up your HTTP server. Clone the test repository:
```
git clone https://github.com/cockroachlabs/cdc-webhook-sink-test-server.git
```
```
cd cdc-webhook-sink-test-server/go-https-server
```
Next make the script executable and then run the server (passing a specific port if preferred, otherwise it will default to :3000):
```
chmod +x ./server.sh
```
```
./server.sh <port>
```

Back in your SQL shell, run the following statement to create a changefeed that emits to your webhook sink:

CREATE CHANGEFEED FOR TABLE movr.vehicles INTO 'webhook-https://localhost:3000?insecure_tls_skip_verify=true' WITH updated;

You set up a changefeed on the vehicles table, which emits changefeed messages to the local HTTP server.

See the options table for more information on the options available for creating your changefeed to a webhook sink.

      job_id
----------------------
687842491801632769
(1 row)

In the terminal where your HTTP server is running, you'll receive output similar to:

2021/08/24 14:00:21 {"payload":[{"after":{"city":"rome","creation_time":"2019-01-02T03:04:05","current_location":"39141 Travis Curve Suite 87","ext":{"brand":"Schwinn","color":"red"},"id":"d7b18299-c0c4-4304-9ef7-05ae46fd5ee1","dog_owner_id":"5d0c85b5-8866-47cf-a6bc-d032f198e48f","status":"in_use","type":"bike"},"key":["rome","d7b18299-c0c4-4304-9ef7-05ae46fd5ee1"],"topic":"vehicles","updated":"1629813621680097993.0000000000"}],"length":1}
2021/08/24 14:00:22 {"payload":[{"after":{"city":"san francisco","creation_time":"2019-01-02T03:04:05","current_location":"84888 Wallace Wall","ext":{"color":"black"},"id":"020cf7f4-6324-48a0-9f74-6c9010fb1ab4","dog_owner_id":"b74ea421-fcaf-4d80-9dcc-d222d49bdc17","status":"available","type":"scooter"},"key":["san francisco","020cf7f4-6324-48a0-9f74-6c9010fb1ab4"],"topic":"vehicles","updated":"1629813621680097993.0000000000"}],"length":1}
2021/08/24 14:00:22 {"payload":[{"after":{"city":"san francisco","creation_time":"2019-01-02T03:04:05","current_location":"3893 Dunn Fall Apt. 11","ext":{"color":"black"},"id":"21b2ec54-81ad-4af7-a76d-6087b9c7f0f8","dog_owner_id":"8924c3af-ea6e-4e7e-b2c8-2e318f973393","status":"lost","type":"scooter"},"key":["san francisco","21b2ec54-81ad-4af7-a76d-6087b9c7f0f8"],"topic":"vehicles","updated":"1629813621680097993.0000000000"}],"length":1}

For more detail on emitted changefeed messages, see responses.

Create a changefeed using change data capture queries

In this example, you will create a changefeed that filters the change data using change data capture queries before emitting to the sink. This example will use a cloud storage sink, however CDC queries are supported by each sink and sinkless changefeeds with an Enterprise license.

For different use case examples and syntax detail, refer to the Change Data Capture Queries page.

If you do not already have one, request a trial Enterprise license.
Use the cockroach start-single-node command to start a single-node cluster:
```
cockroach start-single-node --insecure --listen-addr=localhost
```
In this example, you'll run CockroachDB's MovR application workload to set up some data for your changefeed.

Create the schema for the workload:
```
cockroach workload init movr
```
Run the workload:
```
cockroach workload run movr --duration=1m
```
As the root user, open the built-in SQL client:
```
$ cockroach sql --insecure
```
Set your organization name and Enterprise license key:
```
> SET CLUSTER SETTING cluster.organization = '<organization name>';
```
```
> SET CLUSTER SETTING enterprise.license = '<secret>';
```
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Note:

If you are working on a CockroachDB Standard or Basic cluster, the kv.rangefeed.enabled cluster setting is enabled by default.

Set up an external connection for your cloud storage sink:

CREATE EXTERNAL CONNECTION cloud_storage AS 's3://example-bucket-name/test?AWS_ACCESS_KEY_ID={AWS access key}&AWS_SECRET_ACCESS_KEY={AWS secret key}';

Create a changefeed on the vehicles table that will only emit messages for those vehicles with a specific status:

CREATE CHANGEFEED INTO 'external://cloud_storage' WITH resolved AS SELECT type, owner_id, current_location FROM vehicles WHERE status = 'lost';

You will receive message files in your cloud storage for any vehicles that are lost:

{"current_location": "23803 Phillip Shores Apt. 75", "owner_id": "90f3670a-3f69-4a0f-bf0e-72279438cf48", "type": "scooter"}
{"current_location": "59764 Moran Plains", "owner_id": "bd70a3d7-0a3d-4000-8000-000000000025", "type": "scooter"}

You will also find resolved timestamp files in your cloud storage representing that there are no previously unseen rows before this timestamp.

When you are done, exit the SQL shell (\q).

To stop cockroach:

Get the process ID of the node:

ps -ef | grep cockroach | grep -v grep

501 21766     1   0  6:21PM ttys001    0:00.89 cockroach start-single-node --insecure --listen-addr=localhost

Gracefully shut down the node, specifying its process ID:

kill -TERM 21766

initiating graceful shutdown of server
server drained and shutdown completed

Basic changefeeds stream row-level changes to a client until the underlying SQL connection is closed. Core changefeeds are available in all products.

Create a basic changefeed

In this example, you'll set up a basic changefeed for a single-node cluster.

In a terminal window, start cockroach:

$ cockroach start-single-node \
--insecure \
--listen-addr=localhost \
--background

As the root user, open the built-in SQL client:
```
$ cockroach sql \
--url="postgresql://root@127.0.0.1:26257?sslmode=disable" \
--format=csv
```
Note:

Because basic changefeeds return results differently than other SQL statements, they require a dedicated database connection with specific settings around result buffering. In normal operation, CockroachDB improves performance by buffering results server-side before returning them to a client; however, result buffering is automatically turned off for basic changefeeds. Basic changefeeds also have different cancellation behavior than other queries: they can only be canceled by closing the underlying connection or issuing a CANCEL QUERY statement on a separate connection. Combined, these attributes of changefeeds mean that applications should explicitly create dedicated connections to consume changefeed data, instead of using a connection pool as most client drivers do by default.

Note:

To determine how wide the columns need to be, the default table display format in cockroach sql buffers the results it receives from the server before printing them to the console. When consuming basic changefeed data using cockroach sql, it's important to use a display format like csv that does not buffer its results. To set the display format, use the --format=csv flag when starting the built-in SQL client, or set the \set display_format=csv option once the SQL client is open.
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Create table foo:
```
> CREATE TABLE foo (a INT PRIMARY KEY);
```
Insert a row into the table:
```
> INSERT INTO foo VALUES (0);
```

Start the basic changefeed:

> EXPERIMENTAL CHANGEFEED FOR foo;

table,key,value
foo,[0],"{""after"": {""a"": 0}}"

In a new terminal, add another row:
```
$ cockroach sql --insecure -e "INSERT INTO foo VALUES (1)"
```
Back in the terminal where the basic changefeed is streaming, the following output has appeared:
```
foo,[1],"{""after"": {""a"": 1}}"
```
Note that records may take a couple of seconds to display in the basic changefeed.
To stop streaming the changefeed, enter CTRL+C into the terminal where the changefeed is running.

To stop cockroach:

Get the process ID of the node:

ps -ef | grep cockroach | grep -v grep

  501 21766     1   0  6:21PM ttys001    0:00.89 cockroach start-single-node --insecure --listen-addr=localhost

Gracefully shut down the node, specifying its process ID:

kill -TERM 21766

initiating graceful shutdown of server
server drained and shutdown completed

Create a basic changefeed using Avro

In this example, you'll set up a basic changefeed for a single-node cluster that emits Avro records. CockroachDB's Avro binary encoding convention uses the Confluent Schema Registry to store Avro schemas.

Use the cockroach start-single-node command to start a single-node cluster:
```
$ cockroach start-single-node \
--insecure \
--listen-addr=localhost \
--background
```
Download and extract the Confluent Open Source platform.
Move into the extracted confluent-<version> directory and start Confluent:
```
$ ./bin/confluent local services start
```
Only zookeeper, kafka, and schema-registry are needed. To troubleshoot Confluent, see their docs and the Quick Start Guide.
As the root user, open the built-in SQL client:
```
$ cockroach sql --url="postgresql://root@127.0.0.1:26257?sslmode=disable" --format=csv
```
Note:

Because basic changefeeds return results differently than other SQL statements, they require a dedicated database connection with specific settings around result buffering. In normal operation, CockroachDB improves performance by buffering results server-side before returning them to a client; however, result buffering is automatically turned off for basic changefeeds. Basic changefeeds also have different cancellation behavior than other queries: they can only be canceled by closing the underlying connection or issuing a CANCEL QUERY statement on a separate connection. Combined, these attributes of changefeeds mean that applications should explicitly create dedicated connections to consume changefeed data, instead of using a connection pool as most client drivers do by default.

Note:

To determine how wide the columns need to be, the default table display format in cockroach sql buffers the results it receives from the server before printing them to the console. When consuming basic changefeed data using cockroach sql, it's important to use a display format like csv that does not buffer its results. To set the display format, use the --format=csv flag when starting the built-in SQL client, or set the \set display_format=csv option once the SQL client is open.
Enable the kv.rangefeed.enabled cluster setting:
```
> SET CLUSTER SETTING kv.rangefeed.enabled = true;
```
Create table bar:
```
> CREATE TABLE bar (a INT PRIMARY KEY);
```
Insert a row into the table:
```
> INSERT INTO bar VALUES (0);
```

Start the basic changefeed:

> EXPERIMENTAL CHANGEFEED FOR bar WITH format = avro, confluent_schema_registry = 'http://localhost:8081';

table,key,value
bar,\000\000\000\000\001\002\000,\000\000\000\000\002\002\002\000

In a new terminal, add another row:
```
$ cockroach sql --insecure -e "INSERT INTO bar VALUES (1)"
```
Back in the terminal where the basic changefeed is streaming, the output will appear:
```
bar,\000\000\000\000\001\002\002,\000\000\000\000\002\002\002\002
```
Note that records may take a couple of seconds to display in the basic changefeed.
To stop streaming the changefeed, enter CTRL+C into the terminal where the changefeed is running.

To stop cockroach:

Get the process ID of the node:

ps -ef | grep cockroach | grep -v grep

  501 21766     1   0  6:21PM ttys001    0:00.89 cockroach start-single-node --insecure --listen-addr=localhost

Gracefully shut down the node, specifying its process ID:

kill -TERM 21766

initiating graceful shutdown of server
server drained and shutdown completed

To stop Confluent, move into the extracted confluent-<version> directory and stop Confluent:
```
$ ./bin/confluent local services stop
```
To terminate all Confluent processes, use:
```
$ ./bin/confluent local destroy
```

For further information on basic changefeeds, see EXPERIMENTAL CHANGEFEED FOR.

Pricing

Contact us

Sign In

Changefeed Examples

Create a changefeed connected to Kafka

Create a changefeed connected to Kafka using Avro

Create a changefeed connected to a Google Cloud Pub/Sub sink

Create a changefeed connected to a cloud storage sink

Create a changefeed connected to a webhook sink

Create a changefeed using change data capture queries

Create a basic changefeed

Create a basic changefeed using Avro

See also