Connection String Parameters - ODBC Driver for Amazon Redshift

Server

Serves to supply the server name for login.

Port

Used to specify the port number for the connection. 5439 by default.

User ID

Used to supply a user name for login.

Password

Used to supply a password for login.

Database

Used to set the name of the database

Authentication

The authentication method to connect to the AWS service.

Initiate SSO URL

The URL used to initiate Single Sign-On (SSO) authentication.

AWS Account ID

The unique 12-digit identifier for your AWS account.

IAM Provider

The identity provider used to authenticate IAM roles or users.

IAM Role

The name of the IAM role used to grant temporary access to AWS resources.

IAM UserID

The username or identifier of the IAM user that is used for authentication.

IAM Password

The password associated with the IAM user account used during standard IAM-based login.

Advanced Settings

Allow NULL strings

To retrieve metadata, not all parameters according to MSDN can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These options should be enabled for compatibility with such tools.

Empty strings as NULL

Connection Timeout

The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 15.

MinFetchRows

Respectively, if the SQL_ATTR_ROW_ARRAY_SIZE attribute value is less than MinFetchRows, then the number of rows queried from the server will equal MinFetchRows. Otherwise - it will be equal to SQL_ATTR_ROW_ARRAY_SIZE.

In order to make the driver to query from the server exactly the same number of rows as specified in the SQL_ATTR_ROW_ARRAY_SIZE attribute, it is enough to set the MinFetchRows parameter to 0. However, in this case, you should take into account, that the SQL_ATTR_ROW_ARRAY_SIZE value is 1 by default, and therefore performance decreases dramatically at this value.

ODBC Behavior

Used to set the behavior corresponding to the ODBC specification version that a third-party tool expects. The behavior of ODBC driver can be changed by setting a value for the SQL_ATTR_ODBC_VERSION attribute by calling the SQLSetEnvAttr function. But some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the specified version or pass an incorrect value there. In this case, the required behavior can be explicitly specified in the Connection String by setting the ODBC Behavior parameter. The possible values are:

• Default - default ODBC behavior determined by a third-party tool.
• Ver 2.x - ODBC 2.x behavior is explicitly set.
• Ver 3.x - ODBC 3.x behavior is explicitly set.

String Types

Sets the string value types returned by the driver as Default, Ansi or Unicode.

• Default - the driver defines the string types.
• Ansi - all string types will be returned as SQL_CHAR, SQL_VARCHAR and SQL_LONGVARCHAR.
• Unicode - all string types will be returned as SQL_WCHAR, SQL_WVARCHAR and SQL_WLONGVARCHAR.

The Parameter value should be changed if any third-party tool supports only Ansi string types or Unicode ones.

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

Use Multiple Connection

Opens parallel connections to a database.

Read Only

The connection is restricted to read-only operations.