CREATE LOCATION (MongoDB)

Reference and syntax for CREATE LOCATION with a MongoDB source.

Nightly Feature

This feature is currently in private preview. Contact [e-mail] to request early access.

Creates a location object that stores the connection string and credentials for a MongoDB deployment, for use with change data capture streams.

Syntax

CREATE LOCATION [IF NOT EXISTS] <location_name> WITH (
    SOURCE = 'MONGODB',
    URL    = '<connection_string>'
    [, USER     = '<user>'
     , PASSWORD = '<password>']
    [, DESCRIPTION = '<description>']
);

Parameters

Parameter	Description
<location_name>	A unique identifier for the location within your account.
SOURCE	Must be 'MONGODB'.
URL	MongoDB connection string (mongodb:// or mongodb+srv://), without credentials. Required. The deployment must be a replica set or a sharded cluster; standalone servers have no change streams.
USER, PASSWORD	Credentials for SCRAM authentication. Optional, but must be supplied together. The password is stored encrypted. Options in the URL such as authSource apply to them.
DESCRIPTION	Optional metadata describing the location’s purpose.

CREATE LOCATION checks the URL but does not connect to the deployment; CREATE STREAM does. The URL is shown as written in information_schema.locations, so it is rejected if it contains:

• credentials, or an option that carries a secret, such as tlsCertificateKeyFilePassword or authMechanismProperties;
• an authMechanism other than SCRAM;
• an option that disables TLS certificate or hostname verification, such as tlsInsecure;
• a file path, such as tlsCAFile or tlsCertificateKeyFile;
• a Unix domain socket instead of a host and port;
• socketTimeoutMS, which the driver does not support.

TLS

Connections use TLS unless every host is localhost or the URL sets tls=false. TLS is verified against the operating system trust store of the Firebolt nodes. To use a private certificate authority, install its certificate into the nodes’ system trust store.

Example

CREATE LOCATION mongo_prod WITH (
    SOURCE      = 'MONGODB',
    URL         = 'mongodb+srv://cluster0.example.mongodb.net/?authSource=admin',
    USER        = 'firebolt_cdc',
    PASSWORD    = '********',
    DESCRIPTION = 'Production Atlas cluster'
);

Related

• MongoDB CDC: source prerequisites and end-to-end setup.
• CREATE STREAM: bind a stream to a collection in this location.
• CREATE LOCATION: location objects in general.
• DROP LOCATION