Skip to content

Commit c9e4eaf

Browse files
biniona-mongodbschmalliso
authored andcommitted
(DOCSP-18947) Add Converters Discussion to Schema Page (#180)
1 parent a152456 commit c9e4eaf

File tree

3 files changed

+18
-19
lines changed

3 files changed

+18
-19
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. important:: Converters
2+
3+
If you want to send your data through {+ak+} with {+avro-short+} binary encoding,
4+
you must use an {+avro-short+} converter. For more information, see the guide on
5+
:ref:`Converters <intro-converters>`.

source/source-connector/fundamentals/specify-schema.txt

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ following combinations of schemas:
4848
To see a discussion on the benefits of using schemas with Kafka Connect,
4949
see `this article from Confluent <https://docs.confluent.io/platform/current/schema-registry/index.html#ak-serializers-and-deserializers-background>`__.
5050

51-
To see full properties files for specifying a schema, see our specify a schema
52-
usage example. <TODO: link to example>
51+
If you want to send data through {+ak+} with a specific data format, such as {+avro+}
52+
or JSON Schema, see the :ref:`<intro-converters>` guide.
5353

5454
To learn more about keys and values in Apache Kafka, see the
5555
`official Apache Kafka introduction <http://kafka.apache.org/intro#intro_concepts_and_terms>`__.
@@ -78,7 +78,7 @@ event documents. You should use the default key schema unless you remove the
7878
``_id`` field from your change event document using either of the transformations
7979
:ref:`described in this guide here <source-schema-for-modified-document>`.
8080

81-
If you specify either of these transformations and would like to use a key
81+
If you specify either of these transformations and want to use a key
8282
schema for your incoming documents, you must specify a key schema
8383
:ref:`as described in the specify a schema section of this guide <source-specify-avro-schema>`.
8484

@@ -98,7 +98,7 @@ should use the default value schema unless you transform your change event
9898
documents
9999
:ref:`as described in this guide here <source-schema-for-modified-document>`.
100100

101-
If you specify either of these transformations and would like to use a value schema for your
101+
If you specify either of these transformations and want to use a value schema for your
102102
incoming documents, you must use one of the mechanisms described in the
103103
:ref:`schemas for transformed documents section of this guide <source-schema-for-modified-document>`.
104104

@@ -125,8 +125,8 @@ you must do the following to apply schemas:
125125
- :ref:`Specify schemas <source-specify-avro-schema>`
126126
- :ref:`Have the connector infer a value schema <source-infer-a-schema>`
127127

128-
To learn more, see our
129-
:doc:`guide on source connector configuration properties </source-connector/configuration-properties>`.
128+
To learn more about the preceding configuration options, see the
129+
:ref:`<source-configuration-change-stream>` page.
130130

131131
.. _source-specify-avro-schema:
132132

@@ -154,10 +154,13 @@ the following tabs to see how to specify a schema for document values and keys:
154154
output.format.value=schema
155155
output.schema.value=<your avro schema>
156156

157-
.. TODO: Make sure this link goes to correct avro schema page
157+
To view an example that demonstrates how to specify a schema, see the
158+
:ref:`<source-usage-example-schema>` usage example.
158159

159-
To learn more about Avro Schema, see our
160-
:doc:`guide on Avro schema </introduction/data-formats/avro>`.
160+
To learn more about Avro Schema, see the
161+
:ref:`Data Formats <kafka-df-avro-schema>` guide.
162+
163+
.. include:: /includes/schema-converter-important.rst
161164

162165
.. _source-infer-a-schema:
163166

@@ -183,8 +186,3 @@ following options:
183186
schema and transform your MongoDB change event documents, you must specify a
184187
key schema as described in
185188
:ref:`the specify schemas section of this guide <source-specify-avro-schema>`.
186-
187-
Properties Files
188-
----------------
189-
190-
TODO: <Complete Source Connector Properties File For Default and Specified Schemas>

source/source-connector/usage-examples/schema.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,7 @@ the example schema below:
108108
.. literalinclude:: /includes/source-connector/usage-examples/customers.avro
109109
:language: json
110110

111-
.. important:: Converters
112-
113-
If you want to send your data through {+ak+} with {+avro-short+} binary encoding,
114-
you must use an {+avro-short+} converter. For more information, see the guide on
115-
:ref:`Converters <intro-converters>`.
111+
.. include:: /includes/schema-converter-important.rst
116112

117113
.. _usage-example-schema-omit-metadata:
118114

0 commit comments

Comments
 (0)