Skip to main content

Connect to Redis

caution

Retool does not support connecting to Redis on Google Cloud Platform.

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

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.

To create a Redis resource, you need:

  • Authentication credentials for the Redis instance, if your instance uses protected mode.
  • Firewall rules that allow Retool to access your Redis instance.

Allow Retool to access Redis

If Redis is behind a firewall, you must allow access from Retool's IP addresses. Add the IP addresses to your firewall's Allowlist before you create the resource.

1. Create a new resource

Sign in to your Retool organization and click the Resources tab. Click Create new > Resource to start configuring your Redis resource.

Create a new resource

2. Select the resource type

Retool can connect to almost any API or database, and has built-in integrations for popular data sources. Select the Redis resource type.

Select the Redis resource type

3. Configure the resource

Specify a name and location for the Redis resource. Retool displays the resource name and type in query editors to help users identify them. Next, configure the required settings.

SettingDescription
HostThe URL or IP address.
PortThe port number.
Database numberThe database number.
PasswordThe database password. This is required if your Redis instance uses protected mode.
Use SSL/TLSConnect to your database with SSL/TLS.
Enable SSH tunnelEnable SSH tunneling through bastion host.

Configure Redis

Click Test Connection to verify that Retool can connect to Redis. If the test fails, check the resource settings and try again. 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. Wrap up

You can now select your newly-created Redis resource from the Resource dropdown in the query editor.

Created Redis resource