SQLPage v0.20.4 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.
If you know some HTML, you can also easily create your own components for your application.
components
The "alert" component
A visually distinctive message or notification.
Top-level parameters
title
class
color
description
description_md
dismissible
icon
id
important
link
link_text
Row-level parameters
color
link
title
Example 1
A basic alert message
select
'alert' as component,
'Attention' as title,
'This is an important message.' as description;
Result
Attention
Example 2
A list of notifications
select
'alert' as component,
'Success' as title,
'Item successfully added to your cart.' as description,
'check' as icon,
'green' as color;
select
'alert' as component,
'Warning' as title,
'Your cart is almost full.' as description,
'alert-triangle' as icon,
'yellow' as color;
select
'alert' as component,
'Error' as title,
'Your cart is full.' as description,
'alert-circle' as icon,
'red' as color;
Result
Success
Warning
Error
Example 3
A full-featured notification message with multiple links
select
'alert' as component,
'Your dashboard is ready!' as title,
'analyze' as icon,
'teal' as color,
TRUE as dismissible,
'Your public web dashboard was successfully created.' as description;
select
'dashboard.sql' as link,
'View your dashboard' as title;
select
'index.sql' as link,
'Back to home' as title,
'secondary' as color;
Result
Your dashboard is ready!
Example 4
An important danger alert message with an icon and color
select
'alert' as component,
'Alert' as title,
'alert-circle' as icon,
'red' as color,
TRUE as important,
TRUE as dismissible,
'SQLPage is entirely free and open source.' as description,
'https://github.com/lovasoa/SQLPage' as link,
'See source code' as link_text;
Result
Example 5
An alert message with a Markdown-formatted description
select
'alert' as component,
'Free and open source' as title,
'free-rights' as icon,
'info' as color,
'*SQLPage* is entirely free and open source. You can **contribute** to it on [GitHub](https://github.com/lovasoa/SQLPage).' as description_md;
Result
Free and open source
SQLPage is entirely free and open source. You can contribute to it on GitHub.