Skip to content

Commit 13661c3

Browse files
katmaybkatmayb
authored
Create new Message Envelope page with new 25.2 features (#19542)
1 parent f523949 commit 13661c3

12 files changed

+1051
-308
lines changed

‎src/current/_includes/v25.2/sidebar-data/stream-data.json

Lines changed: 132 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,156 +1,168 @@
11
{
2-
"title": "Stream Data",
3-
"is_top_level": true,
4-
"items": [
5-
{
6-
"title": "Change Data Capture Overview",
7-
"urls": [
8-
"/${VERSION}/change-data-capture-overview.html"
9-
]
10-
},
11-
{
12-
"title": "Get Started with Changefeeds",
13-
"items": [
14-
{
15-
"title": "Create and Configure Changefeeds",
16-
"urls": [
17-
"/${VERSION}/create-and-configure-changefeeds.html"
18-
]
19-
},
20-
{
21-
"title": "Changefeed Best Practices",
22-
"urls": [
23-
"/${VERSION}/changefeed-best-practices.html"
24-
]
25-
},
26-
{
27-
"title": "Changefeed Messages",
28-
"urls": [
29-
"/${VERSION}/changefeed-messages.html"
30-
]
31-
},
32-
{
33-
"title": "Changefeed Sinks",
34-
"urls": [
35-
"/${VERSION}/changefeed-sinks.html"
36-
]
37-
},
38-
{
39-
"title": "Changefeed Examples",
40-
"urls": [
41-
"/${VERSION}/changefeed-examples.html"
42-
]
43-
}
44-
]
45-
},
46-
{
47-
"title": "Monitor Changefeeds",
48-
"items": [
49-
{
50-
"title": "Overview",
2+
"title": "Stream Data",
3+
"is_top_level": true,
4+
"items": [
5+
{
6+
"title": "Change Data Capture Overview",
7+
"urls": [
8+
"/${VERSION}/change-data-capture-overview.html"
9+
]
10+
},
11+
{
12+
"title": "Get Started with Changefeeds",
13+
"items": [
14+
{
15+
"title": "Create and Configure Changefeeds",
5116
"urls": [
52-
"/${VERSION}/monitor-and-debug-changefeeds.html"
17+
"/${VERSION}/create-and-configure-changefeeds.html"
5318
]
54-
},
55-
{
56-
"title": "Monitoring Guide",
19+
},
20+
{
21+
"title": "Changefeed Best Practices",
5722
"urls": [
58-
"/${VERSION}/changefeed-monitoring-guide.html"
23+
"/${VERSION}/changefeed-best-practices.html"
5924
]
60-
},
61-
{
62-
"title": "Protect Changefeed Data",
63-
"urls": [
64-
"/${VERSION}/protect-changefeed-data.html"
25+
},
26+
{
27+
"title": "Changefeed Messages",
28+
"items": [
29+
{
30+
"title": "Overview",
31+
"urls": [
32+
"/${VERSION}/changefeed-messages.html"
33+
]
34+
},
35+
{
36+
"title": "Message Envelope",
37+
"urls":[
38+
"/${VERSION}/changefeed-message-envelopes.html"
39+
]
40+
}
6541
]
66-
}
67-
]
68-
},
69-
{
70-
"title": "Optimize Changefeeds",
42+
},
43+
{
44+
"title": "Changefeed Sinks",
45+
"urls": [
46+
"/${VERSION}/changefeed-sinks.html"
47+
]
48+
},
49+
{
50+
"title": "Changefeed Examples",
51+
"urls": [
52+
"/${VERSION}/changefeed-examples.html"
53+
]
54+
}
55+
]
56+
},
57+
{
58+
"title": "Monitor Changefeeds",
59+
"items": [
60+
{
61+
"title": "Overview",
62+
"urls": [
63+
"/${VERSION}/monitor-and-debug-changefeeds.html"
64+
]
65+
},
66+
{
67+
"title": "Monitoring Guide",
68+
"urls": [
69+
"/${VERSION}/changefeed-monitoring-guide.html"
70+
]
71+
},
72+
{
73+
"title": "Protect Changefeed Data",
74+
"urls": [
75+
"/${VERSION}/protect-changefeed-data.html"
76+
]
77+
}
78+
]
79+
},
80+
{
81+
"title": "Optimize Changefeeds",
82+
"items": [
83+
{
84+
"title": "Change Data Capture Queries",
85+
"urls": [
86+
"/${VERSION}/cdc-queries.html"
87+
]
88+
},
89+
{
90+
"title": "Changefeeds on Tables with Column Families",
91+
"urls": [
92+
"/${VERSION}/changefeeds-on-tables-with-column-families.html"
93+
]
94+
},
95+
{
96+
"title": "Export Data with Changefeeds",
97+
"urls": [
98+
"/${VERSION}/export-data-with-changefeeds.html"
99+
]
100+
},
101+
{
102+
"title": "Changefeeds in Multi-Region Deployments",
103+
"urls": [
104+
"/${VERSION}/changefeeds-in-multi-region-deployments.html"
105+
]
106+
}
107+
]
108+
},
109+
{
110+
"title": "Changefeed Tutorials",
71111
"items": [
72112
{
73-
"title": "Change Data Capture Queries",
74-
"urls": [
75-
"/${VERSION}/cdc-queries.html"
113+
"title": "Stream a Changefeed to an Amazon MSK Cluster",
114+
"items": [
115+
{
116+
"title": "Amazon MSK",
117+
"urls": [
118+
"/${VERSION}/stream-a-changefeed-to-amazon-msk.html"
119+
]
120+
},
121+
{
122+
"title": "Amazon MSK Serverless",
123+
"urls": [
124+
"/${VERSION}/stream-a-changefeed-to-amazon-msk-serverless.html"
125+
]
126+
}
76127
]
77128
},
78129
{
79-
"title": "Changefeeds on Tables with Column Families",
130+
"title": "Connect to a Changefeed Kafka Sink with OAuth Using Okta",
80131
"urls": [
81-
"/${VERSION}/changefeeds-on-tables-with-column-families.html"
132+
"/${VERSION}/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.html"
82133
]
83134
},
84135
{
85-
"title": "Export Data with Changefeeds",
136+
"title": "Stream a Changefeed from CockroachDB Cloud to Snowflake",
86137
"urls": [
87-
"/${VERSION}/export-data-with-changefeeds.html"
138+
"/cockroachcloud/stream-changefeed-to-snowflake-aws.html"
88139
]
89140
},
90141
{
91-
"title": "Changefeeds in Multi-Region Deployments",
142+
"title": "Stream a Changefeed to a Confluent Cloud Kafka Cluster",
92143
"urls": [
93-
"/${VERSION}/changefeeds-in-multi-region-deployments.html"
144+
"/${VERSION}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.html"
94145
]
95146
}
96147
]
97148
},
98149
{
99-
"title": "Changefeed Tutorials",
100-
"items": [
101-
{
102-
"title": "Stream a Changefeed to an Amazon MSK Cluster",
103-
"items": [
104-
{
105-
"title": "Amazon MSK",
106-
"urls": [
107-
"/${VERSION}/stream-a-changefeed-to-amazon-msk.html"
108-
]
109-
},
150+
"title": "Technical Overview",
151+
"items": [
110152
{
111-
"title": "Amazon MSK Serverless",
153+
"title": "How Does an Enterprise Changefeed Work?",
112154
"urls": [
113-
"/${VERSION}/stream-a-changefeed-to-amazon-msk-serverless.html"
155+
"/${VERSION}/how-does-an-enterprise-changefeed-work.html"
114156
]
115157
}
116158
]
117159
},
118160
{
119-
"title": "Connect to a Changefeed Kafka Sink with OAuth Using Okta",
120-
"urls": [
121-
"/${VERSION}/connect-to-a-changefeed-kafka-sink-with-oauth-using-okta.html"
122-
]
123-
},
124-
{
125-
"title": "Stream a Changefeed from CockroachDB Cloud to Snowflake",
126-
"urls": [
127-
"/cockroachcloud/stream-changefeed-to-snowflake-aws.html"
128-
]
129-
},
130-
{
131-
"title": "Stream a Changefeed to a Confluent Cloud Kafka Cluster",
161+
"title": "Advanced Changefeed Configuration",
132162
"urls": [
133-
"/${VERSION}/stream-a-changefeed-to-a-confluent-cloud-kafka-cluster.html"
163+
"/${VERSION}/advanced-changefeed-configuration.html"
134164
]
135165
}
136166
]
137-
},
138-
{
139-
"title": "Technical Overview",
140-
"items": [
141-
{
142-
"title": "How Does an Enterprise Changefeed Work?",
143-
"urls": [
144-
"/${VERSION}/how-does-an-enterprise-changefeed-work.html"
145-
]
146-
}
147-
]
148-
},
149-
{
150-
"title": "Advanced Changefeed Configuration",
151-
"urls": [
152-
"/${VERSION}/advanced-changefeed-configuration.html"
153-
]
154-
}
155-
]
156-
}
167+
}
168+

‎src/current/v25.1/changefeed-messages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ CREATE CHANGEFEED FOR TABLE rides INTO 'external://kafka' WITH diff, envelope=wr
120120

121121
### `bare`
122122

123-
`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.
123+
`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.
124124

125125
- Cloud storage sink:
126126

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

182182
### `row`
183183

184-
`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.
184+
`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.
185185

186186
- Kafka sink:
187187

‎src/current/v25.2/cdc-queries.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The following table outlines functions that are useful with CDC queries:
6262
Function | Description
6363
--------------------------+----------------------
6464
`changefeed_creation_timestamp()` | Returns the decimal MVCC timestamp when the changefeed was created. Use this function to build CDC queries that restrict emitted events by time. `changefeed_creation_timestamp()` can serve a similar purpose to the [`now()` time function]({% link {{ page.version.version }}/functions-and-operators.md %}#date-and-time-functions), which is not supported with CDC queries.
65-
`event_op()` | Returns a string describing the type of event. If a changefeed is running with the [`diff`]({% link {{ page.version.version }}/create-changefeed.md %}#diff) option, then this function returns `'insert'`, `'update'`, or `'delete'`. If a changefeed is running without the `diff` option, it is not possible to determine an update from an insert, so `event_op()` returns [`'upsert'`](https://www.cockroachlabs.com/blog/sql-upsert/) or `'delete'`.
65+
`event_op()` | Returns a string describing the type of event. If a changefeed is running with the [`diff`]({% link {{ page.version.version }}/create-changefeed.md %}#diff) option, then this function returns `'insert'`, `'update'`, or `'delete'`. If a changefeed is running without the `diff` option, it is not possible to determine an update from an insert, so `event_op()` returns [`'upsert'`](https://www.cockroachlabs.com/blog/sql-upsert/) or `'delete'`.<br><br>If you're using CDC queries to filter only for the type of change operation, we recommend specifying the [`envelope=enriched` option]({% link {{ page.version.version }}/changefeed-message-envelopes.md %}#route-events-based-on-operation-type) for this metadata instead.
6666
`event_schema_timestamp()` | Returns the timestamp of [schema change]({% link {{ page.version.version }}/online-schema-changes.md %}) events that cause a [changefeed message]({% link {{ page.version.version }}/changefeed-messages.md %}) to emit. When the schema change event does not result in a table backfill or scan, `event_schema_timestamp()` will return the event's timestamp. When the schema change event does result in a table backfill or scan, `event_schema_timestamp()` will return the timestamp at which the backfill/scan is read — the [high-water mark time]({% link {{ page.version.version }}/how-does-an-enterprise-changefeed-work.md %}) of the changefeed.
6767

6868
You can also use the following functions in CDC queries:
@@ -102,7 +102,7 @@ You can **not** use the following functions with CDC queries:
102102

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

105-
{% 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.
105+
{% 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.
106106

107107
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.
108108

‎src/current/v25.2/changefeed-examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -680,7 +680,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co
680680
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}
681681
~~~
682682
683-
For more detail on emitted changefeed messages, see [responses]({% link {{ page.version.version }}/changefeed-messages.md %}#responses).
683+
For more detail on emitted changefeed messages, refer to the [Changefeed Messages]({% link {{ page.version.version }}/changefeed-messages.md %}) page.
684684
685685
## Create a changefeed connected to an Apache Pulsar sink
686686
@@ -769,7 +769,7 @@ In this example, you'll set up a changefeed for a single-node cluster that is co
769769
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"}
770770
~~~
771771

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

774774
</section>
775775

0 commit comments

Comments
 (0)