SQLPage v0.20.5 documentation

If you are completely new to SQLPage, you should start by reading the get started tutorial, which will guide you through the process of creating your first SQLPage application.

Building an application with SQLPage is quite simple. To create a new web page, just create a new SQL file. For each SELECT statement that you write, the data it returns will be analyzed and rendered to the user. The two most important concepts in SQLPage are components and parameters.

To select a component and set its top-level properties, you write the following SQL statement:

SELECT 'component_name' AS component, 'my value' AS top_level_parameter_1;

Then, you can set its row-level parameters by writing a second SELECT statement:

SELECT my_column_1 AS row_level_parameter_1, my_column_2 AS row_level_parameter_2 FROM my_table;

This page documents all the components provided by default in SQLPage and their parameters. Use this as a reference when building your SQL application. If at any point you need help, you can ask for it on the SQLPage forum.

If you know some HTML, you can also easily create your own components for your application.

components

The "datagrid" component

Display small pieces of information in a clear and readable way. Each item has a name and is associated with a value.

Top-level parameters

class

class attribute added to the container in HTML. It can be used to apply custom styling to this item through css. Added in v0.18.0.

description

A short paragraph displayed below the title.

description_md

A short paragraph displayed below the title - formatted using markdown.

icon

Name of an icon to display on the left side of the title.

id

id attribute added to the container in HTML. It can be used to target this item through css or for scrolling to this item through links (use "#id" in link url).

image_url

URL of an image to display on the left side of the title.

title

Text header at the top of the data grid.

Row-level parameters

title

REQUIRED. Name of the piece of information.

active

Whether this item in the grid is considered "active". Active items are displayed more prominently.

color

If set to a color name, the value will be displayed in a pill of that color.

description

Value to display below the name.

footer

Muted text to display below the value.

icon

An icon name (from tabler-icons.io) to display on the left side of the value.

image_url

URL of a small image (such as an avatar) to display on the left side of the value.

link

A target URL to which the user should be taken when they click on the value.

Example 1

Just some sections of information.

select 
    'datagrid' as component;
select 
    'Language' as title,
    'SQL'      as description;
select 
    'Creation date' as title,
    '1974'          as description;
select 
    'Language family' as title,
    'Query language'  as description;

Result

Language
SQL
Creation date
1974
Language family
Query language

Example 2

A beautiful data grid with nice colors and icons.

select 
    'datagrid'              as component,
    'Ophir Lojkine'         as title,
    'https://avatars.githubusercontent.com/u/552629' as image_url,
    'Member since **2021**' as description_md;
select 
    'Pseudo'  as title,
    'lovasoa' as description,
    'https://avatars.githubusercontent.com/u/552629' as image_url;
select 
    'Status' as title,
    'Active' as description,
    'green'  as color;
select 
    'Email Status' as title,
    'Validated'    as description,
    'check'        as icon,
    TRUE           as active;
select 
    'Personal page'      as title,
    'ophir.dev'          as description,
    'https://ophir.dev/' as link;

Result

Ophir Lojkine

Ophir Lojkine

Member since 2021

Pseudo
Pseudo lovasoa
Status
Active
Email Status
Validated
Personal page

Example 3

Using a picture in the data grid card header.

select 
    'datagrid'      as component,
    'Website Ideas' as title,
    'bulb'          as icon;
select 
    'Search engine'          as title,
    'https://google.com'     as link,
    'Google'                 as description,
    'red'                    as color,
    'brand-google'           as icon,
    'Owned by Alphabet Inc.' as footer;
select 
    'Encyclopedia'          as title,
    'https://wikipedia.org' as link,
    'Wikipedia'             as description,
    'blue'                  as color,
    'world'                 as icon,
    'Owned by the Wikimedia Foundation' as footer;

Result

Website Ideas

Search engine
Google Owned by Alphabet Inc.
Encyclopedia
Wikipedia Owned by the Wikimedia Foundation

Official SQLPage documentation