Connect to gRPC
Learn how to connect your gRPC database to Retool.
You can use the gRPC integration to create a resource and make it available in Retool. Once complete, your users can write queries that interact with gRPC data.
Requirements
The gRPC integration requirements depend on whether you have a cloud-hosted or self-hosted Retool organization. You may also need to make gRPC 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
gRPC settings and authentication
Sufficient user permissions to create resources
Allow your deployment to access the data source
gRPC settings and authentication
Configure the resource
Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select gRPC.
Configuration
Specify the name, location, and description to use for your gRPC 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
Service definition source
Maximum incoming message size
Maximum outgoing message size
Headers
Override default outbound Retool region
Name
Description
Host
Port
Service definition source
Service name
Maximum incoming message size
Maximum outgoing message size
Headers
Authentication
The gRPC integration supports the following authentication methods. Depending on which authentication method you use, you may need to make changes to your gRPC configuration.
- Cloud-hosted organizations
- Self-hosted organizations
Auth0
Bearer Token
Custom OAuth 2.0 client credentials
Auth0
Bearer Token
Custom OAuth 2.0 client credentials
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 gRPC resource is now ready to use. Check out related queries and code documentation to learn how to interact with gRPC data.
Queries and code quickstart
Fundamental concepts of queries and code.