Skip to main content

Create an Amazon Redshift connection

To access your data stored on an Amazon Redshift database, you will need to know the server and database name that you want to connect to, and you must have access credentials. Once you have created a connection to an Amazon Redshift database, you can select data from the available tables and then load that data into your app or document.

In Qlik Sense, you connect to an Amazon Redshift database through the Add data dialog or the Data load editor.

In QlikView you connect to an Amazon Redshift database through the Edit Script dialog.

Setting up the database properties

Database properties that can be configured
Database property Description Required
Host name Host name to identify the location of the Amazon Redshift database Yes
Port Server port for the Amazon Redshift database Yes
Database The name of the Amazon Redshift database Yes

Authenticating the driver

Qlik Sense: Amazon Redshift authentication properties

Username and password

Authentication properties that can be configured
Authentication property Description
Auth Type Drop-down that specifies the authentication method. Select Standard to authenticate with username and password.
Username User name for the Amazon Redshift connection
Password Password for the Amazon Redshift connection
Name Name of the Amazon Redshift connection. The default name will be used if you do not enter a name.

IAM credentials

Authentication properties that can be configured
Authentication property Description
Auth Type Drop-down that specifies the authentication method. Select AWS IAM Credentials to authenticate with IAM. You must have ODBC driver v1.4.35.1000 or later.
Cluster ID The Amazon Redshift cluster you are connecting to.
Region The AWS region your cluster is in.
DbUser The user name you use to access the Amazon Redshift server.
CA file The file path to the CA certificate file used for IAM/IDP authentication.
User AutoCreate This option specifies whether the connector causes a new user to be created when the specified user does not exist.
DbGroups A comma-separated list of existing database group names that the DbUser joins for the current session. If not specified, the default is: PUBLIC.
Force Lowercase This option specifies whether the connector lowercases all DbGroups sent from the identity provider to Amazon Redshift when using SSO authentication.

QlikView: Amazon Redshift authentication properties

Authentication properties that can be configured
Authentication property Description
Username User name for the Amazon Redshift connection
Password Password for the Amazon Redshift connection

Account properties

Credentials

Credentials are used to prove that a user is allowed to access the data in a connection.

There are two types of credentials that can be used when making a connection in Qlik Sense SaaS. If you leave the User defined credentials check box deselected, then only one set of credentials will be used for the connection. These credentials belong to the connection and will be used by anyone who can access it. For example, if the connection is in a shared space, every user in the space will be able to use these credentials. This one-to-one mapping is the default setting.

If you select User defined credentials, then every user who wants to access this connection will need to input their own credentials before selecting tables or loading data. These credentials belong to a user, not a connection. User defined credentials can be saved and used in multiple connections of the same connector type.

In the Data load editor, you can click the Primary key underneath the connection to edit your credentials. In the hub or Data manager, you can edit credentials by right-clicking on the connection and selecting Edit Credentials.

Username and password

Account properties that can be configured
Account property Description
User defined credentials Select this check box if you want users that access this connection to have to input their own credentials. Deselect this check box if credentials can be shared with anyone who has access to this connection.
New credentials Drop-down menu item that appears if User defined credentials is selected.
Existing credentials Drop-down menu item that appears if User defined credentials is selected.
User User name for the connection.
Password Password for the connection.
Credentials name Name given to a set of user defined credentials.

IAM

Account properties that can be configured
Account property Description
User defined credentials Select this check box if you want users that access this connection to have to input their own credentials. Deselect this check box if credentials can be shared with anyone who has access to this connection.
New credentials Drop-down menu item that appears if User defined credentials is selected.
Existing credentials Drop-down menu item that appears if User defined credentials is selected.
Access Key ID The access key provided by your AWS account.
Secret Access Key The secret key provided by your AWS account.
Session token The temporary session token generated by the AWS Security Token Service.

Selecting SSL settings

SSL support in Amazon Redshift is strictly for encrypting the connection between your client and your cluster. It does not include the server-side certificate authentication. You must ensure when establishing a connection to the Redshift data source that the host name and IP address of the data source is complete and accurate.

Information noteSSL options for Redshift are explained further in Amazon's Redshift documentation.
SSL options that can be configured
SSL Authentication setting Description
verify-full SSL is required, the server certificate must be verified, and the host name must match the host-name attribute on the server certificate.
verify-ca SSL is required and the server certificate must be verified.
require SSL is required.
prefer SSL is used whenever the server supports it.
allow SSL is used if the server requires it.
disable SSL is disabled and the connection is not encrypted.

Specifying certificate location

Certificate settings that can be configured
Certificate storage Description
Use System Trust Store Use the SSL certificate located in the standard system location used for storing trusted certificates. This property can be selected only when SSL is enabled. This option is only available in Qlik Sense Enterprise on Windows.
Trusted Certificate / Full path of Trusted Certificate The full path to the SSL certificate if it is not stored in the standard system location. This property can be selected only when SSL is enabled.
Information noteIf you are using IAM authentication, your SSL settings must be set to: verify-full, verify-ca, or require.You must also provide a Trusted Certificate file.

Proxy server settings

Information noteThis option is only available for Qlik Sense Enterprise on Windows
Proxy settings that can be configured
Proxy setting Description Required
Use proxy server Check this option if you wish to connect through a proxy server. No
Proxy Server Name or IP address of a proxy server if the connection is made through a proxy. Yes, if Use Proxy Server is checked.
Proxy Port Port number for the proxy server if a proxy is used. Yes, if Use Proxy Server is checked.
Proxy Username The user name that you use to access the proxy server. Yes, if Use Proxy Server is checked.
Proxy Password The password that you use to access the proxy server. Yes, if Use Proxy Server is checked.

Additional options

Additional options that can be configured
Additional option Description

Query Processing Modes

Specifies how database is queried.

Retrieve Entire Result Into Memory

This option specifies whether the driver returns the entire query result into memory.

Single Row Mode

This option specifies whether the driver uses Single Row Mode and returns query results one row at a time. Enable this option if you plan to query large results and do not want to retrieve the entire result into memory. Disabling this option increases performance, but can result in out-of-memory errors.

Use Multiple Statements

This option specifies whether the driver can have more than one active query at a time per connection. This is only available in QlikView.

Use Declare Fetch

This option specifies whether the driver uses Declare/Fetch Mode and returns a specific number of rows at a time.

Cache Size

The number of rows that the driver returns when Declare/Fetch Mode is enabled.

Miscellaneous settings

Miscellaneous properties that can be configured
Property Description Required

Query timeout

Amount of time before a data load query times out. Can be set from 30 seconds to 65535 seconds. Default is 150. No

Load optimization settings

Load properties that can be configured
Property Description Required

Enable Bulk Reader

Select this to include larger portions of data in the iterations within a load. This may result in faster load times for larger datasets. If not selected, data will be loaded row by row. No
Max String Length

Maximum length of string fields. This can be set from 256 to 16384 characters. The default value is 4096. Setting this value close to the maximum length may improve load times, as it limits the need to allocate unnecessary resources. If a string is longer than the set value, it will be truncated, and the exceeding characters will not be loaded.

No

Advanced options

Information noteThis section is for advanced users who want to add their own custom connection parameters that are not displayed above.
Advanced options that can be configured
Property Description Required

Name

Name of the custom property. You can add additional properties by clicking the plus sign.

No
Value

Value of the property.

No
Information noteWhen you connect to an Amazon Redshift database with the Data load editor or the Edit script dialog, Test Connection enables you to test the connection before you attempt to create it.