Creating a Data Source Name

Typically, after installing the Simba Couchbase ODBC Driver, you need to create a Data Source Name (DSN).

Alternatively, for information about DSN-less connections, see Using a Connection String.

To create a Data Source Name:

  1. From the Start menu, go to ODBC Data Sources.

    2. Note:

    Make sure to select the ODBC Data Source Administrator that has the same bitness as the client application that you are using to connect to Couchbase.

  2. In the ODBC Data Source Administrator, click the Drivers tab, and then scroll down as needed to confirm that the Simba Couchbase ODBC Driver appears in the alphabetical list of ODBC drivers that are installed on your system.
  3. Choose one:
    • To create a DSN that only the user currently logged into Windows can use, click the User DSN tab.
    • Or, to create a DSN that all users who log into Windows can use, click the System DSN tab.

    Note:

    It is recommended that you create a System DSN instead of a User DSN. Some applications load the data using a different user account, and might not be able to detect User DSNs that are created under another user account.

  4. Click Add.
  5. In the Create New Data Source dialog box, select Simba Couchbase ODBC Driver and then click Finish. The Simba Couchbase ODBC Driver DSN Setup dialog box opens.
  6. In the Data Source Name field, type a name for your DSN.
  7. Optionally, in the Description field, type relevant details about the DSN.
  1. In the Server field, type the name or IP address of the host where your Couchbase Server instance is running.

    2. Note:

    When connecting to a cluster, you only need to specify the name or IP address of one node. However, you must enable load balancing. To do so, click Advanced Options and then select the Enable Load Balancing check box.

    Be aware that if SSL is enabled and you are connecting to Couchbase Server prior to version 4.5, load balancing is not supported.

  2. In the Port field, type the number of the TCP port that the Couchbase Server instance uses to listen for client connections.

    3. Note:

    The default port used by Couchbase Server is 8093.

  3. If the database that you are connecting to requires authentication, then use the options in the Authentication area to configure authentication as needed. For more information, see Configuring Authentication.
  4. To configure client-server verification over SSL, click SSL Options. For more information, see Configuring SSL Verification.
    5. Important:

    Important:

    If SSL is enabled and you are connecting to Couchbase Server prior to version 4.5, load balancing is not supported.

  5. To configure advanced connector options, click Advanced Options. For more information, see Configuring Advanced Options.
  6. To launch the Schema Editor application and create or customize the schema definition that the connector uses when connecting to the database, click Schema Editor.
    7. Important:

    Important:

    • Before generating a schema definition, make sure that primary indexes have been created for all of the buckets in your Couchbase database.
    • Schema definitions that were created using connector version 1.1.2 or earlier are not supported, and must be recreated using the Schema Editor or the SchemaMapOperation connection property.

    Note:

    For information about how to use the Schema Editor, see the Schema Editor User Guide located in the installation directory of the connector.

    • On Windows 7 or earlier, the guide is available from the Simba Couchbase ODBC Driver program group in the Start menu.
    • On Windows 8 or later, you can search for the guide on the Start screen.

    For information about using connection properties to work with schema definitions, see Working with Schema Definitions Using Connection Properties.

  7. To configure logging behavior for the connector, click Logging Options. For more information, see Configuring Logging Options.
  8. To test the connection, click Test. Review the results as needed, and then click OK.

    9. Note:

    If the connection fails, then confirm that the settings in the Couchbase ODBC Driver DSN Setup dialog box are correct. Contact your Couchbase administrator as needed.

  9. To save your settings and close the Couchbase ODBC Driver DSN Setup dialog box, click OK.
  10. To close the ODBC Data Source Administrator, click OK.

Related topics