cockroachdb / cockroachdb/cockroach

cdc: Document __crdb__ tag in avro schema

Open
#114,265 1 comment 0 reactions 0 assignees View on GitHub
A-cdc C-enhancement T-cdc
Dominant language
Go
Stars
32.5k
Forks
4.1k
PR merge metrics
PR metrics pending

Description

Update https://www.cockroachlabs.com/docs/v23.1/changefeed-messages documentation
on avro schema changes: we currently indicate:

```
Note that the original CockroachDB column definition is also included in the schema as a doc field, so it's still possible to distinguish between a NOT NULL CockroachDB column and a NULL CockroachDB column.
```
We should say that schema validation tools should *ignore* this field -- this is an internal cockroachDB specific schema type description that may change between cockroach versions; and as such it should be consider custom attribute that should be ignored.

Jira issue: CRDB-33426

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.