Amazon Redshift is a cloud data warehouse service.
This topic describes how to configure an Amazon Redshift database as a Dremio Cloud source:
Ensure that you have the JDBC connection string of the Redshift database to add it as a source. You can find the JDBC connection URL in the AWS console.
Dremio Cloud Redshift Configuration
Perform these steps to configure Redshift:
In the Datasets UI, you can see a truncated list of External Sources at the bottom-left of the page. Click the plus (+) icon to add a source.
Alternatively, click External Sources. The page displays all sources. Click the Add External Source button at the top-right of that page.
In the Add External Source dialog, click Amazon Redshift.
The following section describes the source configuration tabs.
The General tab contains the required fields to create a Redshift source.
Perform these steps in the General tab:
In the General tab, for Name, enter a name.
For JDBC Connection String, enter the JDBC connection string of the Redshift database.
For Authentication, you must choose one of the following authentication options:
Master Authentication, this is the default option. Provide the username and password of a master database user with permissions to read required objects:
- For Username, enter your Redshift database username.
- For Password, enter your Redshift database password.
For Secret Resource Url, provide the username and the Secret Resource URL that allows fetching the credentials, username and password, and the connection details from the AWS Secrets Manager:
- For Username, enter your Redshift database username.
- For Secret Resource Url, enter the secret resource URL.
Click Advanced Options in the sidebar.
All advanced options are optional.
|Record fetch size||Number of records to fetch at once. Set to 0 (zero) to have Dremio Cloud automatically decide. The default record fetch size is 200.|
|Maximum Idle Connections||The total number of connections allowed to be idle at a given time. The default maximum idle connections is 8.|
|Connection Idle Time||The amount of time (in seconds) allowed for a connection to remain idle before the connection is terminated. The default connection idle time is 60 seconds.|
|Connection Properties||Custom key value pairs for the connection relevant to the source. To add a connection property, click Add property and add the property name and value.|
You can configure settings to refresh metadata and handle datasets. Click Metadata in the sidebar.
These are the Dataset Handling parameters.
All Dataset Handling parameters are optional.
|Remove dataset definitions if underlying data is unavailable||By default, Dremio Cloud removes dataset definitions if underlying data is unavailable. Useful when files are temporarily deleted and added back in the same location with new sets of files.|
These are the Metadata Refresh parameters:
Dataset Discovery: The refresh interval for fetching top-level source object names such as databases and tables. Set the time interval using this parameter.
Parameter Description (Optional) Fetch every You can choose to set the frequency to fetch object names in minutes, hours, days, or weeks. The default frequency to fetch object names is 1 hour.
Dataset Details: The metadata that Dremio Cloud needs for query planning such as information required for fields, types, shards, statistics, and locality. These are the parameters to fetch the dataset information.
All Dataset Details parameters are optional.
|Fetch mode||You can choose to fetch only from queried datasets that are set by default. Dremio Cloud updates details for previously queried objects in a source. Fetching from all datasets is deprecated.|
|Fetch every||You can choose to set the frequency to fetch dataset details in minutes, hours, days, or weeks. The default frequency to fetch dataset details is 1 hour.|
|Expire after||You can choose to set the expiry time of dataset details in minutes, hours, days, or weeks. The default expiry time of dataset details is 3 hours.|
You can grant privileges to specific users or roles.
- (Optional) For Privileges, enter the user name or role name that you want to grant access to and click the Add to Privileges button. The added user or role is displayed in the Users table.
- (Optional) For the users or roles in the Users table, toggle the green checkmark for each privilege you want to grant to the Redshift source that is being created.
Click Save after setting the configuration.
Editing a Redshift Source
To edit a Redshift source:
In the Datasets UI, click External Sources at the bottom-left of the page. A list of sources is displayed.
Under the Action column, click the Settings (gear) icon for the source you want to edit. From the list of actions, click Edit Details.
Alternatively, you can click the source and click the Settings (gear) icon of the source.
In the Edit Source dialog, you cannot edit the name. Editing other parameters is optional. For parameters and advanced options, see Dremio Cloud Redshift Configuration.
Removing a Redshift Source
To remove a Redshift source, perform these steps:
- In the Datasets UI, click External Sources at the bottom-left of the page. A list of sources is displayed.
- Under the Action column, click the Settings (gear) icon for the source that you want to remove.
- From the list of actions, click Remove Source. Confirm that you want to remove the source.
Removing a source causes all downstream virtual datasets dependent on objects in this source to break.