Skip to content

Commit 45af927

Browse files
biniona-mongodbschmalliso
authored andcommitted
(DOCSP-20664) Topic Separator (#229)
1 parent ea0c569 commit 45af927

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

source/source-connector/configuration-properties/kafka-topic.txt

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ Settings
7070
- | **Type:** string
7171
|
7272
| **Description:**
73-
| Specifies a JSON mapping between change stream document namespaces
73+
| Specifies a JSON mapping between change stream document
74+
:manual:`namespaces </reference/glossary/#std-term-namespace>`
7475
and topic names.
7576

7677
.. example::
@@ -103,6 +104,48 @@ Settings
103104
| **Default**: ""
104105
| **Accepted Values**: A valid JSON object
105106

107+
* - | **topic.separator**
108+
- | **Type:** string
109+
|
110+
| **Description:**
111+
| Specifies the string the connector uses to concatenate the values used
112+
to create the name of your topic. The connector publishes records to a
113+
topic with a name formed by concatenating the values of the following fields
114+
in the following order:
115+
116+
#. ``topic.prefix``
117+
#. ``database``
118+
#. ``collection``
119+
#. ``topic.suffix``
120+
121+
.. example::
122+
123+
The following configuration instructs the connector to publish
124+
change stream documents from the ``coll`` collection of the
125+
``db`` database to the ``prefix-db-coll``
126+
topic:
127+
128+
.. code-block:: properties
129+
:copyable: false
130+
131+
topic.prefix=prefix
132+
database=db
133+
collection=coll
134+
topic.separator=-
135+
136+
.. important:: Topic Separator and Topic Namespace Map
137+
138+
When you use the ``topic.separator`` property, keep in mind that it
139+
does not affect how you define the ``topic.namespace.map`` property.
140+
The ``topic.namespace.map`` property uses MongoDB
141+
:manual:`namespaces </reference/glossary/#std-term-namespace>`
142+
which you must always specify with a ``"."`` character to separate
143+
the database and collection name.
144+
145+
|
146+
| **Default**: ``"."``
147+
| **Accepted Values**: A string
148+
106149
* - | **topic.mapper**
107150
- | **Type:** string
108151
|

0 commit comments

Comments
 (0)