Skip to content

Commit

Permalink
(DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition i…
Browse files Browse the repository at this point in the history
…n table.
  • Loading branch information
your proper name committed Oct 4, 2024
1 parent 6fa0ae5 commit 077ac47
Showing 1 changed file with 29 additions and 42 deletions.
71 changes: 29 additions & 42 deletions source/source-connector/configuration-properties/kafka-topic.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,9 @@ Settings
The destination topic name is composed of the ``topic.prefix``
value followed by the database and collection names, separated by the value
specified in the ``topic.separator`` property.

.. seealso::

:ref:`Topic Naming Prefix <source-usage-example-topic-naming>`
usage example

|
| To learn more, see the example in :ref:`Topic Naming Prefix <topic-naming-prefix-example>`.
|
| **Default**: ``""``
| **Accepted Values**: A string composed of ASCII alphanumeric
characters including ".", "-", and "_"
Expand All @@ -69,12 +66,9 @@ Settings
The destination topic name is composed of the database and
collection names followed by the ``topic.suffix`` value,
separated by the value specified in the ``topic.separator`` property.

.. seealso::

:ref:`Topic Naming Suffix <source-usage-example-topic-naming>`
usage example

|
| To learn more, see the example in :ref:`Topic Naming Suffix <topic-naming-suffix-example>`.
|
| **Default**: ``""``
| **Accepted Values**: A string composed of ASCII alphanumeric
characters including ".", "-", and "_"
Expand All @@ -86,16 +80,14 @@ Settings
| Specifies a JSON mapping between change stream document
:manual:`namespaces </reference/glossary/#std-term-namespace>`
and topic names.

.. tip:: Namespace Mapping Behavior

You can specify complex mappings by using the
``topic.namespace.map`` property. This property supports regex
and wildcard matching. To learn more about these behaviors and
view examples, see the :ref:`Topic Namespace Map
<topic-naming-namespace-map>` section of the Topic Naming
page.

|
| You can specify complex mappings by using the
``topic.namespace.map`` property. This property supports regex
and wildcard matching. To learn more about these behaviors and
view examples, see the :ref:`Topic Namespace Map
<topic-naming-namespace-map>` section of the Topic Naming
page.
|
| **Default**: ``""``
| **Accepted Values**: A valid JSON object

Expand All @@ -113,29 +105,24 @@ Settings
#. ``collection``
#. ``topic.suffix``

.. example::

The following configuration instructs the connector to publish
change stream documents from the ``coll`` collection of the
``db`` database to the ``prefix-db-coll``
topic:
| For example, the following configuration instructs the connector to publish
change stream documents from the ``coll`` collection of the
``db`` database to the ``prefix-db-coll`` topic:

.. code-block:: properties
:copyable: false
.. code-block:: properties
:copyable: false

topic.prefix=prefix
database=db
collection=coll
topic.separator=-
topic.prefix=prefix
database=db
collection=coll
topic.separator=-

.. important:: Topic Separator and Topic Namespace Map

When you use the ``topic.separator`` property, keep in mind that it
does not affect how you define the ``topic.namespace.map`` property.
The ``topic.namespace.map`` property uses MongoDB
:manual:`namespaces </reference/glossary/#std-term-namespace>`
which you must always specify with a ``"."`` character to separate
the database and collection name.
| :gold:`IMPORTANT:` When you use the ``topic.separator`` property, keep in mind that it

Check failure on line 120 in source/source-connector/configuration-properties/kafka-topic.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules

[vale] reported by reviewdog 🐶 [MongoDB.ConciseTerms] 'remember' is preferred over 'keep in mind'. Raw Output: {"message": "[MongoDB.ConciseTerms] 'remember' is preferred over 'keep in mind'.", "location": {"path": "source/source-connector/configuration-properties/kafka-topic.txt", "range": {"start": {"line": 120, "column": 76}}}, "severity": "ERROR"}
does not affect how you define the ``topic.namespace.map`` property.
The ``topic.namespace.map`` property uses MongoDB
:manual:`namespaces </reference/glossary/#std-term-namespace>`
which you must always specify with a ``.`` character to separate
the database and collection name.

|
| **Default**: ``"."``
Expand Down

0 comments on commit 077ac47

Please sign in to comment.