SQLPage documentation

The two most important concepts in SQLPage are components and parameters. This page documents all the components that you can use in SQLPage and their parameters. Use this as a reference when building your SQL application.

components

alert
A visually distinctive message or notification.
card
A grid where each element is a small card that displays a piece of data.
chart
A component that plots data. Line, area, bar, and pie charts are all supported. Each item in the component is a data point in the graph.
csv
A button that lets the user download data as a CSV file. Each column from the items in the component will map to a column in the resulting CSV.
datagrid
Display small pieces of information in a clear and readable way. Each item has a name and is associated with a value.
dynamic
A special component that can be used to render other components, the number and properties of which are not known in advance.
form
A series of input fields that can be filled in by the user. The form contents can be posted and handled by another sql file in your site. The value entered by the user in a field named x will be accessible to the target SQL page as a variable named $x. For instance, you can create a SQL page named "create_user.sql" that would contain "INSERT INTO users(name) VALUES($name)" and a form with its action property set to "create_user.sql" that would contain a field named "name"."
hero
Display a large title and description for your page, with an optional large illustrative image. Useful in your home page, for instance.
http_header
An advanced component that can be used to create redirections, set a custom caching policy to your pages, or set any HTTP header. If you are a beginner, you probably don't need this component. When used, this component has to be the first component in the page, because once the page is sent to the browser, it is too late to change the headers. Any valid HTTP header can be used as a top-level parameter for this component. HTTP headers are additional pieces of information sent with responses to web requests that provide instructions or metadata about the data being sent — for example, setting cache control directives to control caching behavior or specifying the content type of a response.
list
A vertical list of items. Each item can be clickable and link to another page.
shell
Personalize the "shell" surrounding your page contents. Used to set properties for the entire page.
steps
Guide users through multi-stage processes, displaying a clear list of previous and future steps.
table
A table with optional filtering and sorting. Unlike most others, this component does not have a fixed set of item properties, any property that is used will be rendered directly as a column in the table.
text
A paragraph of text. The entire component will render as a single paragraph, with each item being rendered as a span of text inside it, the styling of which can be customized using parameters.

The "shell" component

Personalize the "shell" surrounding your page contents. Used to set properties for the entire page.

Top-level parameters

description

A description of the page. It can be displayed by search engines when your page appears in their results.

TEXT

fonr

Name of a font to display the text in. This has to be a valid font name from fonts.google.com.

TEXT

icon

Name of an icon (from tabler-icons.io) to display next to the title in the navigation bar.

TEXT

image

The URL of an image to display next to the page title.

URL

link

The target of the link in the top navigation bar.

URL

menu_item

Adds a menu item in the navigation bar at the top of the page. The menu item will have the specified name, and will link to as .sql file of the same name.

TEXT

norobot

Forbids robots to save this page in their database and follow the links on this page. This will prevent this page to appear in Google search results for any query, for instance.

BOOLEAN

search_target

When this is set, a search field will appear in the top navigation bar, and load the specified sql file with an URL parameter named "search" when the user searches something.

TEXT

title

The title of your page. Will be shown in a top bar above the page contents. Also usually displayed by web browsers as the name of the web page's tab.

TEXT

Example 1

This example contains the values used for the shell of the page you are currently viewing.

SELECT 
    'SQLPage documentation' as title,
    '/' as link,
    'index' as menu_item,
    'en-US' as lang,
    'Documentation for the SQLPage low-code web application framework.' as description,
    'Poppins' as font,
    'book' as icon;