Query Library

The Query Library lets you create, run, and share queries across your organization and between Retool apps. Queries in the library are similar to functions in Javascript—you can define variables in them and they return a result. You can then “call” this query inside across multiple Retool apps, so that you’re not copy pasting the same query everywhere.

Features and use cases

Query Library supports:

  • Writing a query for any resource (SQL, Firebase, REST, etc.)
  • Sharing your queries with the rest of your organization
  • Defining variables to your query that you can use when a query is imported
  • Maintaining and rolling back to a previous version of your query
  • Downloading the results of a query as JSON or CSV

Example use cases:

  • Writing a quick SQL statement and sharing the link with your coworker
  • Writing a query that’s used across multiple Retool apps
  • Checking out an older version of a complicated SQL query
  • Storing a SQL snippet for later reference

Permissions

Retool admins can configure who has access to the Query Library via user groups. Note that currently, anyone given access to the Query Library will have both read and write access.

All queries are private when created. While private, they can only be read and updated by the creator. Users can choose to Share a query, which makes it accessible to the entire organization. Note that only private queries can be deleted. As of now, once shared, a query cannot be unshared.

📘

Users only have access to queries if they have access to the resource used in the query. This holds true for shared queries as well.

Version Control

Every time a query in the Query Library is saved, Retool stores a snapshot, similar to a commit. For any query in the Library, you can go through the entire history, see the differences between saves, and revert to a specific version. Both SQL based resources and non-SQL resources have version history, but only SQL resources show a line by line diff on the changes.

📘

While selecting a specific version of an imported query in your Retool apps, you can use this history view to verify the differences.

Reusable Queries

Reusable queries let you import shared queries from the Query Library into your Retool apps. This lets you avoid repetition and maintains a single source of truth for your organization. For example, instead of copy pasting the same query on monthly revenue into each app, you can just maintain one in the Library. When you import a query, you can also specify which version of the query you’d like to import. Note that a query must be shared before you can import it in an app.

For details on how Reusable queries work, check out this guide on reusing queries.

Variables

Variables let you avoid hardcoding pieces of your queries, the same way you can inside a Retool app. In your app you might use select * from users where id = {{ textinput1.value }}, but in the Library, there are no other objects to reference. So, the Query library extracts unknown words inside {{ }}. In this case, you might write select * from users where id = {{ user_id }}, and the Library would pick out user_id and display it on the right.

Note that like in the regular Retool app, you can use Javascript inside {{ }}.
For example, you can:

  • Write expressions like {{ parseInt(user_id) }}
  • Write queries like {{ select * from users where status = {{ age > 65 ? 'retired' : 'working' }}
  • Use libraries like moment or numbro inside {{ }}

For details on how variables work with Reusable queries, check out this guide on reusing queries.

Updated 3 months ago


Query Library


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.