Skip to content

Commit 5521a48

Browse files
biniona-mongodbschmalliso
authored andcommitted
(DOCSP-19733) All Properties Pages (#219)
1 parent cece41e commit 5521a48

21 files changed

+428
-2
lines changed

source/sink-connector/configuration-properties.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ See the following categories for a list of related configuration properties:
7171
- Configure the connector to sink data to a MongoDB time series
7272
collection.
7373

74+
* - :doc:`All Properties </sink-connector/configuration-properties/all-properties>`
75+
- View all preceding categories of configuration properties on one page.
76+
7477
See the `Confluent Sink Connector documentation <https://docs.confluent.io/current/installation/configuration/connect/sink-connect-configs.html>`__
7578
for more information on these settings.
7679

@@ -88,4 +91,4 @@ for more information on these settings.
8891
Topic Override <sink-connector/configuration-properties/topic-override>
8992
Change Data Capture <sink-connector/configuration-properties/cdc>
9093
Time Series <sink-connector/configuration-properties/time-series>
91-
94+
All Properties <sink-connector/configuration-properties/all-properties>
Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
.. _sink-configuration-all-properties:
2+
3+
===========================================
4+
All Sink Connector Configuration 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+
On this page, you can view all available configuration properties
19+
for your {+sink-connector+}. This page duplicates the content of the
20+
other sink connector configuration properties pages.
21+
22+
To view a list of all sink connector configuration properties pages,
23+
see the :ref:`<kafka-sink-configuration-properties>` page.
24+
25+
MongoDB Connection
26+
------------------
27+
28+
.. include:: /sink-connector/configuration-properties/mongodb-connection.txt
29+
:start-after: sink-configuration-mongodb-connection-description-start
30+
:end-before: sink-configuration-mongodb-connection-description-end
31+
32+
To view only the options related to configuring your MongoDB connection,
33+
see the :ref:`<sink-configuration-mongodb-connection>` page.
34+
35+
.. include:: /sink-connector/configuration-properties/mongodb-connection.txt
36+
:start-after: sink-configuration-mongodb-connection-table-start
37+
:end-before: sink-configuration-mongodb-connection-table-end
38+
39+
MongoDB Namespace
40+
-----------------
41+
42+
.. include:: /sink-connector/configuration-properties/mongodb-namespace.txt
43+
:start-after: sink-configuration-namespace-mapping-description-start
44+
:end-before: sink-configuration-namespace-mapping-description-end
45+
46+
To view only the options related to specifying where the connector writes data,
47+
see the :ref:`<sink-configuration-namespace-mapping>` page.
48+
49+
.. include:: /sink-connector/configuration-properties/mongodb-namespace.txt
50+
:start-after: sink-configuration-namespace-mapping-table-start
51+
:end-before: sink-configuration-namespace-mapping-table-end
52+
53+
Connector Topic
54+
---------------
55+
56+
.. include:: /sink-connector/configuration-properties/kafka-topic.txt
57+
:start-after: sink-configuration-topic-properties-description-start
58+
:end-before: sink-configuration-topic-properties-description-end
59+
60+
To view only the options related to specifying Kafka topics, see the
61+
:ref:`<sink-configuration-topic-properties>` page.
62+
63+
.. include:: /sink-connector/configuration-properties/kafka-topic.txt
64+
:start-after: sink-configuration-topic-properties-table-start
65+
:end-before: sink-configuration-topic-properties-table-end
66+
67+
Connector Message Processing
68+
----------------------------
69+
70+
.. include:: /sink-connector/configuration-properties/connector-message.txt
71+
:start-after: sink-configuration-message-processing-description-start
72+
:end-before: sink-configuration-message-processing-description-end
73+
74+
To view only the options related to change data capture handlers, see the
75+
:ref:`<sink-configuration-message-processing>` page.
76+
77+
.. include:: /sink-connector/configuration-properties/connector-message.txt
78+
:start-after: sink-configuration-message-processing-table-start
79+
:end-before: sink-configuration-message-processing-table-end
80+
81+
Connector Error Handling
82+
------------------------
83+
84+
.. include:: /sink-connector/configuration-properties/error-handling.txt
85+
:start-after: sink-configuration-error-handling-description-start
86+
:end-before: sink-configuration-error-handling-description-end
87+
88+
To view only the options related to handling errors, see the
89+
:ref:`<sink-configuration-error-handling>` page.
90+
91+
.. include:: /sink-connector/configuration-properties/error-handling.txt
92+
:start-after: sink-configuration-error-handling-table-start
93+
:end-before: sink-configuration-error-handling-table-end
94+
95+
Post Processors
96+
---------------
97+
98+
.. include:: /sink-connector/configuration-properties/post-processors.txt
99+
:start-after: sink-configuration-post-processors-description-start
100+
:end-before: sink-configuration-post-processors-description-end
101+
102+
To view only the options related to post-processors, see the
103+
:ref:`<sink-configuration-post-processors>` page.
104+
105+
.. include:: /sink-connector/configuration-properties/post-processors.txt
106+
:start-after: sink-configuration-post-processors-table-start
107+
:end-before: sink-configuration-post-processors-table-end
108+
109+
ID Strategy
110+
-----------
111+
112+
.. include:: /sink-connector/configuration-properties/id-strategy.txt
113+
:start-after: sink-configuration-id-strategy-description-start
114+
:end-before: sink-configuration-id-strategy-description-end
115+
116+
To view only the options related to determining the ``_id`` field of your
117+
documents, see the :ref:`<sink-configuration-id-strategy>` page.
118+
119+
.. include:: /sink-connector/configuration-properties/id-strategy.txt
120+
:start-after: sink-configuration-id-strategy-table-start
121+
:end-before: sink-configuration-id-strategy-table-end
122+
123+
Write Model Strategy
124+
--------------------
125+
126+
.. include:: /sink-connector/configuration-properties/write-strategies.txt
127+
:start-after: sink-configuration-write-model-strategy-description-start
128+
:end-before: sink-configuration-write-model-strategy-description-end
129+
130+
To view only the options related to write model strategies, see the
131+
:ref:`<sink-configuration-write-model-strategy>` page.
132+
133+
.. include:: /sink-connector/configuration-properties/write-strategies.txt
134+
:start-after: sink-configuration-write-model-strategy-table-start
135+
:end-before: sink-configuration-write-model-strategy-table-end
136+
137+
Topic Override
138+
--------------
139+
140+
.. include:: /sink-connector/configuration-properties/topic-override.txt
141+
:start-after: sink-configuration-topic-override-description-start
142+
:end-before: sink-configuration-topic-override-description-end
143+
144+
To view only the options related to overriding topic settings, see the
145+
:ref:`<sink-configuration-topic-override>` page.
146+
147+
.. include:: /sink-connector/configuration-properties/topic-override.txt
148+
:start-after: sink-configuration-topic-override-table-start
149+
:end-before: sink-configuration-topic-override-table-end
150+
151+
Change Data Capture
152+
-------------------
153+
154+
.. include:: /sink-connector/configuration-properties/cdc.txt
155+
:start-after: sink-configuration-change-data-capture-description-start
156+
:end-before: sink-configuration-change-data-capture-description-end
157+
158+
To view only the options related to change data capture handlers, see the
159+
:ref:`<sink-configuration-change-data-capture>` page.
160+
161+
.. include:: /sink-connector/configuration-properties/cdc.txt
162+
:start-after: sink-configuration-change-data-capture-table-start
163+
:end-before: sink-configuration-change-data-capture-table-end
164+
165+
Time Series
166+
-----------
167+
168+
.. include:: /sink-connector/configuration-properties/time-series.txt
169+
:start-after: sink-configuration-time-series-description-start
170+
:end-before: sink-configuration-time-series-description-end
171+
172+
To view only the options related to time series collections, see the
173+
:ref:`<sink-configuration-time-series>` page.
174+
175+
.. include:: /sink-connector/configuration-properties/time-series.txt
176+
:start-after: sink-configuration-time-series-table-start
177+
:end-before: sink-configuration-time-series-table-end
178+

source/sink-connector/configuration-properties/cdc.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,24 @@ Change Data Capture Properties
1515
Overview
1616
--------
1717

18+
.. _sink-configuration-change-data-capture-description-start:
19+
1820
Use the following configuration settings to specify a class the sink
1921
connector uses to process change data capture (CDC) events.
2022

2123
See the guide on :doc:`Sink Connector Change Data Capture </sink-connector/fundamentals/change-data-capture>`
2224
for examples using the built-in ``ChangeStreamHandler`` and Debezium event
2325
producers.
2426

27+
.. _sink-configuration-change-data-capture-description-end:
28+
2529
.. include:: /includes/sink-config-link.rst
2630

2731
Settings
2832
--------
2933

34+
.. _sink-configuration-change-data-capture-table-start:
35+
3036
.. list-table::
3137
:header-rows: 1
3238
:widths: 25 75
@@ -45,3 +51,4 @@ Settings
4551
| **Accepted Values**: An empty string or a fully qualified Java
4652
class name
4753

54+
.. _sink-configuration-change-data-capture-table-end:

source/sink-connector/configuration-properties/connector-message.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _sink-configuration-message-processing:
2+
13
=======================================
24
Connector Message Processing Properties
35
=======================================
@@ -13,18 +15,24 @@ Connector Message Processing Properties
1315
Overview
1416
--------
1517

18+
.. _sink-configuration-message-processing-description-start:
19+
1620
Use the settings on this page to configure the message processing behavior of
1721
the sink connector including the following:
1822

1923
- Message batch size
2024
- Rate limits
2125
- Number of parallel tasks
2226

27+
.. _sink-configuration-message-processing-description-end:
28+
2329
.. include:: /includes/sink-config-link.rst
2430

2531
Settings
2632
--------
2733

34+
.. _sink-configuration-message-processing-table-start:
35+
2836
.. list-table::
2937
:header-rows: 1
3038
:widths: 25 75
@@ -101,3 +109,4 @@ Settings
101109
| **Default**: ``1``
102110
| **Accepted Values**: An integer.
103111

112+
.. _sink-configuration-message-processing-table-end:

source/sink-connector/configuration-properties/error-handling.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,20 @@ Connector Error Handling Properties
1515
Overview
1616
--------
1717

18+
.. _sink-configuration-error-handling-description-start:
19+
1820
Use the following configuration settings to specify how the sink connector
1921
handles errors and to configure the dead letter queue.
2022

23+
.. _sink-configuration-error-handling-description-end:
24+
2125
.. include:: /includes/sink-config-link.rst
2226

2327
Settings
2428
--------
2529

30+
.. _sink-configuration-error-handling-table-start:
31+
2632
.. list-table::
2733
:header-rows: 1
2834
:widths: 50 50
@@ -118,6 +124,7 @@ Settings
118124
| **Default:** ``3``
119125
| **Accepted Values**: A valid number of nodes
120126

127+
.. _sink-configuration-error-handling-table-end:
121128

122129
.. _sink-dead-letter-queue-configuration-example:
123130

source/sink-connector/configuration-properties/id-strategy.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _sink-configuration-id-strategy:
2+
13
=====================================
24
Sink Connector Id Strategy Properties
35
=====================================
@@ -13,14 +15,20 @@ Sink Connector Id Strategy Properties
1315
Overview
1416
--------
1517

18+
.. _sink-configuration-id-strategy-description-start:
19+
1620
Use the following configuration settings to specify how the sink connector
1721
should determine the ``_id`` value for each document it writes to MongoDB.
1822

23+
.. _sink-configuration-id-strategy-description-end:
24+
1925
.. include:: /includes/sink-config-link.rst
2026

2127
Settings
2228
--------
2329

30+
.. _sink-configuration-id-strategy-table-start:
31+
2432
.. list-table::
2533
:header-rows: 1
2634
:widths: 45 55
@@ -78,3 +86,4 @@ Settings
7886
| **Default**: ``false``
7987
| **Accepted Values**: ``true`` or ``false``
8088

89+
.. _sink-configuration-id-strategy-table-end:

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,20 @@ Kafka Topic Properties
1515
Overview
1616
--------
1717

18+
.. _sink-configuration-topic-properties-description-start:
19+
1820
Use the following configuration settings to specify which Kafka topics the
1921
sink connector should watch for data.
2022

23+
.. _sink-configuration-topic-properties-description-end:
24+
2125
.. include:: /includes/sink-config-link.rst
2226

2327
Settings
2428
--------
2529

30+
.. _sink-configuration-topic-properties-table-start:
31+
2632
.. list-table::
2733
:header-rows: 1
2834
:widths: 25 75
@@ -71,3 +77,4 @@ Settings
7177

7278
| **Accepted Values**: A valid regular expression pattern using ``java.util.regex.Pattern``.
7379

80+
.. _sink-configuration-topic-properties-table-end:

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _sink-configuration-mongodb-connection:
2+
13
===========================================
24
MongoDB Connection Configuration Properties
35
===========================================
@@ -13,14 +15,20 @@ MongoDB Connection Configuration Properties
1315
Overview
1416
--------
1517

18+
.. _sink-configuration-mongodb-connection-description-start:
19+
1620
Use the following configuration settings to specify how your sink
1721
connector connects and communicates with your MongoDB cluster.
1822

23+
.. _sink-configuration-mongodb-connection-description-end:
24+
1925
.. include:: /includes/sink-config-link.rst
2026

2127
Settings
2228
--------
2329

30+
.. _sink-configuration-mongodb-connection-table-start:
31+
2432
.. list-table::
2533
:header-rows: 1
2634
:widths: 30 70
@@ -103,3 +111,4 @@ Settings
103111
| **Default**: ``false``
104112
| **Accepted Values**: ``true`` or ``false``
105113

114+
.. _sink-configuration-mongodb-connection-table-end:

0 commit comments

Comments
 (0)