Connect to Redis
Learn how to connect your Redis database to Retool.
You can use the Redis integration to create a resource and make it available in Retool. Once complete, your users can write queries that interact with Redis data.
Requirements
The Redis integration requirements depend on whether you have a cloud-hosted or self-hosted Retool organization. You may also need to make Redis configuration changes before creating the resource.
- Cloud-hosted organizations
- Self-hosted organizations
Sufficient user permissions to create resources
Allow Retool to access the data source
Redis settings and authentication
Sufficient user permissions to create resources
Allow your deployment to access the data source
Redis settings and authentication
Configure the resource
Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Redis.
Configuration
Specify the name, location, and description to use for your Redis resource. Retool displays the resource name and type in query editors to help users identify them.
Provide the following configuration settings to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.
- Cloud-hosted organizations
- Self-hosted organizations
Name
Description
Host
Port
Database number
Enable SSH tunnel
Override default outbound Retool region
Name
Description
Host
Port
Database number
Enable SSH tunnel
Authentication
The Redis integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your Redis configuration.
- Cloud-hosted organizations
- Self-hosted organizations
Username and password
SSL/TLS validation
Retool strongly recommends enabling SSL/TLS certificate validation whenever it's available. This ensures the connection is secure and prevents attackers from using invalid server certificates to gain access to your data.
Some resources support or require SSL/TLS validation. If needed, provide the following information to configure SSL.
CA Cert
Client key
Client cert
Verification mode
Test the connection
Click Test Connection to verify that Retool can successfully connect to the data source. 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.
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.
Next steps
Your Redis resource is now ready to use. Check out related queries and code documentation to learn how to interact with Redis data.
Queries and code quickstart
Fundamental concepts of queries and code.
Resource query tutorial
Hands-on introduction to querying APIs and databases.
Explore database schemas
Learn how to explore database schemas.
Read SQL data
Learn how to retrieve data with SQL.
Write SQL data
Learn how to write data with SQL.