SQLPage v0.17.1 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.
- components are small user interface elements that you can use to display your data in a certain way.
- top-level parameters are the properties of these components, allowing you to customize their appearance and behavior.
- row-level parameters constitute the data that you want to display in the components.
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.
The "list" component
A vertical list of items. Each item can be clickable and link to another page.
The most basic list
select 'list' as component; select 'A' as title; select 'B' as title; select 'C' as title;
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;
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-icons.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;
A free and open-source HTML template pack based on Bootstrap.
A set of over 700 free MIT-licensed high-quality SVG icons for you to use in your web projects.
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;