Skip to content

Commit 0caa575

Browse files
Chris Choschmalliso
authored andcommitted
030121 Fix RST build errors (#86)
* fix line blocks and changelog link
1 parent ee0da76 commit 0caa575

File tree

2 files changed

+20
-51
lines changed

2 files changed

+20
-51
lines changed

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ This guide is divided into the following topics:
5252
- :doc:`Kafka Docker Example </kafka-docker-example>`
5353
- :doc:`Migrate from Kafka Connect </kafka-connect-migration>`
5454
- :doc:`Compatibility </kafka-compatibility>`
55-
- :doc:`Changelog <https://github.com/mongodb/mongo-kafka/blob/master/CHANGELOG.md>`
55+
- `Changelog <https://github.com/mongodb/mongo-kafka/blob/master/CHANGELOG.md>`__
5656
- :doc:`Issues and Help </issues-and-help>`
5757

source/kafka-sink-properties.txt

Lines changed: 19 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,7 @@ data to sink to MongoDB. For an example configuration file, see
4242
* - topics.regex
4343
- string
4444
- | A regular expression that matches the Kafka topics that the sink connector should watch.
45-
46-
The following regex matches topics such as
47-
"activity.landing.clicks" and "activity.support.clicks",
48-
but not "activity.landing.views" or "activity.clicks":
45+
| The following regex matches topics such as "activity.landing.clicks" and "activity.support.clicks", but not "activity.landing.views" or "activity.clicks":
4946

5047
.. code-block:: none
5148

@@ -58,13 +55,12 @@ data to sink to MongoDB. For an example configuration file, see
5855
* - connection.uri
5956
- string
6057
- | A :manual:`MongoDB connection URI string </reference/connection-string/#standard-connection-string-format>`.
61-
58+
6259
.. code-block:: none
6360

6461
mongodb://username:password@localhost/
6562

66-
| For additional information, see the
67-
| :doc:`Connect your Kafka Connector to MongoDB section </kafka-connection-mongodb>`.
63+
| For additional information, see the :doc:`Connect your Kafka Connector to MongoDB section </kafka-connection-mongodb>`.
6864

6965
.. include:: /includes/externalize-secrets.rst
7066

@@ -87,18 +83,14 @@ data to sink to MongoDB. For an example configuration file, see
8783

8884
* - namespace.mapper
8985
- string
90-
- | The class name of the class that specifies which database or
91-
collection in which to sink the data. The
92-
``DefaultNamespaceMapper`` uses the ``database`` and ``collection``
93-
settings.
86+
- | The class name of the class that specifies which database or collection in which to sink the data. The ``DefaultNamespaceMapper`` uses the ``database`` and ``collection`` settings.
9487

95-
.. seealso::
88+
.. seealso::
9689

97-
- :ref:`FieldPathNamespaceMapper settings <fieldpathnamespacemapper-settings>`
90+
- :ref:`FieldPathNamespaceMapper settings <fieldpathnamespacemapper-settings>`
9891

9992
| **Default**: ``com.mongodb.kafka.connect.sink.namespace.mapping.DefaultNamespaceMapper``
100-
| **Accepted Values**: A fully qualified Java class name of a class
101-
that implements the ``NamespaceMapper`` interface.
93+
| **Accepted Values**: A fully qualified Java class name of a class that implements the ``NamespaceMapper`` interface.
10294

10395
* - document.id.strategy
10496
- string
@@ -229,9 +221,7 @@ data to sink to MongoDB. For an example configuration file, see
229221

230222
* - writemodel.strategy
231223
- string
232-
- | The class that specifies the ``WriteModel`` to use for :manual:`Bulk
233-
Writes </core/bulk-write-operations/index.html>`. See :ref:`Custom
234-
Write Model Strategy <custom-write-model-strategy>` for more information.
224+
- | The class that specifies the ``WriteModel`` to use for :manual:`Bulk Writes </core/bulk-write-operations/index.html>`. See :ref:`Custom Write Model Strategy <custom-write-model-strategy>` for more information.
235225
|
236226
| **Default**: ``com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneDefaultStrategy``
237227
| **Accepted Values**: A fully qualified Java class name of a class that implements ``WriteModelStrategy``
@@ -252,7 +242,7 @@ data to sink to MongoDB. For an example configuration file, see
252242
- int
253243
- | The maximum number of tasks that should be created for this connector. The connector may create fewer tasks if it cannot handle the specified level of parallelism.
254244

255-
.. important:: Messages May Be Processed Out of Order For Values Greater Than 1
245+
.. important:: Messages May Be Processed Out of Order for Values Greater Than 1
256246

257247
If you specify a value greater than ``1``, the connector
258248
enables parallel processing of the tasks. If your topic has
@@ -264,22 +254,14 @@ data to sink to MongoDB. For an example configuration file, see
264254

265255
* - heartbeat.interval.ms
266256
- int
267-
- | The length of time in milliseconds between sending heartbeat
268-
messages. Heartbeat messages contain the post batch resume token
269-
and are sent when no source records have been published in the
270-
specified interval. This improves the resumability of the
271-
connector for low volume namespaces. Use ``0`` to disable.
257+
- | The length of time in milliseconds between sending heartbeat messages. Heartbeat messages contain the post batch resume token and are sent when no source records have been published in the specified interval. This improves the resumability of the connector for low volume namespaces. Use ``0`` to disable.
272258
|
273259
| **Default**: ``0``
274260
| **Accepted Values**: An integer
275261

276262
* - heartbeat.topic.name
277263
- string
278-
- | The name of the topic to publish heartbeat messages to. To enable
279-
the heartbeat feature, you must provide a positive value in the
280-
``heartbeat.interval.ms`` setting. The user must consume
281-
messages on this topic to track the latest offset (post batch
282-
resume token).
264+
- | The name of the topic to publish heartbeat messages to. To enable the heartbeat feature, you must provide a positive value in the ``heartbeat.interval.ms`` setting. The user must consume messages on this topic to track the latest offset (post batch resume token).
283265
|
284266
| **Default**: ``__mongodb_heartbeats``
285267
| **Accepted Values**: A valid Kafka topic name
@@ -360,33 +342,25 @@ You can use the following settings to customize the behavior of the
360342

361343
* - namespace.mapper.key.database.field
362344
- string
363-
- | The name of the key document field that specifies the name of the
364-
database to write to.
345+
- | The name of the key document field that specifies the name of the database to write to.
365346

366347
* - namespace.mapper.key.collection.field
367348
- string
368-
- | The name of the key document field that specifies the name of the
369-
collection to write to.
349+
- | The name of the key document field that specifies the name of the collection to write to.
370350

371351
* - namespace.mapper.value.database.field
372352
- string
373-
- | The name of the value document field that specifies the name of
374-
the database to write to.
353+
- | The name of the value document field that specifies the name of the database to write to.
375354

376355
* - namespace.mapper.value.collection.field
377356
- string
378-
- | The name of the value document field that specifies the name of
379-
the collection to write to.
357+
- | The name of the value document field that specifies the name of the collection to write to.
380358

381359
* - namespace.mapper.error.if.invalid
382360
- boolean
383-
- | Whether to throw an exception if the document is missing the
384-
mapped field or if it contains an invalid BSON type.
385-
| When set to ``true``, the connector does not process the record
386-
and may halt or skip processing depending on the related settings.
387-
| When set to ``false`` and a document is missing the mapped field
388-
or if it contains an invalid BSON type, the connector defaults to
389-
writing to the specified ``database`` and ``collection`` settings.
361+
- | Whether to throw an exception if the document is missing the mapped field or if it contains an invalid BSON type.
362+
| When set to ``true``, the connector does not process the record and may halt or skip processing depending on the related settings.
363+
| When set to ``false`` and a document is missing the mapped field or if it contains an invalid BSON type, the connector defaults to writing to the specified ``database`` and ``collection`` settings.
390364
|
391365
| **Default**: ``false``
392366
| **Accepted Values**: ``true`` or ``false``
@@ -423,18 +397,13 @@ letter queue.
423397
:stub-columns: 1
424398
:widths: 2 1 4
425399

426-
427400
* - Name
428401
- Type
429402
- Description
430403

431404
* - errors.tolerance
432405
- string
433-
- | Whether to continue processing messages if an error is encountered.
434-
When set to ``none``, the connector reports an error and blocks
435-
further processing of the rest of the records when it encounters
436-
an error. When set to ``all``, the connector silently ignores any bad
437-
messages.
406+
- | Whether to continue processing messages if an error is encountered. When set to ``none``, the connector reports an error and blocks further processing of the rest of the records when it encounters an error. When set to ``all``, the connector silently ignores any bad messages.
438407
|
439408
| **Default:** "none"
440409
| **Accepted Values**: "none" or "all"

0 commit comments

Comments
 (0)