Skip to content

WIP Create new Message Envelope page with new 25.2 features #19542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

WIP Create new Message Envelope page with new 25.2 features #19542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 132 additions & 120 deletions src/current/_includes/v25.2/sidebar-data/stream-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,156 +1,168 @@
{
"title": "Stream Data",
"is_top_level": true,
"items": [
{
"title": "Change Data Capture Overview",
"urls": [
"/${VERSION}/change-data-capture-overview.html"
]
},
{
"title": "Get Started with Changefeeds",
"items": [
{
"title": "Create and Configure Changefeeds",
"urls": [
"/${VERSION}/create-and-configure-changefeeds.html"
]
},
{
"title": "Changefeed Best Practices",
"urls": [
"/${VERSION}/changefeed-best-practices.html"
]
},
{
"title": "Changefeed Messages",
"urls": [
"/${VERSION}/changefeed-messages.html"
]
},
{
"title": "Changefeed Sinks",
"urls": [
"/${VERSION}/changefeed-sinks.html"
]
},
{
"title": "Changefeed Examples",
"urls": [
"/${VERSION}/changefeed-examples.html"
]
}
]
},
{
"title": "Monitor Changefeeds",
"items": [
{
"title": "Overview",
"title": "Stream Data",
"is_top_level": true,
"items": [
{
"title": "Change Data Capture Overview",
"urls": [
"/${VERSION}/change-data-capture-overview.html"
]
},
{
"title": "Get Started with Changefeeds",
"items": [
{
"title": "Create and Configure Changefeeds",
"urls": [
"/${VERSION}/monitor-and-debug-changefeeds.html"
"/${VERSION}/create-and-configure-changefeeds.html"
]
},
{
"title": "Monitoring Guide",
},
{
"title": "Changefeed Best Practices",
"urls": [
"/${VERSION}/changefeed-monitoring-guide.html"
"/${VERSION}/changefeed-best-practices.html"
]
},
{
"title": "Protect Changefeed Data",
"urls": [
"/${VERSION}/protect-changefeed-data.html"
},
{
"title": "Changefeed Messages",
"items": [
{
"title": "Overview",
"urls": [
"/${VERSION}/changefeed-messages.html"
]
},
{
"title": "Message Envelope",
"urls":[
"/${VERSION}/changefeed-message-envelopes.html"
]
}
]
}
]
},
{
"title": "Optimize Changefeeds",
},
{
"title": "Changefeed Sinks",
"urls": [
"/${VERSION}/changefeed-sinks.html"
]
},
{
"title": "Changefeed Examples",
"urls": [
"/${VERSION}/changefeed-examples.html"
]
}
]
},
{
"title": "Monitor Changefeeds",
"items": [
{
"title": "Overview",
"urls": [
"/${VERSION}/monitor-and-debug-changefeeds.html"
]
},
{
"title": "Monitoring Guide",
"urls": [
"/${VERSION}/changefeed-monitoring-guide.html"
]
},
{
"title": "Protect Changefeed Data",
"urls": [
"/${VERSION}/protect-changefeed-data.html"
]
}
]
},
{
"title": "Optimize Changefeeds",
"items": [
{
"title": "Change Data Capture Queries",
"urls": [
"/${VERSION}/cdc-queries.html"
]
},
{
"title": "Changefeeds on Tables with Column Families",
"urls": [
"/${VERSION}/changefeeds-on-tables-with-column-families.html"
]
},
{
"title": "Export Data with Changefeeds",
"urls": [
"/${VERSION}/export-data-with-changefeeds.html"
]
},
{
"title": "Changefeeds in Multi-Region Deployments",
"urls": [
"/${VERSION}/changefeeds-in-multi-region-deployments.html"
]
}
]
},
{
"title": "Changefeed Tutorials",
"items": [
{
"title": "Change Data Capture Queries",
"urls": [
"/${VERSION}/cdc-queries.html"
"title": "Stream a Changefeed to an Amazon MSK Cluster",
"items": [
{
"title": "Amazon MSK",
"urls": [
"/${VERSION}/stream-a-changefeed-to-amazon-msk.html"
]
},
{
"title": "Amazon MSK Serverless",
"urls": [
"/${VERSION}/stream-a-changefeed-to-amazon-msk-serverless.html"
]
}
]
},
{
"title": "Changefeeds on Tables with Column Families",
"title": "Connect to a Changefeed Kafka Sink with OAuth Using Okta",
"urls": [
"/${VERSION}/changefeeds-on-tables-with-column-families.html"
"/${VERSION}/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.html"
]
},
{
"title": "Export Data with Changefeeds",
"title": "Stream a Changefeed from CockroachDB Cloud to Snowflake",
"urls": [
"/${VERSION}/export-data-with-changefeeds.html"
"/cockroachcloud/stream-changefeed-to-snowflake-aws.html"
]
},
{
"title": "Changefeeds in Multi-Region Deployments",
"title": "Stream a Changefeed to a Confluent Cloud Kafka Cluster",
"urls": [
"/${VERSION}/changefeeds-in-multi-region-deployments.html"
"/${VERSION}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.html"
]
}
]
},
{
"title": "Changefeed Tutorials",
"items": [
{
"title": "Stream a Changefeed to an Amazon MSK Cluster",
"items": [
{
"title": "Amazon MSK",
"urls": [
"/${VERSION}/stream-a-changefeed-to-amazon-msk.html"
]
},
"title": "Technical Overview",
"items": [
{
"title": "Amazon MSK Serverless",
"title": "How Does an Enterprise Changefeed Work?",
"urls": [
"/${VERSION}/stream-a-changefeed-to-amazon-msk-serverless.html"
"/${VERSION}/how-does-an-enterprise-changefeed-work.html"
]
}
]
},
{
"title": "Connect to a Changefeed Kafka Sink with OAuth Using Okta",
"urls": [
"/${VERSION}/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.html"
]
},
{
"title": "Stream a Changefeed from CockroachDB Cloud to Snowflake",
"urls": [
"/cockroachcloud/stream-changefeed-to-snowflake-aws.html"
]
},
{
"title": "Stream a Changefeed to a Confluent Cloud Kafka Cluster",
"title": "Advanced Changefeed Configuration",
"urls": [
"/${VERSION}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.html"
"/${VERSION}/advanced-changefeed-configuration.html"
]
}
]
},
{
"title": "Technical Overview",
"items": [
{
"title": "How Does an Enterprise Changefeed Work?",
"urls": [
"/${VERSION}/how-does-an-enterprise-changefeed-work.html"
]
}
]
},
{
"title": "Advanced Changefeed Configuration",
"urls": [
"/${VERSION}/advanced-changefeed-configuration.html"
]
}
]
}
}

4 changes: 2 additions & 2 deletions src/current/v25.1/changefeed-messages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ CREATE CHANGEFEED FOR TABLE rides INTO 'external://kafka' WITH diff, envelope=wr

### `bare`

`bare` removes the `after` key from the changefeed message and stores any metadata in a `crdb` field. When used with [`avro`](#avro) format, `record` will replace the `after` key.
`bare` removes the `after` key from the changefeed message and stores any metadata in a `crdb` field. When used with [`avro`]({% link {{ page.version.version }}/changefeed-messages.md %}#avro) format, `record` will replace the `after` key.

- Cloud storage sink:

Expand Down Expand Up @@ -181,7 +181,7 @@ CREATE CHANGEFEED FOR TABLE rides INTO 'external://kafka' WITH diff, envelope=wr

### `row`

`row` emits the row without any additional metadata fields in the message. This envelope option is only supported for [Kafka sinks]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka) or sinkless changefeeds. `row` does not support [`avro`](#avro) format—if you are using `avro`, refer to the [`bare`](#bare) envelope option.
`row` emits the row without any additional metadata fields in the message. This envelope option is only supported for [Kafka sinks]({% link {{ page.version.version }}/changefeed-sinks.md %}#kafka) or sinkless changefeeds. `row` does not support [`avro`]({% link {{ page.version.version }}/changefeed-messages.md %}#avro) format—if you are using `avro`, refer to the [`bare`](#bare) envelope option.

- Kafka sink:

Expand Down
2 changes: 1 addition & 1 deletion src/current/v25.2/cdc-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ You can **not** use the following functions with CDC queries:

CDC queries allow you to customize your changefeed for particular scenarios. This section outlines several possible use cases for CDC queries.

{% include {{ page.version.version }}/cdc/bare-envelope-cdc-queries.md %} Refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}#bare) page for more detail.
{% include {{ page.version.version }}/cdc/bare-envelope-cdc-queries.md %} Refer to the [Changefeed Message Envelopes]({% link {{ page.version.version }}/changefeed-message-envelopes.md %}#bare) page for more detail.

Depending on how you are filtering or adapting the message envelope with a CDC query and which sink you're emitting to, message output may vary from some of the example cases in this section.

Expand Down
4 changes: 2 additions & 2 deletions src/current/v25.2/changefeed-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,7 +680,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co
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]({% link {{ page.version.version }}/changefeed-messages.md %}#responses).
For more detail on emitted changefeed messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page.

## Create a changefeed connected to an Apache Pulsar sink

Expand Down Expand Up @@ -769,7 +769,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co
key:[null], properties:[], content:{"Key":["rome", "3c7d6676-f713-4985-ba52-4c19fe6c3692"],"Value":{"after": {"city": "rome", "end_address": null, "end_time": null, "id": "3c7d6676-f713-4985-ba52-4c19fe6c3692", "revenue": 27.00, "rider_id": "c15a4926-fbb2-4931-a9a0-6dfabc6c506b", "start_address": "39415 Brandon Avenue Apt. 29", "start_time": "2024-05-09T12:18:42.055498", "vehicle_city": "rome", "vehicle_id": "627dad1a-3531-4214-a173-16bcc6b93036"}},"Topic":"rides"}
~~~

For more detail on emitted changefeed messages, refer to [Responses]({% link {{ page.version.version }}/changefeed-messages.md %}#responses).
For more detail on emitted changefeed messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page.

</section>

Expand Down
Loading