QStudio - SQL Notebooks

SQL Notebooks allow developers to write Markdown+SQL and to produce live HTML5 reports.

This page documents specifically how to get started using SQL Notebooks within QStudio. For the complete documentation and tutorials see our specific SQL Notebook Documentation and our SQL Notebook page.

Starting and Stopping

Pulse SQL Notebooks can be started from the Tools Menu or by clicking the Pulse icon on the toolbar:

Once the webserver has been started the icon will turn blue. Right-clicking on the blue icon will stop the server and turn the icon red again.

Getting Started

1. Clicking the Pulse Icon will start the server.
2. In the File Tree this will open the sqlnotebook folder located at: C:\Users\{{username}}\qStudio\sqlnotebook by default on windows.Click on one of the .md files to open it.
3. Inside the .md files is standard markdown plus SQL code blocks that allow rendering charts and tables.

At the same time, a web browser should have opened showing: http://localhost:8088/markdown/ like so. Notice:

1. Each .md file in the File Tree under the pages folder maps to one page on the website.
2. Each header within the current .md file, becomes an item on the right hand side menu.
3. Every SQL ``` Code Block renders as a chart or a table.

Add Chart

To add a chart or table, start an SQL ``` Code Block with three backticks. Enter the SQL as shown below and end with three backticks. For example:

```sql type="timeseries" server="localhost:6000" select from coststable ```

Chart Options include: grid, timeseries, area, line, bar, stack, bar_horizontal, stack_horizontal, pie, scatter, bubble, candle, depthmap, radar, treemap, heatmap, calendar, boxplot, 3dsurface, 3dbar, sunburst, tree, metrics, sankey

The server should be set to a server name that exists within QStudio. Note, Ctrl + Space can be used to autocomplete the server names like so:

Add Page

1. Right-click on the pages folder and select New File
2. Enter a file name that MUST end with .md and press enter.
3. Left-click on the file tree to open the file and enter some markdown then Press Ctrl + S to save.
4. The new page should now be visible on the web version.