Getting Started

The Guide for Smooth Onboarding.

This guide comprises a quick walk-through of a basic use case:
The creation of a parameterised query with a chart, which can then be shared and scheduled.

Feel free to watch the video to the right, or scroll through this guide - the content is similar.

1. Create an Account

Navigate to to create an account.

Every account comes with a "Welcome Notebook" and a Demo (postgres) database.
Click here to go straight to the Welcome Notebook.

2. Connect your DB

Navigate to to view and create database connections.

  1. Click New database to the top-left
  2. Choose your Database type
  3. Follow the instructions or get help in the Documentation
SQL results features
Database Connectors

3. Create a Notebook

Navigate to to view and create Notebooks.
  • Notebooks consist of Blocks that can be created using the -button or the assigned hotkeys shown in the add-block-menu.
  • Notebooks are divided into pages that can be created, browsed and removed in the Sidebar.
  • Notebooks can be Exectuted, Sent,and Scheduled in the top navigation.
  • Notebooks have a Viewing and an Editing mode. You can change mode freely unless you do not have editing permission.
SQL results features
Notebook Anatomy

4. Create a SQL block

  • To toggle the add-block-menu click the + -button or [cmd] + [dot] .
  • Select a block-type using the mouse, search function or arrow keys.
  • Blocks can be created via hotkeys by typing the given key combination, followed by [spacebar] into an empty text-block.
Add Block Anatomy
Add Block Anatomy
Add Block Gif
Add Block Gif

5. Run a Query

  • Query blocks are run by clicking the -button
  • Try running a SELECT 1 to get started.
  • Make sure that your SQL block is connected to the correct Database.
  • Try out the Data-tab to explore your data.
  • The -button let's you paste a pre-written query.
  • The -button let's you preview a table.

Try running the following code:

    date_trunc('month', orderdate) as day, 
    sum(profit) as profit 
FROM demo_data.store_orders
group by 1,2

6. Create a chart

  • The -button on the sql block is quickest to create a chart.
  • A Chart can have any amount of Layers. Just add them once you have created the Chart block.

7. Use a Parameter

  • Parameters allow you to pull data from a dedicated input box.
  • Choose a format from String, Number, Boolean, or Date .
  • Parameters are added by wrapping them in curly brackets: {{parameter}}

8. Share your Notebook

  • Public notebooks can be viewed and copied by anyone with the link.
  • Notebooks shared with the Workspace can be set to view or edit.
  • Notebooks shared with the Workspace can be set to view or edit.
SQL results features
Share Notebook

That's it ?

Welcome aboard!

With any questions or feedback, please contact us anytime!

SQL results features
Jump to