Skip to content

Update mongo-cdc.md #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juanpardo wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update mongo-cdc.md #119

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5dad7de
Update mongo-cdc.md
juanpardo Feb 11, 2026
443f60f
Update docs/cluster/integrations/mongo-cdc.md
juanpardo Feb 13, 2026
9853171
Update docs/cluster/integrations/mongo-cdc.md
juanpardo Feb 13, 2026
0fcc0cc
Added steppers
juanpardo Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 27 additions & 55 deletions docs/cluster/integrations/mongo-cdc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
(integrations-mongo-cdc)=
# MongoDB CDC (Preview)
# MongoDB CDC

CrateDB Cloud enables continuous data ingestion from MongoDB using Change Data
Capture (CDC), providing seamless, real-time synchronization of your data.

:::{caution}
This integration is currently in preview and may have restricted availability.
For more information, please [contact us](https://cratedb.com/contact).
:::

## Key Concepts

The MongoDB CDC integration in CrateDB Cloud allows you to keep your data
Expand Down Expand Up @@ -54,25 +49,28 @@ Supported authentication methods:

The following steps should be performed in the MongoDB Atlas UI.

#### Step 1: Create a Custom Role
:::::{stepper}
#### Create a Custom Role
1. **Navigate to Database Access**
Go to **Database Access** in the MongoDB Atlas UI for the cluster you want to
connect to CrateDB Cloud.

2. **Add a Custom Role**
Under **Custom Roles**, click **Add New Custom Role**.
Under **Custom Roles**, click **Add New Custom Role**. A form will appear.

3. Fill in the Custom Role Name - For example, use CrateDB CDC integration.

3. **Set Up Read-Only Access**
4. **Set Up Read-Only Access**
Assign the following actions or roles to the custom role:
- `find`
- `changeStream`
- `collStats`
- `find`, to be found under Collection Actions/Query and Write Actions
- `changeStream`, to be found under Collection Actions/Change Stream Actions
- `collStats`, to be found under Collection Actions/Diagnostic Actions

Specify the databases and collections for these actions. You can update
access permissions in the MongoDB Atlas UI later if needed.


#### Step 2: Create a User
#### Create a User

Depending on whether you plan to use SCRAM or X.509 authentication, create a
database user with one of the following methods:
Expand Down Expand Up @@ -113,7 +111,7 @@ database user with one of the following methods:
:::


#### Step 3: Configure IP Access
#### Configure IP Access

To allow CrateDB Cloud to access your MongoDB Atlas cluster, you must add the
CrateDB Cloud IP addresses to the IP Access List in MongoDB Atlas.
Expand All @@ -124,34 +122,15 @@ CrateDB Cloud IP addresses to the IP Access List in MongoDB Atlas.
2. **Add IP Address**
Click **Add IP Address** and choose an IP address or range to allow access.
For testing purposes, you can select **Allow Access from Anywhere**, but for
production, it is recommended to specify only the required IPs.

:::{note}
The specific IP addresses depend on the region of your CrateDB Cloud cluster.
These IP addresses can also be found in the **Connection Details** section of the
CrateDB Cloud Console, just before you click **Test Connection** during the
setup process.

**Outbound IP Addresses**:

| Cloud Provider | Region | IP Addresses |
|----------------|---------------|---------------------------------|
| Azure | East US 2 | `52.184.241.228/32`, `52.254.31.90/32` |
| Azure | West Europe | `51.105.153.175/32`, `108.142.34.5/32` |
| AWS | EU West 1 | `34.255.75.224` |
| AWS | US East 1 | `54.197.229.58` |
| AWS | US West 2 | `54.189.16.20` |
| GCP | US Central 1 | `34.69.134.49` |

:::
production, it is recommended to specify only the required IPs. The form will show you the specific IP addresses you need to allow.

:::{note}
To set up a PrivateLink connection for the Mongo CDC integration, please reach
out to our support team.
:::


#### Step 4: Access Connection String
#### Access Connection String

You'll need to provide the connection string for your MongoDB Atlas cluster so
that CrateDB Cloud can connect to it.
Expand Down Expand Up @@ -186,18 +165,18 @@ mongodb+srv:///?authMechanism=MONGODB-X509&retryWrites=true&w=majority
Make sure to upload the X.509 certificate file when configuring the connection
in CrateDB Cloud.
:::


:::::

### Set Up Integration in CrateDB Cloud

Follow these steps in the CrateDB Cloud Console to set up the MongoDB CDC integration:

#### Step 1: Create an Integration
:::::{stepper}
#### Create an Integration
1. Navigate to the **Import** section in the CrateDB Cloud Console.
2. Click **Create Integration** and select **MongoDB** as the source type.

#### Step 2: Configure Connection
#### Configure Connection
1. Choose **Create New Connection** or select an existing one.
2. Fill in the following details:
:::{tab} SCRAM Auhentication
Copy link

@coderabbitai coderabbitai bot Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Fix typo: "Auhentication" → "Authentication".

The word "Authentication" is misspelled in the tab label.

✏️ Fix spelling error 
-   :::{tab} SCRAM Auhentication
+   :::{tab} SCRAM Authentication
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:::{tab} SCRAM Auhentication
:::{tab} SCRAM Authentication
🧰 Tools
🪛 LanguageTool

[grammar] ~182-~182: Ensure spelling is correct
Context: ...he following details: :::{tab} SCRAM Auhentication - Connection Name: Provide a unique name...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
In `@docs/cluster/integrations/mongo-cdc.md` at line 182, Fix the typo in the tab
label by replacing the string "SCRAM Auhentication" with "SCRAM Authentication"
so the tab header is spelled correctly; update the exact label text used in the
documentation (the "SCRAM Auhentication" token) to "SCRAM Authentication".

Expand All @@ -214,15 +193,15 @@ Follow these steps in the CrateDB Cloud Console to set up the MongoDB CDC integr
- **Default Database**: Specify the default database to use for this connection.
:::

#### Step 3: Test the Connection
#### Test the Connection
Click **Test Connection** to verify CrateDB Cloud can connect to your MongoDB
Atlas cluster. Resolve any issues if the test fails.

#### Step 4: Select Collection
#### Select Collection
Enter the database and collection name from your MongoDB Atlas cluster, that you
want to sync with CrateDB Cloud.

#### Step 5: Select Target Table
#### Select Target Table
1. Specify the target table in your CrateDB Cloud cluster where the data will be synced.
2. MongoDB records will be inserted into an object column called `document`.
3. Select the object type for the column:
Expand All @@ -234,32 +213,26 @@ want to sync with CrateDB Cloud.
However, selecting `dynamic` provides faster query performance by utilizing indexes and columnar storage.
:::

#### Step 6: Configure Integration Settings
#### Configure Integration Settings
1. Enter a name for the integration.
2. Select the integration mode:
- **Full Load Only**: Imports the data once but doesn’t sync changes.
- **Full Load and CDC**: Imports the data and syncs changes in real-time.
- **CDC Only**: Syncs only new changes in real-time without importing existing data.

#### Step 7: Create the Integration
#### Create the Integration
Click **Create Integration** to finalize the setup. CrateDB Cloud will now sync
your MongoDB data based on the selected settings.

:::::
---

## Limitations

The MongoDB CDC integration is available as a preview. The feature is stable
enough for broader use but may still have limitations, known issues, or
incomplete features. While suitable for many use cases, it is not yet
recommended for mission-critical workloads.


### Column Name Restrictions

Column or property names containing square brackets (`[]`) are not supported and
are replaced with `__openbrk__` and `__closebrk__` respectively. Likewise, column
names containing dots (`.`) are not supported and are replaced with (`__dot__`).
are replaced with `_obkt_` and `_cbkt_` respectively. Likewise, column
names containing dots (`.`) are not supported and are replaced with `_dot_`.

:::{warning}
This behavior may change in future releases.
Expand All @@ -275,5 +248,4 @@ CDC integration:
value.
- **Binary data types** other than UUIDs, which are converted to `TEXT` and
**vectors**, which are converted to `ARRAY`s of numbers.
- The `Decimal128` data type is not supported and is converted to a string, as
CrateDB does not support a decimal data type.
- The `Decimal128` data type is not supported and is converted to a string.