@@ -44,26 +44,26 @@ class:
44
44
45
45
.. seealso:: :ref:`Strategy options and configuration <config-document-id-adder>`.
46
46
47
- * - BlocklistKeyProjector
48
- - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistKeyProjector ``
47
+ * - BlockListKeyProjector
48
+ - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlockListKeyProjector ``
49
49
| Removes matching key fields from the sink record.
50
50
51
51
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
52
52
53
- * - BlocklistValueProjector
54
- - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector ``
53
+ * - BlockListValueProjector
54
+ - | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlockListValueProjector ``
55
55
| Removes matching value fields from the sink record.
56
56
57
57
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
58
58
59
- * - AllowlistKeyProjector
60
- - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistKeyProjector ``
59
+ * - AllowListKeyProjector
60
+ - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowListKeyProjector ``
61
61
| Includes only matching key fields from the sink record.
62
62
63
63
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
64
64
65
- * - AllowlistValueProjector
66
- - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector ``
65
+ * - AllowListValueProjector
66
+ - | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowListValueProjector ``
67
67
| matching value fields from the sink record.
68
68
69
69
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
@@ -90,7 +90,7 @@ comma separated list of fully-qualified ``PostProcessor`` class names:
90
90
91
91
.. code-block:: properties
92
92
93
- post.processor.chain=com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder,com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector
93
+ post.processor.chain=com.mongodb.kafka.connect.sink.processor.KafkaMetaAdder,com.mongodb.kafka.connect.sink.processor.AllowListValueProjector
94
94
95
95
.. note::
96
96
@@ -148,12 +148,12 @@ provided with this connector:
148
148
149
149
* - PartialKeyStrategy
150
150
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.id.strategy.PartialKeyStrategy``
151
- | Uses a blocklist or allowlist projection of the key structure of the ``SinkDocument``.
151
+ | Uses a block list or allow list projection of the key structure of the ``SinkDocument``.
152
152
| Defaults to a blank document if no key exists.
153
153
154
154
* - PartialValueStrategy
155
155
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy``
156
- | Uses a blocklist or allowlist projection of the value structure of the ``SinkDocument``.
156
+ | Uses a block list or allow list projection of the value structure of the ``SinkDocument``.
157
157
| Defaults to a blank document if no value exists.
158
158
159
159
* - UuidProvidedInKeyStrategy
@@ -190,7 +190,7 @@ setting.
190
190
191
191
.. _config-blocklist-allowlist:
192
192
193
- Blocklist / Allowlist Projector
193
+ Block List / Allow List Projector
194
194
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195
195
196
196
This section provides example projection configurations to show how they
@@ -235,16 +235,16 @@ filter the following sample record:
235
235
236
236
.. _blocklist-example:
237
237
238
- Blocklist Projection Example
238
+ Block List Projection Example
239
239
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240
240
241
- In the following example sink configuration, we specify a blocklist
241
+ In the following example sink configuration, we specify a block list
242
242
projection and the specific fields to omit from the record:
243
243
244
244
.. code-block:: properties
245
245
246
- post.processor.chain=com.mongodb.kafka.connect.sink.processor.Blocklist [Key|Value]Projector
247
- [key|value].projection.type=blocklist
246
+ post.processor.chain=com.mongodb.kafka.connect.sink.processor.BlockList [Key|Value]Projector
247
+ [key|value].projection.type=BlockList
248
248
[key|value].projection.list=age,address.city,lut.key2,data.v
249
249
250
250
.. note::
@@ -283,16 +283,16 @@ The record contains the following data after applying the projection:
283
283
284
284
.. _allowlist-example:
285
285
286
- Allowlist Projection Example
286
+ Allow List Projection Example
287
287
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
288
288
289
- In the following example sink configuration, we specify a allowlist
289
+ In the following example sink configuration, we specify an allow list
290
290
projection and the specific fields to include in the record:
291
291
292
292
.. code-block:: properties
293
293
294
- post.processor.chain=com.mongodb.kafka.connect.sink.processor.Allowlist [Key|Value]Projector
295
- [key|value].projection.type=allowlist
294
+ post.processor.chain=com.mongodb.kafka.connect.sink.processor.AllowList [Key|Value]Projector
295
+ [key|value].projection.type=AllowList
296
296
[key|value].projection.list=age,address.city,lut.key2,data.v
297
297
298
298
.. note::
@@ -359,15 +359,15 @@ projection output from the following sample record:
359
359
}
360
360
}
361
361
362
- **Allowlist Wildcard Examples**
362
+ **Allow List Wildcard Examples**
363
363
364
364
The ``*`` wildcard pattern in the example below matches all the keys named
365
365
``temp`` in the ``forecast`` array and all fields nested a single level
366
366
below it.
367
367
368
368
.. code-block:: properties
369
369
370
- [key|value].projection.type=allowlist
370
+ [key|value].projection.type=AllowList
371
371
[key|value].projection.list=city,forecast.temp.*
372
372
373
373
The record contains the following data after applying the projection:
@@ -395,7 +395,7 @@ all levels that contain the field ``scale``.
395
395
396
396
.. code-block:: properties
397
397
398
- [key|value].projection.type=allowlist
398
+ [key|value].projection.type=AllowList
399
399
[key|value].projection.list=**.scale
400
400
401
401
The record contains the following data after applying the projection:
@@ -410,15 +410,15 @@ The record contains the following data after applying the projection:
410
410
}
411
411
}
412
412
413
- **Blocklist Wildcard Examples**
413
+ **Block List Wildcard Examples**
414
414
415
415
The wildcard character can also be used to match all field names at
416
- specific levels as demonstrated in the following blocklist projection
416
+ specific levels as demonstrated in the following block list projection
417
417
configuration example:
418
418
419
419
.. code-block:: properties
420
420
421
- [key|value].projection.type=blocklist
421
+ [key|value].projection.type=BlockList
422
422
[key|value].projection.list=population,forecast.*.*
423
423
424
424
The record contains the following data after applying the projection:
@@ -442,7 +442,7 @@ specified.
442
442
443
443
.. code-block:: properties
444
444
445
- [key|value].projection.type=blocklist
445
+ [key|value].projection.type=BlockList
446
446
[key|value].projection.list=**.high
447
447
448
448
{
@@ -724,7 +724,7 @@ file:
724
724
725
725
document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy
726
726
value.projection.list=flight_no,airport_code
727
- value.projection.type=allowlist
727
+ value.projection.type=AllowList
728
728
writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneBusinessKeyStrategy"
729
729
730
730
The sample data inserted into the collection contains the following:
@@ -765,7 +765,7 @@ values without changing the ``_id`` field.
765
765
The ``PartialValueStrategy`` id strategy uses the
766
766
``[key|value].projection.type`` and ``[key|value].projection.list``
767
767
settings to define which fields are used to form the ``_id`` field.
768
- Since the Blocklist and Allowlist post processors use the same
768
+ Since the Block List and Allow List post processors use the same
769
769
projection settings, they cannot be specified separately. Use a `Single
770
770
Message Transform (SMT)
771
771
<https://docs.confluent.io/current/connect/transforms/index.html>`_
0 commit comments