Query Builder

Welcome to the Query Builder! This guide will walk you through the main features and interface of the Query tab in our reporting app. You’ll learn how to write and run SQL queries, explore results in different views, tweak parameters, and more.

Accessing the Query Tool

  1. Navigate to your report in the app.
  2. Click on the Queries section in the sidebar.
  3. Select the query you want to work on (or create a new one).

Note: You’ll see a set of tabs across the top—Run, Query, Table, Params, Rendered Query, Run History, and Download Results.

Query Tab

This is the primary workspace for writing and editing SQL queries.

  • The top half is a code editor (Monaco) where you can type or paste SQL.
  • The bottom half displays results in a table once you run the query.
  • You can drag the horizontal divider to resize editor vs. results.

Query Tab Interface

Steps to run a query:

  1. Write your SQL in the editor.
  2. Click the Run tab (▶️) or press Ctrl/Cmd + Enter.
  3. Results will appear below; columns are sortable.

Table Tab

View your last query results in a full-screen table:

  • Pagination is fixed to 50 rows per page.
  • You can sort by any column header.

Table Tab Interface

Params Tab

If your query uses parameters (defined in YAML), the Params tab lets you:

  1. Fill in or adjust parameter values via a form.
  2. Re-run the query with new values to see updated results.

Params Tab Interface

Rendered Query Tab

See the actual SQL sent to the database after Liquid templating:

  • Read-only editor.
  • Handy for debugging or copying the final statement.

Rendered Query Interface

Options Drawer (Settings & Schema)

Click the ⚙️ icon in the top-right to open the drawer:

  • Database Connection: Switch between your configured connections.
  • Database Schema: Browse tables and columns for auto-completion.
  • Query Name: Rename your query on the fly.

Options Drawer Interface

Query Scheduling

  • Schedule: Set up a schedule for your query to run automatically.
  • Notifications: Check how to set up alert for that will be triggered when the query runs and conditions are met.

Options Drawer Interface

Keyboard Shortcuts

  • Ctrl/Cmd + Enter: Run the current query (or selected text).
  • Drag Divider: Click and drag the gray bar between editor and results to resize.

Liquid Templating (Preview)

Under the hood, we use Liquid to inject parameters into your SQL.

We’ll dig deeper into Liquid templating—how to write assign statements, use filters, and more—in the next section.

End of Query Tool guide. Happy querying!