Skip to main content

Connect to Redis

Learn how to connect your Redis database to Retool.

You can connect to Redis and make it available as a resource in Retool. Once complete, your users can write queries that interact with Redis data.

Requirements and settings

warning

Retool does not currently support Redis data sources on Google Cloud Platform.

The following requirements for a Redis resource depend on whether you are creating a resource on a cloud-hosted Retool organization or a self-hosted deployment.

Requirements for cloud-hosted Retool

The following requirements must be met to successfully create Redis resources.

RequirementDescription
Sufficient user permissions to create resources

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

Resource configuration settings

You must be able to provide the settings needed to create a resource. This may require you to perform actions, such as generating access credentials or creating a client application.

Resource authentication settings

You must have access to the data source and sufficient permissions to perform the actions needed, and be able to provide valid authentication settings.

Allow Retool access to the data source

If the data source is behind a firewall or restricts access based on IP address then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

Configuration settings for cloud-hosted Retool

Cloud-hosted Retool organizations support the following configuration settings.

SettingDescription
Host

The host server address.

Port

The host server connection port.

Database ID or number

The ID or number of the database to use.

Cloud-hosted Retool organizations can also optionally configure the following advanced options.

SettingDescription
Override default outbound Retool region

Specify a different outbound region from which Retool connects. This can improve performance if your resource is located in a different region to us-west-2.

Enable SSH tunnel

Whether to enable SSH tunneling.

Authentication settings for cloud-hosted Retool

Cloud-hosted Retool organizations can authenticate with this resource using the following methods. You must be able to provide the necessary credentials for the method you wish to use.

AWS IAM

Authentication is performed using AWS identity and access management (IAM) access keys for which you provide details.

SettingDescription
Database username

The username with which to authenticate.

Region

The AWS region with which to connect. This is often part of the base URL.

Access key ID

The access key ID with which to authenticate.

Secret key ID

The secret key ID with which to authenticate.

Role to assume (ARN)

A different role with which to access the API.

1. Create a resource

Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Redis.

2. Configure the resource

Specify a name and location for your Redis resource. Retool displays the resource name and type in query editors to help users identify them. Next, provide the required information to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

3. Test the connection

Click Test Connection to verify that Retool can successfully connect to Redis. If the test fails, check the resource settings and try again.

Testing only verifies connection

Testing a connection only checks whether Retool can successfully connect to the resource. It cannot check whether the provided credentials have sufficient privileges or can perform every supported action.

4. Save the resource

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your Redis resource is now ready to use. To start querying Redis data:

  1. Add a Resource query to an app or a Resource query block to a workflow.
  2. Select the new Redis resource from the resources dropdown.
  3. Write and run a query.