Skip to content

Commit 9e4aecb

Browse files
author
your proper name
committed
(DOCSP-42962) Normalizing spacing across pages.
1 parent 1de3bc7 commit 9e4aecb

File tree

3 files changed

+62
-43
lines changed

3 files changed

+62
-43
lines changed

‎source/source-connector/configuration-properties/error-handling.txt‎

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,18 @@ Settings
3939
| **Description:**
4040
| Whether to continue processing messages when the connector encounters
4141
an error.
42+
|
4243
| Set this to ``"none"`` if you want the connector to stop
4344
processing messages and report the issue if it encounters an
4445
error.
46+
|
4547
| Set this to ``"all"`` if you want the connector to continue
4648
processing messages and ignore any errors it encounters.
47-
48-
:gold:`IMPORTANT:` This property overrides the
49-
`errors.tolerance <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html#errors-tolerance>`__
50-
Connect Framework property.
51-
49+
|
50+
| :gold:`IMPORTANT:` This property overrides the
51+
`errors.tolerance <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html#errors-tolerance>`__
52+
Connect Framework property.
53+
|
5254
| **Default:** ``"none"``
5355
| **Accepted Values**: ``"none"`` or ``"all"``
5456

@@ -57,16 +59,18 @@ Settings
5759
|
5860
| **Description:**
5961
| Whether the connector should report errors in the log file.
62+
|
6063
| Set this to ``true`` to log all errors the connector encounters.
64+
|
6165
| Set this to ``false`` to log errors that are not tolerated by the
6266
connector. You can specify which errors the connector should
6367
tolerate using the ``errors.tolerance`` or ``mongo.errors.tolerance``
6468
setting.
65-
66-
:gold:`IMPORTANT:` This property overrides the
67-
`errors.log.enable <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html#errors-log-enable>`__
68-
Connect Framework property.
69-
69+
|
70+
| :gold:`IMPORTANT:` This property overrides the
71+
`errors.log.enable <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html#errors-log-enable>`__
72+
Connect Framework property.
73+
|
7074
| **Default:** ``false``
7175
| **Accepted Values**: ``true`` or ``false``
7276

@@ -75,14 +79,16 @@ Settings
7579
|
7680
| **Description:**
7781
| The name of topic to use as the dead letter queue.
82+
|
7883
| If you specify a value, the connector writes invalid messages to the
7984
dead letter queue topic as :manual:`extended JSON strings </reference/mongodb-extended-json/>`.
85+
|
8086
| If you leave this setting blank, the connector does not write
8187
invalid messages to any topic.
8288

83-
:gold:`IMPORTANT:` You must set ``errors.tolerance`` or ``mongo.errors.tolerance``
84-
setting to ``"all"`` to enable this property.
85-
89+
| :gold:`IMPORTANT:` You must set ``errors.tolerance`` or ``mongo.errors.tolerance``
90+
setting to ``"all"`` to enable this property.
91+
|
8692
| **Default:** ``""``
8793
| **Accepted Values**: A valid Kafka topic name
8894

@@ -92,12 +98,14 @@ Settings
9298
| **Description:**
9399
| The custom offset partition name to use. You can use this option
94100
to instruct the connector to start a new change stream when an
95-
existing offset contains an invalid resume token. If you leave
96-
this setting blank, the connector uses the default partition name
97-
based on the connection details. To view a strategy for naming
98-
offset partitions, see the :ref:`<troubleshoot-reset-stored-offsets>`
99-
guide.
100-
101+
existing offset contains an invalid resume token.
102+
|
103+
| If you leave this setting blank, the connector uses the default partition name
104+
based on the connection details.
105+
|
106+
| To view a strategy for naming
107+
offset partitions, see :ref:`<troubleshoot-reset-stored-offsets>`.
108+
|
101109
| **Default:** ``""``
102110
| **Accepted Values**: A string. To learn more about naming a partition,
103111
see
@@ -110,15 +118,19 @@ Settings
110118
| **Description:**
111119
| The number of milliseconds the connector waits between sending
112120
heartbeat messages. The connector sends heartbeat messages when
113-
source records are not published in the specified interval.
121+
source records are not published in the specified interval. This mechanism improves
122+
resumability of the connector for low volume namespaces.
123+
|
114124
| Heartbeat messages contain a ``postBatchResumeToken`` data field.
115125
The value of this field contains the MongoDB server oplog entry that
116126
the connector last read from the change stream.
117-
| This mechanism improves resumability of the connector for low volume
118-
namespaces. See the :ref:`Invalid Resume Token <invalid-resume-token-prevention>`
119-
page for more information on this feature.
120-
127+
|
121128
| Set this to ``0`` to disable heartbeat messages.
129+
|
130+
| To learn more, see :ref:`Prevention <invalid-resume-token-prevention>`
131+
in the :ref:`Invalid Resume Token <kafka-troubleshoot-invalid-resume-token>`
132+
page.
133+
|
122134
| **Default**: ``0``
123135
| **Accepted Values**: An integer
124136

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ Settings
5151
| Specifies which data format the source connector outputs the value
5252
document.
5353
|
54-
| **Default**: ``json``
55-
| **Accepted Values**: ``bson``, ``json``, ``schema``
56-
5754
| The connector supports Protobuf as an
5855
output data format. You can enable this format by specifying the
5956
``schema`` value and installing and :ref:`configuring
6057
<protobuf-converter-sample-properties>` the `Kafka Connect Protobuf
6158
Converter <https://www.confluent.io/hub/confluentinc/kafka-connect-protobuf-converter>`__.
59+
|
60+
| **Default**: ``json``
61+
| **Accepted Values**: ``bson``, ``json``, ``schema``
6262

6363
* - | **output.json.formatter**
6464
- | **Type:** string

‎source/source-connector/configuration-properties/startup.txt‎

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Settings
6565
setting is equivalent to the deprecated setting ``copy.existing=true``.
6666

6767
.. include:: /includes/copy-existing-admonition.rst
68-
68+
6969
| **Default**:``latest``
7070
| **Accepted Values**: ``latest``, ``timestamp``, ``copy_existing``
7171

@@ -74,9 +74,12 @@ Settings
7474
|
7575
| **Description:**
7676
| Actuated only if ``startup.mode=timestamp``. Specifies the
77-
starting point for the change stream. To learn more about
78-
Change Stream parameters, see the :manual:`Server manual entry
79-
</reference/operator/aggregation/changeStream/>`.
77+
starting point for the change stream.
78+
|
79+
| To learn more about Change Stream parameters, see
80+
:manual:`$changeStream (aggregation) </reference/operator/aggregation/changeStream/>`
81+
in the MongoDB manual.
82+
|
8083
| **Default**: ``""``
8184
| **Accepted Values**:
8285

@@ -94,19 +97,20 @@ Settings
9497
| Regular expression the connector uses to match namespaces from
9598
which to copy data. A namespace describes the MongoDB database name
9699
and collection separated by a period (for example, ``databaseName.collectionName``).
97-
98-
For example, the following regular-expression setting matches
99-
collections that start with "page" in the ``stats`` database:
100+
|
101+
| For example, the following regular-expression setting matches
102+
collections that start with "page" in the ``stats`` database:
100103

101104
.. code-block:: none
102105

103106
startup.mode.copy.existing.namespace.regex=stats\.page.*
104107

105-
The ``\`` character in the example above escapes the ``.`` character
106-
that follows it in the regular expression. For more information on
107-
how to build regular expressions, see the Java API documentation on
108-
`Patterns <https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html>`__.
109-
108+
| The ``\`` character in the example above escapes the ``.`` character
109+
that follows it in the regular expression. For more information on
110+
how to build regular expressions, see
111+
`Patterns <https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html>`__
112+
in the Java API documentation.
113+
|
110114
| **Default**: ``""``
111115
| **Accepted Values**: A valid regular expression
112116

@@ -118,10 +122,10 @@ Settings
118122
the connector runs when copying existing data. You can use this
119123
setting to filter the source collection and improve the use of
120124
indexes in the copying process.
121-
122-
For example, the following setting uses the :manual:`$match </reference/operator/aggregation/match/>`
123-
aggregation operator to instruct the connector to copy only
124-
documents that contain a ``closed`` field with a value of ``false``.
125+
|
126+
| For example, the following setting uses the :manual:`$match </reference/operator/aggregation/match/>`
127+
aggregation operator to instruct the connector to copy only
128+
documents that contain a ``closed`` field with a value of ``false``.
125129

126130
.. code-block:: none
127131

@@ -135,6 +139,7 @@ Settings
135139
|
136140
| **Description:**
137141
| The maximum number of threads the connector can use to copy data.
142+
|
138143
| **Default**: number of processors available in the environment
139144
| **Accepted Values**: An integer
140145

@@ -143,6 +148,7 @@ Settings
143148
|
144149
| **Description:**
145150
| The size of the queue the connector can use when copying data.
151+
|
146152
| **Default**: ``16000``
147153
| **Accepted Values**: An integer
148154

@@ -152,6 +158,7 @@ Settings
152158
| **Description:**
153159
| When set to ``true``, the connector uses temporary disk storage
154160
for the copy existing aggregation.
161+
|
155162
| **Default**: ``true``
156163
| **Accepted Values**: ``true`` or ``false``
157164

0 commit comments

Comments
 (0)