Skip to content

Commit

Permalink
doc: Update schema extraction page (#144)
Browse files Browse the repository at this point in the history
* Update schema-extraction page

* small tweak
  • Loading branch information
raulb authored Oct 2, 2024
1 parent 1d32c0f commit f7c4135
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/connectors/configuration-parameters/schema-extraction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ connectors):
key should be extracted.
* `sdk.schema.extract.key.subject`: The subject of the key schema.


:::caution
`sdk.schema.extract.payload.enabled` and `sdk.schema.extract.key.enabled` should be set to `false` when producing raw (not structured) data, as shown in the example below.

If you are developing a connector, you can disable this automatically by updating the connector's default middleware. For more information about `NewSource()` when developing a source connector, see [here](/docs/connectors/building-connectors/developing-source-connectors/#newsource).
:::

## Example

The below pipeline will generate a single record and write it to a file. Notice
Expand Down Expand Up @@ -90,3 +97,9 @@ something below in the record's metadata:
"opencdc.payload.schema.subject": "generator-to-file:file-src:users.payload",
"opencdc.payload.schema.version": "1"
```

:::tip

To learn more about **Schema Support**, check out [this page](/docs/features/schema-support).

:::

0 comments on commit f7c4135

Please sign in to comment.