41. Redshift 
41.1. Amazon Redshift Version Support
The driver enables standards-based access to Amazon Redshift based on PostgreSQL 8.0.2 with Amazon Redshift SQL.
41.2. Connection Options
41.2.1. Authentication
Property | Description |
AuthScheme | The type of authentication to use when connecting to Amazon Redshift. |
Server | The host name or IP address of the Amazon Redshift cluster. |
Port | The port number of the Amazon Redshift server. |
Database | The name of the Amazon Redshift database. |
User | The Amazon Redshift user account used to authenticate. |
Password | The password used to authenticate the user. |
UseSSL | This field sets whether SSL is enabled. |
Visibility | 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 operations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, REFERENCES. |
41.2.2. AWS Authentication
Property | Description |
AwsAccessKey | Your AWS account access key or the access key for an authorized IAM user. |
AwsSecretKey | Your AWS account secret key or the secret key for an authorized IAM user. |
AutoCreate | Specify true to create a database user with the name specified for User if one does not exist while connecting with IAM credentials. See AuthScheme . |
DbGroups | 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 . |
AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
AWSPrincipalArn | The ARN of the SAML Identity provider in your AWS account. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSSessionToken | Your AWS session token. |
41.2.3. SSO
Property | Description |
SSOLoginURL | The identity provider's login URL. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
SSOExchangeUrl | The url used for consuming the SAML response and exchanging it with Amazon Redshift specific credentials. |
41.2.4. SSL
Property | Description |
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
41.2.5. SSH
Property | Description |
SSHAuthMode | The authentication method to be used to log on to an SFTP server. |
SSHClientCert | A certificate to be used for authenticating the user. |
SSHClientCertPassword | The password of the SSHClientCert certificate if it has one. |
SSHClientCertSubject | The subject of the SSH client certificate. |
SSHClientCertType | The type of SSHClientCert certificate. |
SSHServer | The SSH server. |
SSHPort | The SSH port. |
SSHUser | The SSH user. |
SSHPassword | The SSH password. |
SSHServerFingerprint | The SSH server fingerprint. |
UseSSH | Whether to tunnel the Amazon Redshift connection over SSH. Use SSH. |
41.2.6. Firewall
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
41.2.7. Proxy
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
41.2.8. Logging
Property | Description |
Logfile | A filepath which designates the name and location of the log file. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
LogModules | Core modules to be included in the log file. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
MaxLogFileCount | A string specifying the maximum file count of log files. |
41.2.9. Schema
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
IgnoredSchemas | 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. |
41.2.10. Miscellaneous
Property | Description |
AllowPreparedStatement | Prepare a query statement before its execution. |
BatchSize | The maximum size of each batch operation to submit. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectOnOpen | This property species whether to connect to the Amazon Redshift when the connection is opened. |
FetchResultSetMetadata | This field sets whether the provider is getting detailed information about resultset columns from the server. |
IncludeTableTypes | If set to true, the provider will query for the types of individual tables and views. |
InsertMode | Specifies what method to use when inserting bulk data. By default DML mode is used. |
MaxRows | 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. |
Other | These hidden properties are used only in specific use cases. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
QueryPassthrough | This option passes the query to the Amazon Redshift server as is. |
Readonly | You can use this property to enforce read-only access to Amazon Redshift from the provider. |
RTK | The runtime key used for licensing. |
S3Bucket | Specifies the name of AWS S3 bucket to upload bulk data for staging. |
S3BucketFolder | Specifies the name of the folder in AWS S3 bucket to upload bulk data for staging. By default bulk data are staged in the root folder. |
StripOutNulls | When set the null characters are stripped out from character values in bulk operations. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TimeZone | Set time zone for the current session. |
UseConnectionPooling | This property enables connection pooling. |