Skip to content

Commit

Permalink
(DOCSP-42962) Normalizing spacing and adding reference to the Data Fo…
Browse files Browse the repository at this point in the history
…rmats page.
  • Loading branch information
your proper name committed Oct 4, 2024
1 parent ea5dc5e commit 6fa0ae5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 18 deletions.
2 changes: 2 additions & 0 deletions source/introduction/data-formats.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _kafka-data-formats:

============
Data Formats
============
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Settings

- :ref:`<source-usage-example-custom-pipeline>`
- :ref:`<source-usage-example-multiple-sources>`

|
| **Default**: ``"[]"``
| **Accepted Values**: Valid aggregation pipeline stage

Expand All @@ -65,20 +65,20 @@ Settings
| **Description:**
| Determines what values your change stream returns on update
operations.

|
| The default setting returns the differences between the original
document and the updated document.

|
| The ``updateLookup`` setting returns the differences between the
original document and updated document as well as a copy of the
entire updated document at a *point in time* after the update.

|
| The ``whenAvailable`` setting returns the updated document,
if available.

|
| The ``required`` setting returns the updated document and
raises an error if it is not available.

|
| For more information on how this change stream option works, see
:manual:`Lookup Full Document for Update Operations
</changeStreams/#lookup-full-document-for-update-operations>`
Expand Down Expand Up @@ -139,7 +139,7 @@ Settings
Tombstone events contain the keys of deleted documents with
``null`` values. This setting applies only when
``publish.full.document.only`` is ``true``.

|
| **Default**: ``false``
| **Accepted Values**: ``true`` or ``false``

Expand All @@ -149,12 +149,12 @@ Settings
| **Description:**
| Whether to use the document key for the source record key if
the document key is present.

|
| When set to ``true``, the connector adds keys of the deleted
documents to the tombstone events. When set to ``false``,
the connector uses the resume token as the source key for
the tombstone events.

|
| **Default**: ``true``
| **Accepted Values**: ``true`` or ``false``

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ Settings
| **Description:**
| Specifies an Avro schema definition for the key document of the
`SourceRecord <{+kafka_api_docs_base+}javadoc/org/apache/kafka/connect/source/SourceRecord.html>`__.

To learn more about Avro schema, see :ref:`Avro <data-formats-avro>` in the
:ref:`Data Formats guide <kafka-df-avro-schema>`.

|
| To learn more about Avro schema, see :ref:`Avro <data-formats-avro>` in the
:ref:`Data Formats guide <kafka-data-formats>`.
|
| **Default**:

.. code-block:: json
Expand All @@ -113,10 +113,10 @@ Settings
| **Description:**
| Specifies an Avro schema definition for the value document of the
`SourceRecord <{+kafka_api_docs_base+}javadoc/org/apache/kafka/connect/source/SourceRecord.html>`__.

|
| To learn more about Avro schema, see :ref:`Avro <data-formats-avro>` in the
:ref:`Data Formats guide <kafka-df-avro-schema>`.

:ref:`Data Formats guide <kafka-data-formats>`.
|
| **Default**:

.. code-block:: json
Expand Down Expand Up @@ -163,10 +163,10 @@ Settings
document of the `SourceRecord <{+kafka_api_docs_base+}javadoc/org/apache/kafka/connect/source/SourceRecord.html>`__.
Since the connector processes each document in isolation, the
connector may generate many schemas.

|
| :gold:`IMPORTANT:` The connector only reads this setting when you set your
``output.format.value`` setting to ``schema``.

|
| **Default**: ``false``
| **Accepted Values**: ``true`` or ``false``

Expand Down

0 comments on commit 6fa0ae5

Please sign in to comment.