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 "list" component

A vertical list of items. Each item can be clickable and link to another page.

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.

empty_description

Description to display if the list is empty.

empty_description_md

Description to display if the list is empty, in Markdown format.

empty_link

URL to which the user should be taken if they click on the empty list.

empty_title

Title text to display if the list is empty.

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).

title

Text header at the top of the list.

Row-level parameters

title

REQUIRED. Name of the list item, displayed prominently.

active

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

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.

color

The name of a color, to be displayed as a dot near the list item contents.

delete_link

A URL to which the user should be taken when they click on the "delete" icon. Does not show the icon when omitted.

description

A description of the list item, displayed as greyed-out text.

description_md

A description of the list item, displayed as greyed-out text, in Markdown format, allowing you to use rich text formatting, including **bold** and *italic* text.

edit_link

A URL to which the user should be taken when they click on the "edit" icon. Does not show the icon when omitted.

icon

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

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

The URL of a small image to display on the left side of the item.

link

An URL to which the user should be taken when they click on the list item.

view_link

A URL to which the user should be taken when they click on the "view" icon. Does not show the icon when omitted.

Example 1

The most basic list

select 
    'list' as component;
select 
    'A' as title;
select 
    'B' as title;
select 
    'C' as title;

Result

A
B
C

Example 2

An empty list with a link to add an item

select 
    'list'              as component,
    'No items yet'      as empty_title,
    'This list is empty. Click here to create a new item !' as empty_description,
    'documentation.sql' as empty_link;

Result

Example 3

A list with rich text descriptions

select 
    'list' as component;
select 
    'SQLPage' as title,
    'https://raw.githubusercontent.com/lovasoa/SQLpage/main/docs/favicon.png' as image_url,
    'A **SQL**-based **page** generator for **PostgreSQL**, **MySQL**, **SQLite** and **SQL Server**. [Free on Github](https://github.com/lovasoa/sqlpage)' as description_md;
select 
    'Tabler' as title,
    'https://avatars.githubusercontent.com/u/35471246' as image_url,
    'A **free** and **open-source** **HTML** template pack based on **Bootstrap**.' as description_md;
select 
    'Tabler Icons' as title,
    'https://tabler.io/favicon.ico' as image_url,
    'A set of over **700** free MIT-licensed high-quality **SVG** icons for you to use in your web projects.' as description_md;

Result

SQLPage
SQLPage

A SQL-based page generator for PostgreSQL, MySQL, SQLite and SQL Server. Free on Github

Tabler
Tabler

A free and open-source HTML template pack based on Bootstrap.

Tabler Icons
Tabler Icons

A set of over 700 free MIT-licensed high-quality SVG icons for you to use in your web projects.

Example 4

A beautiful list with bells and whistles.

select 
    'list'             as component,
    'Popular websites' as title;
select 
    'Google'             as title,
    'https://google.com' as link,
    'A search engine'    as description,
    'red'                as color,
    'brand-google'       as icon,
    TRUE                 as active;
select 
    'Wikipedia'             as title,
    'https://wikipedia.org' as link,
    'An encyclopedia'       as description,
    'blue'                  as color,
    'world'                 as icon,
    '?edit=wikipedia'       as edit_link,
    '?delete=wikipedia'     as delete_link;

Result

Official SQLPage documentation