Running Queries
Once you've added a connection you will be able to run SQL queries to explore your data, either interactively in the console, or via any PostgreSQL-compatible client.
Exploring Schemas
If you navigate to your workspace, then the Query tab, you'll see the interactive query console.
From here you can either explore your schemas on the left, or dive right in and
test out your own queries in the editor. The schema list supports flexible
searching across all the tables in your schemas. For example, if you search for
hack new
, that will find a match for the hackernews_show_hn
table in our
hackernews
schema.
Clicking the search result will automatically generate a query to select all the columns from that schema table, limited to 100 rows and will automatically run it for you.
If you click the Edit
button you can amend the query, perhaps by selecting
just the columns you're interested in, or adding a where
clause to filter the
results. Please note that we limit queries to 5,000 rows in the interactive
query console.
Downloading Results
After you've run a query, you can download the results to a CSV file by clicking the Download button at the bottom of the query editor.
Saving Snapshots
Turbot Pipes allows you to save and share query snapshots that are dashboards containing a table generated from your query results.
To take a snapshot, click the Snap button at the top of the query editor after you have run the query you wish to snap.
This will then take you to the dashboard snapshot view.
You can manage this snapshot and browse others from the Dashboards page.
Scheduling Query Snapshots
Rather than manually capture query snapshots, Turbot Pipes allows you to schedule them and be notified when complete.
Scheduling a snapshot is as simple as navigating to the query editor, selecting a table or writing a query and choosing the Schedule dropdown from the query toolbar.
From here you can either choose to create a new schedule, or see any existing schedules that are configured for this query.
If you select New Schedule you'll be presented with the following screen.
Option | Description |
---|---|
Title | The title of the pipeline that will run this schedule. |
Frequency | How often scheduled snapshot should run:Weekly , Daily , Hourly , Custom For Weekly , Daily and Hourly frequencies, Turbot Pipes will automatically allocate a random time for these, with Weekly schedules being run at that time on a Sunday. For a Custom frequency, you can supply a cron schedule (not more than once every 15 minutes). |
Visibility | Optionally choose the visibility of the snapshot generated. By default, visibility is restricted to only those with access to your workspace, but you can choose to share it such that anyone on the internet with the link can view it. |
Notifications | Optionally send a summary notification to a Slack and/or Microsoft Teams webhook. This will contain a link back to the Snapshot. |
Snapshot tags | Add optional tags to the created snapshot. These can be used to easily find snapshots at a later date via the search functionality. |
After scheduling a snapshot, you will be taken to the pipeline detail page, which shows you editable details of the schedule, information on its next run and last run status, along with a link out to the process logs.
The scheduled snapshot pipeline will upload the snapshot to your workspace as
the system
user, rather than attribute the activity to the user creating the
schedule. We will retry steps in the pipeline where possible e.g. any 5xx series
errors from a call to a notification webhook will retry up to a maximum of 2
times, whereas a 400 error would not retry.