Creating a Data Source Name

When connecting to your data store using a DSN, you only need to configure the odbc.ini file. Set the properties in the odbc.ini file to create a DSN that specifies the connection information for your data store. For information about configuring a DSN-less connection instead, see Configuring a DSN-less Connection on a Non-Windows Machine on page 1.

If your machine is already configured to use an existing odbc.ini file, then update that file by adding the settings described below. Otherwise, copy the odbc.ini file from the Setup subfolder in the connector installation directory to the home directory, and then update the file as described below.

To create a Data Source Name:

  1. In a text editor, open the odbc.ini configuration file.

    2. Note:

    If you are using a hidden copy of the odbc.ini file, you can remove the period (.) from the start of the file name to make the file visible while you are editing it.

  2. In the [ODBC Data Sources] section, add a new entry by typing a name for the DSN, an equal sign (=), and then the name of the connector.

    3. For example, on a macOS machine:

    [ODBC Data Sources]

    Sample DSN=Simba Amazon Redshift ODBC ConnectorSimba Redshift ODBC Driver

    For example, for a 32-bit connector on a Linux machine:

    [ODBC Data Sources]

    Sample DSN=Simba Amazon Redshift ODBC ConnectorSimba Redshift ODBC Driver 32-bit

  3. Create a section that has the same name as your DSN, and then specify configuration options as key-value pairs in the section:
    1. Set the Driver property to the full path of the connector library file that matches the bitness of the application.

      2. For example, on a macOS machine:

      Driver=/Library/simba/amazonredshiftodbc/lib/libamazonredshiftodbc_sb64.dylib

      For example, for a 32-bit connector on a Linux machine:

      Driver=/opt/simba/amazonredshiftodbc/lib/32/libamazonredshiftodbc_sb32.so

    2. Set the Server property to a comma-delimited list of endpoint servers you want to connect to, and then set the Port property to the number of the TCP port that these servers use to listen for client connections.

      For example:

      Server=testserver.abcabcabcabc.com,testserver.cbacbacba.com,

      Port=5439

      3. Note:

      If you are using IAM authentication and you specify the ClusterID and AWSRegion attributes, you do not need to specify the Server attribute.

    3. Set the Database property to the name of the database that you want to access.

      4. For example:

      Database=TestDB

    4. To configure authentication, specify the authentication mechanism and your credentials. For more information, see Configuring Authentication.
    5. To connect to the server through SSL, enable SSL and specify the certificate information. For more information, see Configuring SSL Verification.
    6. Optionally, modify how the connector runs queries and retrieves results into memory. For more information, see Configuring Query Processing Modes.
    7. Optionally, configure the connector to connect through a proxy server. For more information, see Configuring a Proxy Connection.
    8. Optionally, configure the connector to pass IAM authentication processes through a proxy server. For more information, see Configuring an HTTPS Proxy for IAM Authentication.
    9. Optionally, modify the TCP keepalive settings that the connector uses to prevent connections from timing out. For more information, see Configuring TCP Keepalives.
    10. Optionally, set additional key-value pairs as needed to specify other optional connection settings. For detailed information about all the configuration options supported by the Simba Amazon Redshift ODBC Connector, see Driver Configuration Options on page 1.
  4. Save the odbc.ini configuration file.

    5. Note:

    If you are storing this file in its default location in the home directory, then prefix the file name with a period (.) so that the file becomes hidden. If you are storing this file in another location, then save it as a non-hidden file (without the prefix), and make sure that the ODBCINI environment variable specifies the location. For more information, see Specifying the Locations of the Driver Configuration Files on page 1.

For example, the following is an odbc.ini configuration file for macOS containing a DSN that connects to Redshift:

[ODBC Data Sources]

Sample DSN=Simba Redshift ODBC Driver

[Sample DSN]

Driver=/Library/simba/amazonredshiftodbc/lib/libamazonredshiftodbc_sb 64 .dylib

Server=testserver.abcabcabcabc.us-west-2.redshift.amazonaws.com

Port=5432

Database=TestDB

UID=simba

PWD=simba123

For example, the following is an odbc.ini configuration file for a 32-bit connector on a Linux machine, containing a DSN that connects to Redshift:

[ODBC Data Sources]

Sample DSN=Simba Redshift ODBC Driver 32-bit

[Sample DSN]

Driver=/opt/simba/amazonredshiftodbc/lib/32/libamazonredshiftodbc_sb32.so

Server=testserver.abcabcabcabc.us-west-2.redshift.amazonaws.com

Port=5432

Database=TestDB

UID=simba

PWD=simba123

You can now use the DSN in an application to connect to the data store.

Related topics