Skip to content

Commit d652fd6

Browse files
jdestefano-mongoschmalliso
authored andcommitted
DOCSP-11926 - Fix capitalization for BlockList and AllowList. (#37)
* DOCSP-11926 - Fix capitalization for BlockList and AllowList.
1 parent 97d83b5 commit d652fd6

File tree

2 files changed

+35
-34
lines changed

2 files changed

+35
-34
lines changed

source/kafka-sink-postprocessors.txt

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -44,26 +44,26 @@ class:
4444

4545
.. seealso:: :ref:`Strategy options and configuration <config-document-id-adder>`.
4646

47-
* - BlocklistKeyProjector
48-
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistKeyProjector``
47+
* - BlockListKeyProjector
48+
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlockListKeyProjector``
4949
| Removes matching key fields from the sink record.
5050

5151
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
5252

53-
* - BlocklistValueProjector
54-
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector``
53+
* - BlockListValueProjector
54+
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.BlockListValueProjector``
5555
| Removes matching value fields from the sink record.
5656

5757
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <blocklist-example>`.
5858

59-
* - AllowlistKeyProjector
60-
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistKeyProjector``
59+
* - AllowListKeyProjector
60+
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowListKeyProjector``
6161
| Includes only matching key fields from the sink record.
6262

6363
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
6464

65-
* - AllowlistValueProjector
66-
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowlistValueProjector``
65+
* - AllowListValueProjector
66+
- | Full Path: ``com.mongodb.kafka.connect.sink.processor.AllowListValueProjector``
6767
| matching value fields from the sink record.
6868

6969
.. seealso:: :ref:`Configuration <config-blocklist-allowlist>` and :ref:`Example <allowlist-example>`.
@@ -90,7 +90,7 @@ comma separated list of fully-qualified ``PostProcessor`` class names:
9090

9191
.. code-block:: properties
9292

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
9494

9595
.. note::
9696

@@ -148,12 +148,12 @@ provided with this connector:
148148

149149
* - PartialKeyStrategy
150150
- | 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``.
152152
| Defaults to a blank document if no key exists.
153153

154154
* - PartialValueStrategy
155155
- | 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``.
157157
| Defaults to a blank document if no value exists.
158158

159159
* - UuidProvidedInKeyStrategy
@@ -190,7 +190,7 @@ setting.
190190

191191
.. _config-blocklist-allowlist:
192192

193-
Blocklist / Allowlist Projector
193+
Block List / Allow List Projector
194194
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195195

196196
This section provides example projection configurations to show how they
@@ -235,16 +235,16 @@ filter the following sample record:
235235

236236
.. _blocklist-example:
237237

238-
Blocklist Projection Example
238+
Block List Projection Example
239239
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240240

241-
In the following example sink configuration, we specify a blocklist
241+
In the following example sink configuration, we specify a block list
242242
projection and the specific fields to omit from the record:
243243

244244
.. code-block:: properties
245245

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
248248
[key|value].projection.list=age,address.city,lut.key2,data.v
249249

250250
.. note::
@@ -283,16 +283,16 @@ The record contains the following data after applying the projection:
283283

284284
.. _allowlist-example:
285285

286-
Allowlist Projection Example
286+
Allow List Projection Example
287287
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
288288

289-
In the following example sink configuration, we specify a allowlist
289+
In the following example sink configuration, we specify an allow list
290290
projection and the specific fields to include in the record:
291291

292292
.. code-block:: properties
293293

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
296296
[key|value].projection.list=age,address.city,lut.key2,data.v
297297

298298
.. note::
@@ -359,15 +359,15 @@ projection output from the following sample record:
359359
}
360360
}
361361

362-
**Allowlist Wildcard Examples**
362+
**Allow List Wildcard Examples**
363363

364364
The ``*`` wildcard pattern in the example below matches all the keys named
365365
``temp`` in the ``forecast`` array and all fields nested a single level
366366
below it.
367367

368368
.. code-block:: properties
369369

370-
[key|value].projection.type=allowlist
370+
[key|value].projection.type=AllowList
371371
[key|value].projection.list=city,forecast.temp.*
372372

373373
The record contains the following data after applying the projection:
@@ -395,7 +395,7 @@ all levels that contain the field ``scale``.
395395

396396
.. code-block:: properties
397397

398-
[key|value].projection.type=allowlist
398+
[key|value].projection.type=AllowList
399399
[key|value].projection.list=**.scale
400400

401401
The record contains the following data after applying the projection:
@@ -410,15 +410,15 @@ The record contains the following data after applying the projection:
410410
}
411411
}
412412

413-
**Blocklist Wildcard Examples**
413+
**Block List Wildcard Examples**
414414

415415
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
417417
configuration example:
418418

419419
.. code-block:: properties
420420

421-
[key|value].projection.type=blocklist
421+
[key|value].projection.type=BlockList
422422
[key|value].projection.list=population,forecast.*.*
423423

424424
The record contains the following data after applying the projection:
@@ -442,7 +442,7 @@ specified.
442442

443443
.. code-block:: properties
444444

445-
[key|value].projection.type=blocklist
445+
[key|value].projection.type=BlockList
446446
[key|value].projection.list=**.high
447447

448448
{
@@ -724,7 +724,7 @@ file:
724724

725725
document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.PartialValueStrategy
726726
value.projection.list=flight_no,airport_code
727-
value.projection.type=allowlist
727+
value.projection.type=AllowList
728728
writemodel.strategy=com.mongodb.kafka.connect.sink.writemodel.strategy.ReplaceOneBusinessKeyStrategy"
729729

730730
The sample data inserted into the collection contains the following:
@@ -765,7 +765,7 @@ values without changing the ``_id`` field.
765765
The ``PartialValueStrategy`` id strategy uses the
766766
``[key|value].projection.type`` and ``[key|value].projection.list``
767767
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
769769
projection settings, they cannot be specified separately. Use a `Single
770770
Message Transform (SMT)
771771
<https://docs.confluent.io/current/connect/transforms/index.html>`_

source/kafka-sink-properties.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ data to sink to MongoDB. For an example configuration file, see
173173
- | The type of key projection to use.
174174
|
175175
| **Default**: ``none``
176-
| **Accepted Values**: ``none``, ``blocklist``, or ``allowlist`` (*Deprecated: blacklist, whitelist*)
176+
| **Accepted Values**: ``none``, ``BlockList``, or ``AllowList`` (*Deprecated: blacklist, whitelist*)
177177

178178
* - post.processor.chain
179179
- list
@@ -208,7 +208,7 @@ data to sink to MongoDB. For an example configuration file, see
208208
- | The type of value projection to use.
209209
|
210210
| **Default**: ``none``
211-
| **Accepted Values**: ``none``, ``blocklist``, or ``allowlist`` (*Deprecated: blacklist, whitelist*)
211+
| **Accepted Values**: ``none``, ``BlockList``, or ``AllowList`` (*Deprecated: blacklist, whitelist*)
212212

213213
* - writemodel.strategy
214214
- string
@@ -269,8 +269,8 @@ Example: Override Connector Sink Settings on TopicA
269269
topic.override.topicA.collection=collectionA
270270
topic.override.topicA.max.batch.size=100
271271
topic.override.topicA.document.id.strategy=com.mongodb.kafka.connect.sink.processor.id.strategy.UuidStrategy
272-
topic.override.topicA.post.processor.chain=com.mongodb.kafka.connect.sink.processor.DocumentIdAdder,com.mongodb.kafka.connect.sink.processor.BlocklistValueProjector
273-
topic.override.topicA.value.projection.type=blocklist
272+
topic.override.topicA.post.processor.chain=com.mongodb.kafka.connect.sink.processor.DocumentIdAdder,com.mongodb.kafka.connect.sink.processor.BlockListValueProjector
273+
topic.override.topicA.value.projection.type=BlockList
274274
topic.override.topicA.value.projection.list=k2,k4
275275

276276
The sink connector topic override settings instruct the connector to apply
@@ -279,7 +279,8 @@ the following behavior for data consumed from ``topicA``:
279279
- Write documents to the MongoDB collection ``collectionA`` in batches of
280280
up to 100.
281281
- Generate a UUID to be stored in the ``_id`` field for each new document.
282-
- Omit fields ``k2`` and ``k4`` from the value projection using a blocklist.
282+
- Omit fields ``k2`` and ``k4`` from the value projection using the
283+
``BlockList`` projection type.
283284

284285

285286
Dead Letter Queue Configuration Settings

0 commit comments

Comments
 (0)