The following is the full list of the options you can configure in the connection string for this provider.

Prepare a query statement before its execution.

bool

true

If the AllowPreparedStatement property is set to false, statements are parsed each time they are executed. Setting this property to false can be useful if you are executing many different queries only once.

If you are executing the same query repeatedly, you will generally see better performance by leaving this property at the default, true. Preparing the query avoids recompiling the same query over and over. However, prepared statements also require the adapter to keep the connection active and open while the statement is prepared.

The type of authentication to use when connecting to Amazon Redshift.

string

"Auto"

bool

false

The default is false.

Your AWS account access key or the access key for an authorized IAM user.

string

""

To authorize Amazon Redshift requests, provide the credentials for an administrator account or for an IAM user with custom permissions. Set this property along with AwsSecretKey.

Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.

To obtain the credentials for an IAM user, follow the steps below:

To obtain the credentials for your AWS root account, follow the steps below:

Your AWS account secret key or the secret key for an authorized IAM user.

string

""

Your AWS account secret key or the secret key for an authorized IAM user. See AwsAccessKey to obtain the secret key and access key.

Your AWS session token.

string

""

Your AWS session token. This value can be retrieved in different ways.

A comma-delimited list of the names of one or more existing database groups the database user joins for the current session when connecting with IAM credentials. See AuthScheme .

string

""

By default, the new user is added only to PUBLIC.

This field sets whether the provider is getting detailed information about resultset columns from the server.

bool

false

By default, the adapter will not request server to provide too detailed information about resultset columns (like the table name, for example) when the query is succeeding, because it requires issuing additional metaquery by the adapter, and may affect query performance essentially in some scenarios. Consider this property when you are requiring all details about resultset columns together with the query result.

The name of the Redshift database.

string

""

The database to connect to when connecting to the Amazon Redshift Server. If the database is not provided, the user's default database will be used.

A password used to authenticate to a proxy-based firewall.

""

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

The TCP port for a proxy-based firewall.

string

""

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The name or IP address of a proxy-based firewall.

string

""

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling.

The protocol used by a proxy-based firewall.

string

"NONE"

This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy.

The user name to use to authenticate with a proxy-based firewall.

""

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Visibility restriction filter which is used to hide the list of schemas by metadata quering. For example, 'information_schema, pg_catalog'. Schema names are case sensitive.

string

""

By default restrictions are not applied.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

string

"%APPDATA%\\CData\\Redshift Data Provider\\Schema"

The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Redshift Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

 

Core modules to be included in the log file.

string

""

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

string

"-1"

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

string

""

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

 

The password required for authentication with the Amazon Redshift server.

string

""

The User and Password will be used to authenticate with the Amazon Redshift Server.

The port number of the Amazon Redshift server.

string

"5439"

The port number of the Server hosting the Amazon Redshift Database. If not specified the default port number 5439 is used.

You can use this property to enforce read-only access to Redshift from the provider.

bool

false

If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

The host name or IP address of the Redshift cluster.

string

""

The host name or IP of the Amazon Redshift cluster Database. You can obtain this value from the AWS Management Console:

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

string

""

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSL Client Cert Subject for more information.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

The password for the TLS/SSL client certificate.

string

""

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

The subject of the TLS/SSL client certificate.

string

"*"

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.

 

If a field value contains a comma, it must be quoted.

The type of key store containing the TLS/SSL client certificate.

string

""

This property can take one of the following values:

The certificate to be accepted from the server when connecting using TLS/SSL.

string

""

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

 

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

The SSOProvider login URL.

string

""

The SSOProvider login URL.

The password of the SSOProvider used to authenticate the user.

string

""

The SSOUser and SSOPassword are together used to authenticate with the SSOProvider.

The name of the SSO provider you are trying to authenticate.

string

"OKTA"

The name of the SSO provider you are trying to authenticate. The following options are available: OKTA,OneLogin,ADFS

The SSOProvider user account used to authenticate.

string

""

Together with SSOPassword, this field is used to authenticate against the specified SSOProvider.

When set the null characters are stripped out from character values in bulk operations.

bool

false

The value in seconds until the timeout error is thrown, canceling the operation.

int

10

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the adapter throws an exception.

Set time zone for the current session.

string

""

If the TimeZone property is not set, provider uses client system time zone. Setting this property can be useful when you need the server to convert time with time zone and timestamp with timezone values to specific time zone, which is different than client's system time zone.

The username used to authenticate with the Amazon Redshift Server .

string

""

The username used to authenticate with the Amazon Redshift Server.

This field sets whether SSL is enabled.

bool

false

This field sets whether the adapter will attempt to negotiate TLS/SSL connections to the server. By default, the adapter checks the server's certificate against the system's trusted certificate store. To specify another certificate, set SSLServerCert.

Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for current user. For example 'SELECT,INSERT' filter is restricting metatdata visibility only for those tables which may be accessed by current user for SELECT and INSERT opearations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, REFERENCES.

string

""

By default visibility filtering is not applied. Filtering values are case insensitive.