Set up the Openflow Connector for MongoDB¶

Note

This connector is subject to the Snowflake Connector Terms.

This topic describes the steps to set up the Openflow Connector for MongoDB.

Configure the connector¶

To configure the connector, perform the following steps:

Right-click on the added runtime, and select Parameters.
Populate the required parameter values as described in Specify flow parameters.

Specify flow parameters¶

These sections describe the flow parameters that you can configure in the following parameter contexts:

MongoDB source parameters: Used to define the configuration for reading data from MongoDB.
MongoDB destination parameters: Used to establish a connection with Snowflake.
MongoDB ingestion parameters: Used to specify the collections to replicate.

MongoDB source parameters¶

Parameter	Description
MongoDB Connection URI	MongoURI, typically of the form: `mongodb://host1[:port1][,host2[:port2],...]/?[options]` Snowflake recommends that you include the `readPreference=secondaryPreferred` option in the URI. This directs read operations to the secondary nodes, reducing the overhead on the primary node of the replica set. Database username and password must not be provided in the URI as this is considered a security issue. Example: `mongodb://10.11.98.246:27017,10.11.104.58:27017/?replicaSet=myReplicaSet&readPreference=secondaryPreferred`
MongoDB Username	The username for interacting with MongoDB. Example: `openflowUser`
MongoDB Password	The password for interacting with MongoDB. Example: `myPassword123`
MongoDB Authentication Source	The database containing user credentials. Example: `admin`
MongoDB Authentication Mechanism	Authentication mechanism that MongoDB uses to authenticate the connection. Possible values are: `None`: Connect without authentication. `SCRAM-SHA-256`: Authentication mechanism that uses the SHA-256 hashing function.

MongoDB destination parameters¶

Parameter	Description
Destination Database	The name of the destination database to replicate into. Mixed case is supported. Example: `MY_DESTINATION_DB`
Snowflake Account Identifier	When using: Session Token Authentication Strategy: Must be blank. KEY_PAIR: Snowflake account name where data will be persisted.
Snowflake Authentication Strategy	When using: SPCS, use `SNOWFLAKE_SESSION_TOKEN` as the value for Authentication Strategy. BYOC, use `KEY_PAIR` as the value for Authentication Strategy. Example: `KEY_PAIR`
Snowflake Connection Strategy	When using: KEY_PAIR: Specify the strategy for connecting to Snowflake. Possible values: `STANDARD`, `PRIVATE_CONNECTIVITY`.
Snowflake Private Key	When using: Session Token Authentication Strategy: The private key must be blank. KEY_PAIR: Copy the content of the RSA private key used for authentication to Snowflake, formatted according to PKCS8 standards and including standard PEM headers and footers. The header line begins with `-----BEGIN PRIVATE`.
Snowflake Private Key File	When using: Session Token Authentication Strategy: The private key file must be blank. KEY_PAIR: Upload the file that contains the RSA private key used for authentication to Snowflake, formatted according to PKCS8 standards and including standard PEM headers and footers. The header line begins with `-----BEGIN PRIVATE`. To upload the private key file, select the Reference asset checkbox.
Snowflake Private Key Password	When using: Session Token Authentication Strategy: Must be blank. KEY_PAIR: Provide the password associated with the Snowflake Private Key File.
Snowflake Role	When using: Session Token Authentication Strategy: Use your Runtime Role. You can find your Runtime Role in the Openflow UI, by navigating to View Details for your Runtime. KEY_PAIR Authentication Strategy: Use a valid role configured for your service user. Example: `OPENFLOW_ROLE`
Snowflake Username	When using: Session Token Authentication Strategy: Must be blank. KEY_PAIR: Provide the username used to connect to the Snowflake instance. Example: `OPENFLOW_USER`
Snowflake Warehouse	The name of the warehouse used by the connector. Example: `OPENFLOW_WH`

MongoDB ingestion parameters¶

Parameter Description

Included Collection Names

Parameter	Description
Included Collection Names	Comma-separated list of the collections to replicate. Example: `my_db.collection1,my_db.collection2`
Included Collection Regex	Regular expression for specifying collection names to replicate. Example: `my_db.*`
Merge Task Schedule CRON	CRON expression defining periods when merge operations from journal to destination table are triggered. Use `* * * * * ?` for continuous merge, or a time schedule to limit warehouse run time. For example: The string `* 0 * * * ?` schedules merges at the full hour for one minute. The string `* 20 14 ? * MON-FRI` schedules merges at 2:20 PM every Monday through Friday. For additional information and examples, see the cron triggers tutorial in the Quartz Documentation. Example: `* * * * * ?`

Comma-separated list of the collections to replicate.

Example: my_db.collection1,my_db.collection2

Included Collection Regex

Regular expression for specifying collection names to replicate.

Example: my_db.*

Merge Task Schedule CRON

CRON expression defining periods when merge operations from journal to destination table are triggered.

Use * * * * * ? for continuous merge, or a time schedule to limit warehouse run time.

For example:

The string * 0 * * * ? schedules merges at the full hour for one minute.
The string * 20 14 ? * MON-FRI schedules merges at 2:20 PM every Monday through Friday.

For additional information and examples, see the cron triggers tutorial in the Quartz Documentation.

Example: * * * * * ?

Run the flow¶

Right-click on the plane and select Enable all Controller Services.
Right-click on the imported process group and select Start. The connector starts the data ingestion.

Next steps¶

For information about using the connector after installation, see Use the Openflow Connector for MongoDB.