Skip to main content

Connect to RethinkDB

You can connect your RethinkDB database make it available as a resource in Retool. Once complete, your users can write queries that interact with RethinkDB 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 RethinkDB resource, you need:

  • Authentication credentials for the RethinkDB database.
  • Connection details for the RethinkDB database host. This includes the hostname, port, and database name.
  • Firewall rules that allow Retool to access your RethinkDB host.

Allow Retool to access RethinkDB

If RethinkDB 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 navigate to the Resources tab. Click Create new, then select 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 RethinkDB resource type.

Select the RethinkDB resource type

3. Configure the resource

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

General

SettingDescription
HostThe URL or IP address.
PortThe port number.
Database nameThe name of the database.
Database usernameThe name of the database user.
Database passwordThe password of the database user.
Use SSL/TLSConnect to your database with SSL/TLS.
Enable SSH tunnelEnable SSH tunneling through bastion host.

Configure the RethinkDB resource

Click Test Connection to verify that Retool can connect to RethinkDB. 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. 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.

Save the resource

Wrap up

Your RethinkDB resource is now ready to use. To interact with RethinkDB data, select the resource in the query editor.