> For the complete documentation index, see [llms.txt](https://docs.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.collibra.com/data-quality-self-hosted/connections/supported-connections/supported-jdbc-data-sources/connecting-to-mongodb.md). # Connecting to MongoDB This section contains details for MongoDB connections. Select an option from the dropdown menu to display information for a particular driver class. {% tabs %} {% tab title="Native" %} ## General information
FieldDescription
Data sourceMongoDB
Supported version3.12.11
Connection stringjdbc:mongodb://
Packaged? No
Certified? No
Supported features
Estimate job Yes
Analyze data Yes
Schedule Yes
Processing capabilities
Pushdown No
Spark agent Yes
Yarn agent Yes
Parallel JDBC No
Java Platform version compatibility
JDK 8 Yes
JDK 11 Yes
## Minimum user permissions In order to bring your MongoDB data into Data Quality & Observability (self-hosted), you need the following permissions. * Read access on your MongoDB tables. * ROLE\_ADMIN assigned to your user in Collibra DQ. ## Recommended and required connection properties | Required | Connection Property | Type | Value | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Yes | Name | Text | The unique name of your connection. Ensure that there are no spaces in your connection name. | | Yes | Connection URL | String |

The connection string path of your MongoDB connection.

For successful job execution, you must first configure a Spark Scratch Directory to allocate space for a schema cache. After you configure the Spark Scratch Directory, add to the connection string the temporary writable location schema=/tmp/scratch/${mongo\_example\_file\_name.xml} for the schema cache to write, as shown in the example below. Replace ${mongo\_example\_file\_name.xml} with the file name corresponding to the database name.

When referring to the example below, replace the ${value} sections of the connection URL with your actual value.

:glasses-round: Example: jdbc:mongodb://${host}.mongodb.net?AuthDatabase=admin\&AuthScheme=SCRAM-SHA-1\&UseSSL=true\&schema=/tmp/scratch/${mongo\_example\_file\_name.xml}

| | Yes | Driver Name | String |

The driver class name used for your connection.

mongodb.jdbc.MongoDriver

| | Yes | Port | Integer |

The port number to establish a connection to the datasource.

The default port is 443

| | No | Limit Schemas | Option |

Allows you to manage usage and restrict visibility to only the necessary schemas in the Explorer tree.

See Limiting schemas to learn how to limit schemas from the Connection Management page.

When you include a restricted schema in the query of a DQ Job, the query scope may be overwritten when the job runs. While only the schemas you selected when you set up the connection are shown in the Explorer menu, users are not restricted from running SQL queries on any schema from the data source.

| | No | Source Name | String | N/A | | No | Target Agent | Option | The [Agent](/data-quality-self-hosted/installation/agent.md) used to submit your DQ Job. | | Yes | Auth Type | Option |

The method to authenticate your connection.

The configuration requirements are different depending on the Auth Type you select. See Authentication for more details on available authentication types.

| | No | Properties | String | The configurable driver properties for your connection. Multiple properties must be semicolon-delimited, and each property=value pair, including the last one, must end with a semicolon (;). `abc=123;test=true;` | | {% endtab %} | | | | {% tab title="CDATA" %} ## General information
FieldDescription
Data sourceMongoDB
Supported version22.0.8326.0
Connection stringjdbc:mongodb://
Packaged? Yes
Certified? Yes
Supported features
Estimate job Yes
Analyze data Yes
Schedule No
Processing capabilities
Pushdown No
Spark agent Yes
Yarn agent No
Parallel JDBC Yes
Java Platform version compatibility
JDK 8 Yes
JDK 11 Yes
## Minimum user permissions In order to bring your MongoDB data into Data Quality & Observability (self-hosted), you need the following permissions. * Read access on your MongoDB tables. * ROLE\_ADMIN assigned to your user in Collibra DQ. ## Recommended and required connection properties | Required | Connection Property | Type | Value | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Yes | Name | Text | The unique name of your connection. Ensure that there are no spaces in your connection name. | | Yes | Connection URL | String |

The connection string path of your MongoDB connection.

When referring to the example below, replace the ${value} sections of the connection URL with your actual value.

:glasses-round: Example: jdbc:mongodb://${host}.mongodb.net?AuthDatabase=admin\&AuthScheme=SCRAM-SHA-1\&UseSSL=true\&database=${dbName}

| | Yes | Driver Name | String |

The driver class name used for your connection.

cdata.jdbc.mongodb.MongoDBDriver

| | Yes | Port | Integer |

The port number to establish a connection to the datasource.

The default port is 443

| | No | Limit Schemas | Option |

Allows you to manage usage and restrict visibility to only the necessary schemas in the Explorer tree.

See Limiting schemas to learn how to limit schemas from the Connection Management page.

When you include a restricted schema in the query of a DQ Job, the query scope may be overwritten when the job runs. While only the schemas you selected when you set up the connection are shown in the Explorer menu, users are not restricted from running SQL queries on any schema from the data source.

| | No | Source Name | String | N/A | | No | Target Agent | Option | The [Agent](/data-quality-self-hosted/installation/agent.md) used to submit your DQ Job. | | Yes | Auth Type | Option |

The method to authenticate your connection.

The configuration requirements are different depending on the Auth Type you select. See Authentication for more details on available authentication types.

| | No | Properties | String | The configurable driver properties for your connection. Multiple properties must be semicolon-delimited, and each property=value pair, including the last one, must end with a semicolon (;). `abc=123;test=true;` | | {% endtab %} | | | | | {% endtabs %} | | | | ## Authentication Select an authentication type from the dropdown menu. The options available in the dropdown menu are the currently supported authentication types for this data source. {% tabs %} {% tab title="Username/Password" %} | Required | Field | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------- | | Yes | Username | The username of your MongoDB account. | | Yes | Password | The password of your MongoDB account. | ### Command line example for basic spark-submit job ``` -lib "/opt/owl/drivers/mongodb/"  -h localhost:5432/postgres  -master local[*]  -ds tpch.lineitem_7  -br 10 -deploymode client  -q "select * from tpch.lineitem where l_shipdate between '${rd} 00:00:00.000+0000'  and '${rdEnd} 00:00:00.000+0000' "  -bhlb 10 -rd "1998-12-01"  -driver "mongodb.jdbc.MongoDriver"  -loglevel INFO -cxn MongoDB -rdEnd "1998-12-02" ``` {% hint style="info" %} For more details about the various Create and Alter SQL statements and table-level actions, see the official [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/sql-comparison/#create-and-alter). {% endhint %} {% endtab %} {% tab title="Password Manager" %} | Required | Field | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Yes | Username | The username of your MongoDB account. | | Yes | Script |

The file path that contains the script file that the password manager uses to interact with and authenticate a user account.

:glasses-round: Example: /tmp/keytab/mongodb\_pwd\_mgr.sh

| | No | Param $1 | Optional. An additional parameters to authenticate your MongoDB connection. | | No | Param $2 | Optional. An additional parameter to authenticate your MongoDB connection. | | No | Param $3 | Optional. An additional parameter to authenticate your MongoDB connection. | ### Command line example for basic spark-submit job ``` -lib "/opt/owl/drivers/mongodb/"  -h localhost:5432/postgres  -master local[*]  -ds tpch.lineitem_7  -br 10 -deploymode client  -q "select * from tpch.lineitem where l_shipdate between '${rd} 00:00:00.000+0000'  and '${rdEnd} 00:00:00.000+0000' "  -bhlb 10 -rd "1998-12-01"  -driver "mongodb.jdbc.MongoDriver"  -loglevel INFO -cxn MongoDB -rdEnd "1998-12-02" ``` {% hint style="info" %} For more details about the various Create and Alter SQL statements and table-level actions, see the official [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/sql-comparison/#create-and-alter). {% endhint %} {% endtab %} {% tab title="Kerberos Password Manager" %} | Required | Field | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. | | Yes | Script |

The file path that contains the script file used to interact with and authenticate a Kerberos user.

:glasses-round: Example: /tmp/keytab/mongodb\_pwd\_mgr.sh

| | No | Param $1 | Optional. Additional Kerberos parameter. | | No | Param $2 | Optional. Additional Kerberos parameter. | | No | Param $3 | Optional. Additional Kerberos parameter. | ### Command line example for basic spark-submit job ``` -lib "/opt/owl/drivers/mongodb/"  -h localhost:5432/postgres  -master local[*]  -ds tpch.lineitem_7  -br 10 -deploymode client  -q "select * from tpch.lineitem where l_shipdate between '${rd} 00:00:00.000+0000'  and '${rdEnd} 00:00:00.000+0000' "  -bhlb 10 -rd "1998-12-01"  -driver "mongodb.jdbc.MongoDriver"  -loglevel INFO -cxn MongoDB -rdEnd "1998-12-02" ``` {% hint style="info" %} For more details about the various Create and Alter SQL statements and table-level actions, see the official [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/sql-comparison/#create-and-alter). {% endhint %} {% endtab %} {% tab title="Kerberos Keytab" %} | Required | Field | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. | | Yes | Keytab |

The file path of the keytab file that contains the encrypted key for a Kerberos principal.

:glasses-round: Example: /tmp/keytab/hive\_user.keytab

| ### Command line example for basic spark-submit job ``` -lib "/opt/owl/drivers/mongodb/"  -h localhost:5432/postgres  -master local[*]  -ds tpch.lineitem_7  -br 10 -deploymode client  -q "select * from tpch.lineitem where l_shipdate between '${rd} 00:00:00.000+0000'  and '${rdEnd} 00:00:00.000+0000' "  -bhlb 10 -rd "1998-12-01"  -driver "mongodb.jdbc.MongoDriver"  -loglevel INFO -cxn MongoDB -rdEnd "1998-12-02" ``` {% hint style="info" %} For more details about the various Create and Alter SQL statements and table-level actions, see the official [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/sql-comparison/#create-and-alter). {% endhint %} {% endtab %} {% tab title="Kerberos Password" %} | Required | Field | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------ | | Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. | | Yes | Password | The secret credential associated with your Kerberos principal. | ### Command line example for basic spark-submit job ``` -lib "/opt/owl/drivers/mongodb/"  -h localhost:5432/postgres  -master local[*]  -ds tpch.lineitem_7  -br 10 -deploymode client  -q "select * from tpch.lineitem where l_shipdate between '${rd} 00:00:00.000+0000'  and '${rdEnd} 00:00:00.000+0000' "  -bhlb 10 -rd "1998-12-01"  -driver "mongodb.jdbc.MongoDriver"  -loglevel INFO -cxn MongoDB -rdEnd "1998-12-02" ``` {% hint style="info" %} For more details about the various Create and Alter SQL statements and table-level actions, see the official [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/sql-comparison/#create-and-alter). {% endhint %} {% endtab %} {% tab title="Password TGT Cache" %} | Required | Field | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------- | | Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. | | Yes | TGT | The ticket-granting ticket cache that stores the TGT to authenticate your connection. | ### Command line example for basic spark-submit job ``` -lib "/opt/owl/drivers/mongodb/"  -h localhost:5432/postgres  -master local[*]  -ds tpch.lineitem_7  -br 10 -deploymode client  -q "select * from tpch.lineitem where l_shipdate between '${rd} 00:00:00.000+0000'  and '${rdEnd} 00:00:00.000+0000' "  -bhlb 10 -rd "1998-12-01"  -driver "mongodb.jdbc.MongoDriver"  -loglevel INFO -cxn MongoDB -rdEnd "1998-12-02" ``` {% hint style="info" %} For more details about the various Create and Alter SQL statements and table-level actions, see the official [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/sql-comparison/#create-and-alter). {% endhint %} {% endtab %} {% endtabs %}