Skip to content

Commit 8eb9bb9

Browse files
Chris Choschmalliso
Chris Cho
authored and
schmalliso
committed
DOCSP-18340 source properties connection (#137)
* DOCSP-15807: source configuration connection properties
1 parent f8ac40f commit 8eb9bb9

File tree

6 files changed

+130
-8
lines changed

6 files changed

+130
-8
lines changed

‎source/sink-connector/configuration-properties/topic-override.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,4 @@ the following for data consumed from ``topicA``:
7878
``BlockList`` projection type.
7979

8080
For an example of how to configure the Block List Projector, see the
81-
(TODO: link to Sink Post-Processors Block List Projector section).
82-
81+
(TODO: Sink Post-Processors guide).

‎source/source-connector.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,3 @@ Kafka Source Connector
1111
Usage Examples </source-connector/usage-examples>
1212
Fundamentals </source-connector/fundamentals>
1313

14-
asdf

‎source/source-connector/configuration-properties.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _source-configuration-index:
2+
13
=========================================
24
Source Connector Configuration Properties
35
=========================================
@@ -30,20 +32,23 @@ See the following categories for a list of related configuration properties:
3032
* - Category
3133
- Description
3234

33-
* - :doc:`Change Stream Properties </source-connector/configuration-properties/change-stream>`
35+
* - :ref:`MongoDB Connection Properties <source-configuration-mongodb-connection>`
36+
- Specify how to connect to your MongoDB cluster.
37+
38+
* - :ref:`Change Stream Properties <source-configuration-change-stream>`
3439
- Specify your change stream pipelines and cursor settings.
3540

41+
3642
See the `Confluent Source Connector configuration documentation <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html>`__
3743
for more information on these settings.
3844

3945
.. toctree::
4046
:caption: Sink Connector Configuration Properties
4147

48+
MongoDB Connection </source-connector/configuration-properties/mongodb-connection>
4249
Change Stream Properties </source-connector/configuration-properties/change-stream>
4350

4451
..
45-
- Connection
4652
- Document/Data Format
4753
- Kafka Topic
4854
- Error Handling and Resume Options
49-

‎source/source-connector/configuration-properties/change-stream.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _source-configuration-change-stream:
2+
13
========================
24
Change Stream Properties
35
========================
@@ -65,6 +67,7 @@ Settings
6567
For more information on how this change stream option works, see
6668
the MongoDB server manual guide on :manual:`Lookup Full Document for
6769
Update Operations </changeStreams/#lookup-full-document-for-update-operations>`.
70+
6871
|
6972
| **Default**: ``""``
7073
| **Accepted Values**: ``""`` or ``"default"`` or ``"updateLookup"``

‎source/source-connector/configuration-properties/mongodb-connection.txt

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
.. _source-configuration-mongodb-connection:
2+
3+
====================================
4+
MongoDB Source Connection Properties
5+
====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
Overview
16+
--------
17+
18+
Use the following configuration settings to specify how your sink
19+
connector establishes a connection and communicates with your MongoDB cluster.
20+
21+
.. include:: /includes/source-config-link.rst
22+
23+
Settings
24+
--------
25+
26+
.. list-table::
27+
:header-rows: 1
28+
:widths: 40 60
29+
30+
* - Name
31+
- Description
32+
33+
* - **connection.uri**
34+
- | *Required*
35+
|
36+
| **Type:** string
37+
|
38+
| **Description:**
39+
| The :manual:`URI connection string </reference/connection-string/#standard-connection-string-format>`
40+
to connect to your MongoDB instance or cluster.
41+
| For more information, see the (TODO: Connect your Kafka Connector
42+
to MongoDB page link) guide
43+
44+
.. include:: /includes/externalize-secrets.rst
45+
46+
| **Default**: ``mongodb://localhost:27017,localhost:27018,localhost:27019``
47+
| **Accepted Values**: A MongoDB URI connection string
48+
49+
* - | **database**
50+
- | **Type:** string
51+
|
52+
| **Description:**
53+
| Name of the database to watch for changes. If not set, the connector
54+
watches all databases for changes.
55+
|
56+
| **Default**: ""
57+
| **Accepted Values**: A single database name
58+
59+
* - | **collection**
60+
- | **Type:** string
61+
|
62+
| **Description:**
63+
| Name of the collection in the database to watch for changes. If not
64+
set, the connector watches all collections for changes.
65+
66+
.. important::
67+
68+
If your ``database`` configuration is set to ``""``, the connector
69+
ignores the ``collection`` setting.
70+
71+
|
72+
| **Default**: ""
73+
| **Accepted Values**: A single collection name
74+
75+
* - **server.api.version**
76+
- | **Type:** string
77+
|
78+
| **Description:**
79+
| The Versioned API version you want to use with your MongoDB
80+
cluster. For more information on the Versioned API and versions of
81+
MongoDB Server that support it, see the :manual:`Versioned API </reference/versioned-api/>`
82+
guide.
83+
|
84+
| **Default**: ``""``
85+
| **Accepted Values**: An empty string or a valid Versioned API version.
86+
87+
* - **server.api.deprecationErrors**
88+
- | **Type:** boolean
89+
|
90+
| **Description:**
91+
| When set to ``true``, if the connector calls a command on your
92+
MongoDB instance that's deprecated in the declared Versioned API
93+
version, it raises an exception.
94+
| You can set the API version with the ``server.api.version``
95+
configuration option. For more information on the Versioned API, see
96+
the MongoDB manual entry on the
97+
:manual:`Versioned API </reference/versioned-api/>`.
98+
|
99+
| **Default**: ``false``
100+
| **Accepted Values**: ``true`` or ``false``
101+
102+
* - **server.api.strict**
103+
- | **Type:** boolean
104+
|
105+
| **Description:**
106+
| When set to ``true``, if the connector calls a command on your
107+
MongoDB instance that's not covered in the declared Versioned API
108+
version, it raises an exception.
109+
| You can set the API version with the ``server.api.version``
110+
configuration option. For more information on the Versioned API, see
111+
the MongoDB manual entry on the
112+
:manual:`Versioned API </reference/versioned-api/>`.
113+
|
114+
| **Default**: ``false``
115+
| **Accepted Values**: ``true`` or ``false``
116+

‎source/troubleshooting/recover-from-invalid-resume-token.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ To configure your source connector to temporarily tolerate errors:
102102
.. TODO: <Confirm linked page discusses errors.tolerance once it's written>
103103
.. TODO: update doc link to ref once page is written
104104

105-
For more information on the ``errors.tolerance`` option, see the
106-
:doc:`guide on source connector configuration properties </source-connector/configuration-properties>`.
105+
For more information on the ``errors.tolerance`` option, see the guide on
106+
:ref:`source connector configuration properties <source-configuration-index>`.
107107

108108
.. _troubleshoot-delete-stored-offsets:
109109

0 commit comments

Comments
 (0)