Skip to content

Commit a152456

Browse files
biniona-mongodbschmalliso
authored andcommitted
(DOCSP-15806) Source Connector Overview (#179)
1 parent 42cc52f commit a152456

File tree

7 files changed

+59
-29
lines changed

7 files changed

+59
-29
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "kafka-connector"
22
title = "MongoDB Kafka Connector"
33
intersphinx = ["https://docs.mongodb.com/manual/objects.inv"]
4-
toc_landing_pages = ["/sink-connector", "/sink-connector/configuration-properties", "/source-connector/configuration-properties"]
4+
toc_landing_pages = ["/sink-connector", "/source-connector", "/sink-connector/configuration-properties", "/source-connector/configuration-properties"]
55

66
[constants]
77
mkc = "MongoDB Kafka Connector"

source/source-connector.txt

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
1-
======================
2-
Kafka Source Connector
3-
======================
1+
================
2+
Source Connector
3+
================
44

55
.. toctree::
66
:titlesonly:
77
:maxdepth: 1
88

99
Configuration Properties </source-connector/configuration-properties>
10-
Security and Authentication </source-connector/security-and-authentication>
1110
Usage Examples </source-connector/usage-examples>
1211
Fundamentals </source-connector/fundamentals>
1312

13+
.. default-domain:: mongodb
14+
15+
.. contents:: On this page
16+
:local:
17+
:backlinks: none
18+
:depth: 2
19+
:class: singlecol
20+
21+
Overview
22+
--------
23+
24+
This section focuses on the **{+source-connector+}**.
25+
The {+source-connector+} is a {+kc+} connector that reads data from MongoDB and
26+
writes data to {+ak+}.
27+
28+
Configuration Properties
29+
------------------------
30+
31+
To learn about configuration options for your source connector, see the
32+
:ref:`Configuration Properties <source-configuration-index>` section.
33+
34+
Usage Examples
35+
--------------
36+
37+
To view examples of source connector configurations, see the
38+
:ref:`Usage Examples <kafka-source-usage-examples>` section.
39+
40+
Fundamentals
41+
------------
42+
43+
To learn how features of the source connector work and how to configure them, see the
44+
:ref:`Fundamentals <kafka-source-fundamentals>` section.
Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
=============================
2-
Source Connector Fundamentals
3-
=============================
1+
.. _kafka-source-fundamentals:
2+
3+
============
4+
Fundamentals
5+
============
46

57
.. toctree::
68
:titlesonly:
79
:maxdepth: 1
810

911
Change Streams </source-connector/fundamentals/change-streams>
10-
Document Metadata </source-connector/fundamentals/document-metadata>
11-
Scaling Source Connectors </source-connector/fundamentals/scaling-source-connectors>
1212
Apply Schemas </source-connector/fundamentals/specify-schema>
1313

14-
asdf
14+
Read the following sections to learn how {+source-connector+} features work and
15+
how to configure them:
16+
17+
- :doc:`Receive Real-time Updates on Data Changes in MongoDB </source-connector/fundamentals/change-streams>`
18+
- :doc:`Apply Schemas to Documents </source-connector/fundamentals/specify-schema>`

source/source-connector/fundamentals/document-metadata.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

source/source-connector/fundamentals/scaling-source-connectors.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

source/source-connector/security-and-authentication.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

source/source-connector/usage-examples.txt

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
===============================
2-
Source Connector Usage Examples
3-
===============================
1+
.. _kafka-source-usage-examples:
2+
3+
==============
4+
Usage Examples
5+
==============
46

57
.. toctree::
68
:titlesonly:
@@ -12,3 +14,11 @@ Source Connector Usage Examples
1214
Copy Existing Data </source-connector/usage-examples/copy-existing-data>
1315
Specify a Schema </source-connector/usage-examples/schema>
1416

17+
Read the following sections to learn how to configure your {+source-connector+} to
18+
perform specific tasks:
19+
20+
- :doc:`Filter and Transform Your MongoDB Change Stream with an Aggregation Pipeline </source-connector/usage-examples/custom-pipeline>`
21+
- :doc:`Listen for Changes in Multiple MongoDB Collections </source-connector/usage-examples/multiple-sources>`
22+
- :doc:`Customize the Name of the Topic to which your Source Connector Publishes Records </source-connector/usage-examples/topic-naming>`
23+
- :doc:`Copy Data From a MongoDB Collection onto an {+ak+} Topic </source-connector/usage-examples/copy-existing-data>`
24+
- :doc:`Ensure Documents Processed by Your Source Connector Conform to a Schema </source-connector/usage-examples/schema>`

0 commit comments

Comments
 (0)