Create a System DSN

    The following steps describe how to create a system Data Source Name (DSN) for the BI Connector's mongosqld process. A DSN is a saved configuration which describes a database connection to be used by an ODBC driver. Once the DSN is created for the BI Connector, you can configure a wide range of SQL clients and BI tools to use the DSN and import data from MongoDB.

    Before creating a DSN , you should:


    Choose the program version (64-bit or 32-bit) which is appropriate for your system and ODBC driver version.

    Screenshot of the Windows ODBC Administrator application

    Select either the MongoDB ODBC 1.1.0 ANSI Driver or the MongoDB ODBC 1.1.0 Unicode Driver, then click OK.


    The ANSI ODBC driver offers maximum performance but has a limited character set. The Unicode ODBC driver supports a wider character set but may be slightly less performant as a result.


    Click the Details button to expose the lower half of the form.

    The following form fields are required:

    Field Name
    Data Source Name
    A name of your choice.
    TCP/IP Server
    Address of the server where your mongosqld process is running. If you have enabled BI Connector on MongoDB Atlas, you can find the hostname of the server where mongosqld is running in the connection information for your cluster.
    Port number of your mongosqld process.
    The name of the database to connect to, e.g. test.

    The following fields Required when running with --auth enabled or when connecting to an BI Connector for Atlas instance.

    Field Name

    Username of the MongoDB user who is authenticated to use your target database.

    You can specify the following authentication options after your username as URI-style query parameters:

    Connection Option

    Specify the name of the database which stores the user's credentials. If you do not specify this option, the MongoDB Connector for BI will default to the current database associated with the MySQL connection.

    For authentication mechanisms such as PLAIN (LDAP) or GSSAPI (Kerberos) that delegate credential storage to other services, set the source value to $external.

    Not required if defaultSource is set in your MongoDB Connector for BI configuration file.


    Specify the mechanism that the MongoDB Connector for BI should use to authenticate the connection. Accepted values include:

    LDAP and Kerberos require MongoDB Enterprise. Set the source to $external when using LDAP or Kerberos.

    Not required if defaultMechanism is set in your MongoDB Connector for BI configuration file.

    X.509 is not supported.

    To authenticate as user grace using the admin database and the Challenge and Response (SCRAM-SHA-1) authentication mechanism, write the username in this format:

    The authenticated user's password.

    The default authentication method. When using the MongoDB ODBC Driver for BI Connector, this field is not required.

    To use the authentication plugin in conjunction with another ODBC driver, fill in this field with the string mongosql_auth.


    Access the TLS/SSL form fields by clicking Details >>, then the SSL tab. The following parameters are available and may be required, depending on your TLS/SSL configuration:

    Field Name
    SSL Key
    The location of the client/server key file.
    SSL Cert
    The location of the client/server certificate file.
    SSL CA File
    The location of the file containing a list of trusted certificate authorities.
    SSL Cipher
    The location of the file containing a list of permitted ciphers.
    SSL Mode
    Set to REQUIRED to require an encrypted channel. If an encyrpted channel is not provided, the connection fails.
    RSA Public Key
    The location of the PEM file that contains the RSA public key.

    The BI Connector for Atlas uses TLS/SSL but does not require any TLS/SSL settings to be configured in your system DSN.


    If the connection is successful, click OK to add the DSN . If the connection fails, check to make sure your MongoDB user is correctly authenticated for the database named in the connection.

    Give Feedback