You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/kafka-sink-properties.txt
+19-50Lines changed: 19 additions & 50 deletions
Original file line number
Diff line number
Diff line change
@@ -42,10 +42,7 @@ data to sink to MongoDB. For an example configuration file, see
42
42
* - topics.regex
43
43
- string
44
44
- | 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":
49
46
50
47
.. code-block:: none
51
48
@@ -58,13 +55,12 @@ data to sink to MongoDB. For an example configuration file, see
58
55
* - connection.uri
59
56
- string
60
57
- | A :manual:`MongoDB connection URI string </reference/connection-string/#standard-connection-string-format>`.
61
-
58
+
62
59
.. code-block:: none
63
60
64
61
mongodb://username:password@localhost/
65
62
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>`.
68
64
69
65
.. include:: /includes/externalize-secrets.rst
70
66
@@ -87,18 +83,14 @@ data to sink to MongoDB. For an example configuration file, see
87
83
88
84
* - namespace.mapper
89
85
- 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.
| **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.
102
94
103
95
* - document.id.strategy
104
96
- string
@@ -229,9 +221,7 @@ data to sink to MongoDB. For an example configuration file, see
229
221
230
222
* - writemodel.strategy
231
223
- 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.
| **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
252
242
- int
253
243
- | 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.
254
244
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
256
246
257
247
If you specify a value greater than ``1``, the connector
258
248
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
264
254
265
255
* - heartbeat.interval.ms
266
256
- 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.
272
258
|
273
259
| **Default**: ``0``
274
260
| **Accepted Values**: An integer
275
261
276
262
* - heartbeat.topic.name
277
263
- 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).
283
265
|
284
266
| **Default**: ``__mongodb_heartbeats``
285
267
| **Accepted Values**: A valid Kafka topic name
@@ -360,33 +342,25 @@ You can use the following settings to customize the behavior of the
360
342
361
343
* - namespace.mapper.key.database.field
362
344
- 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.
365
346
366
347
* - namespace.mapper.key.collection.field
367
348
- 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.
370
350
371
351
* - namespace.mapper.value.database.field
372
352
- 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.
375
354
376
355
* - namespace.mapper.value.collection.field
377
356
- 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.
380
358
381
359
* - namespace.mapper.error.if.invalid
382
360
- 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.
390
364
|
391
365
| **Default**: ``false``
392
366
| **Accepted Values**: ``true`` or ``false``
@@ -423,18 +397,13 @@ letter queue.
423
397
:stub-columns: 1
424
398
:widths: 2 1 4
425
399
426
-
427
400
* - Name
428
401
- Type
429
402
- Description
430
403
431
404
* - errors.tolerance
432
405
- 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.
0 commit comments