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
list
A vertical list of items. Each item can be clickable and link to another page.
card
A grid where each element is a small card that displays a piece of data.
datagrid
Display small pieces of information in a clear and readable way. Each item has a name and is associated with a value.
steps
Guide users through multi-stage processes, displaying a clear list of previous and future steps.
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.
form
A series of input fields that can be filled in by the user. The form contents can be posted and handled by another SQLPage. The value entered by the user in a field named x will be accessible to the target SQL page as $x.
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.
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.
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.
dynamic
A special component that can be used to render other components, the number and properties of which are not known in advance.
shell
Personalize the "shell" surrounding your page contents. Used to set properties for the entire page.
The "csv" component
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.
Parameters
title (top-level)
REQUIRED. The text displayed on the download button.
color (top-level)
Color of the button
filename (top-level)
The name of the file that should be downloaded (without the extension).
icon (top-level)
Name of the icon (from tabler-icons.io) to display in the button.
separator (top-level)
How individual values should be separated in the CSV. "," by default, set it to "\t" for tab-separated values.
Example 1
CSV download button
SELECT
'csv' as component,
'Download my data' as title,
'people' as filename,
'file-download' as icon,
'green' as color;
SELECT
'Ophir' as Forename,
'Lojkine' as Surname,
'lovasoa' as Pseudonym;
SELECT
'Linus' as Forename,
'Torvalds' as Surname,
'torvalds' as Pseudonym;