Creating a Data Source Name

Typically, after installing the Simba Athena 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 Athena.

  2. In the ODBC Data Source Administrator, click the Drivers tab, and then scroll down as needed to confirm that the Simba Athena 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 Athena ODBC Driver and then click Finish. The Simba Athena 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 AWS Region field, type the AWS region of the Athena instance that you want to connect to.

    2. Note:

    For a list of valid regions, see the "Athena" section in the AWS Regions and Endpoints documentation: http://docs.aws.amazon.com/general/latest/gr/rande.html#athena.

  2. Optionally, in the Catalog field, type the name of the Athena catalog you want the connector to query. If lthis filed is left empty, queries will be applied to AwsDataCatalog.
  3. In the Schema field, type the name of the database schema to use when a schema is not explicitly specified in a query. You can still issue queries on other schemas by explicitly specifying the schema in the query.
  4. Optionally, in the Workgroup field, type the name of the workgroup to use when signing in to Athena.
  5. Optionally, from the Metadata Retrieval Method drop-down list, select the option you want to use to retrieve metadata from Athena:
    6. Option Name Description

    Auto

    At connection time connector automatically determines whether to use AWS Glue or Query to retrieve metadata for the specified Athena region. If AWS Glue is supported in the region and Athena has been upgraded to use AWS Glue, the connector uses AWS Glue to retrieve the metadata. If AWS Glue is not supported in the region or Athena hasn’t been upgraded to use AWS Glue, the connector queries Athena to retrieve the metadata.

    Glue

    The connector uses AWS Glue to retrieve the metadata regardless of whether AWS Glue is supported or used in the region.

    ProxyAPI

    The connector uses Athena's proxy API. This is used to query external catalogs.

    Query

    The connector uses Query to retrieve the metadata regardless of whether AWS Glue is supported or used in that region.
    Important:

    Important:

    Changing the default value for this configuration option may lead to unwanted behavior. For example, the connector may attempt to use AWS Glue in a region where AWS Glue is not supported or used.

  6. In the S3 Output Location field, type the path of the Amazon S3 location where you want to store query results, prefixed by s3://.

    7. For example, to store results in a folder named "test-folder-1" inside an S3 bucket named "query-results-bucket", you would type s3://query-results-bucket/test-folder-1 in this field.

  7. To configure encryption for your query results, do the following:
    1. From the Encryption Options drop-down list, select the encryption protocol that you want to use:
      2. Option NameDescription

      NOT_SET

      The connector does not encrypt the data.

      SSE_S3

      The connector uses server-side encryption with an Amazon S3-managed key.

      SSE_KMS

      The connector uses server-side encryption with an AWS KMS-managed key.

      CSE_KMS

      The connector uses client-side encryption with an AWS KMS-managed key.

      For detailed information about these encryption options, see "Configuring Encryption Options" in the Amazon Athena User Guide: http://docs.aws.amazon.com/athena/latest/ug/encryption.html.

    2. If you selected SSE_KMS or CSE_KMS in the previous step, then in the KMS Key field, type the KMS customer key to use for encrypting data.
  8. To configure authentication, click Authentication Options. For more information, see Configuring Authentication.
  9. To configure advanced options, click Advanced Options. For more information, see Configuring Advanced Options.
  10. To configure proxy connections, click Proxy Options. For more information, see Configuring Proxy Connections .
  11. To configure logging behavior for the connector, click Logging Options. For more information, see Configuring Logging Options.
  12. To test the connection, click Test. Review the results as needed, and then click OK.

    13. Note:

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

  13. To save your settings and close the Simba Athena ODBC Driver DSN Setup dialog box, click OK.
  14. To close the ODBC Data Source Administrator, click OK.

Related topics