Skip to content

Commit 6fa0ae5

Browse files
author
your proper name
committed
(DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.
1 parent ea5dc5e commit 6fa0ae5

File tree

3 files changed

+20
-18
lines changed

3 files changed

+20
-18
lines changed

source/introduction/data-formats.txt

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _kafka-data-formats:
2+
13
============
24
Data Formats
35
============

source/source-connector/configuration-properties/change-stream.txt

+9-9
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Settings
5555

5656
- :ref:`<source-usage-example-custom-pipeline>`
5757
- :ref:`<source-usage-example-multiple-sources>`
58-
58+
|
5959
| **Default**: ``"[]"``
6060
| **Accepted Values**: Valid aggregation pipeline stage
6161

@@ -65,20 +65,20 @@ Settings
6565
| **Description:**
6666
| Determines what values your change stream returns on update
6767
operations.
68-
68+
|
6969
| The default setting returns the differences between the original
7070
document and the updated document.
71-
71+
|
7272
| The ``updateLookup`` setting returns the differences between the
7373
original document and updated document as well as a copy of the
7474
entire updated document at a *point in time* after the update.
75-
75+
|
7676
| The ``whenAvailable`` setting returns the updated document,
7777
if available.
78-
78+
|
7979
| The ``required`` setting returns the updated document and
8080
raises an error if it is not available.
81-
81+
|
8282
| For more information on how this change stream option works, see
8383
:manual:`Lookup Full Document for Update Operations
8484
</changeStreams/#lookup-full-document-for-update-operations>`
@@ -139,7 +139,7 @@ Settings
139139
Tombstone events contain the keys of deleted documents with
140140
``null`` values. This setting applies only when
141141
``publish.full.document.only`` is ``true``.
142-
142+
|
143143
| **Default**: ``false``
144144
| **Accepted Values**: ``true`` or ``false``
145145

@@ -149,12 +149,12 @@ Settings
149149
| **Description:**
150150
| Whether to use the document key for the source record key if
151151
the document key is present.
152-
152+
|
153153
| When set to ``true``, the connector adds keys of the deleted
154154
documents to the tombstone events. When set to ``false``,
155155
the connector uses the resume token as the source key for
156156
the tombstone events.
157-
157+
|
158158
| **Default**: ``true``
159159
| **Accepted Values**: ``true`` or ``false``
160160

source/source-connector/configuration-properties/output-format.txt

+9-9
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,10 @@ Settings
9191
| **Description:**
9292
| Specifies an Avro schema definition for the key document of the
9393
`SourceRecord <{+kafka_api_docs_base+}javadoc/org/apache/kafka/connect/source/SourceRecord.html>`__.
94-
95-
To learn more about Avro schema, see :ref:`Avro <data-formats-avro>` in the
96-
:ref:`Data Formats guide <kafka-df-avro-schema>`.
97-
94+
|
95+
| To learn more about Avro schema, see :ref:`Avro <data-formats-avro>` in the
96+
:ref:`Data Formats guide <kafka-data-formats>`.
97+
|
9898
| **Default**:
9999

100100
.. code-block:: json
@@ -113,10 +113,10 @@ Settings
113113
| **Description:**
114114
| Specifies an Avro schema definition for the value document of the
115115
`SourceRecord <{+kafka_api_docs_base+}javadoc/org/apache/kafka/connect/source/SourceRecord.html>`__.
116-
116+
|
117117
| To learn more about Avro schema, see :ref:`Avro <data-formats-avro>` in the
118-
:ref:`Data Formats guide <kafka-df-avro-schema>`.
119-
118+
:ref:`Data Formats guide <kafka-data-formats>`.
119+
|
120120
| **Default**:
121121

122122
.. code-block:: json
@@ -163,10 +163,10 @@ Settings
163163
document of the `SourceRecord <{+kafka_api_docs_base+}javadoc/org/apache/kafka/connect/source/SourceRecord.html>`__.
164164
Since the connector processes each document in isolation, the
165165
connector may generate many schemas.
166-
166+
|
167167
| :gold:`IMPORTANT:` The connector only reads this setting when you set your
168168
``output.format.value`` setting to ``schema``.
169-
169+
|
170170
| **Default**: ``false``
171171
| **Accepted Values**: ``true`` or ``false``
172172

0 commit comments

Comments
 (0)