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

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.

Parameters

center (top-level)

Whether to center the title.

BOOLEAN

html (top-level)

Raw html code to include on the page. Don't use that if you are not sure what you are doing, it may have security implications.

TEXT

title (top-level)

Text header before the paragraph.

TEXT

width (top-level)

How wide the paragraph should be, in characters.

INTEGER

contents

REQUIRED. A span of text to display

TEXT

bold

Whether the span of text should be displayed as bold.

BOOLEAN

break

Indicates that the current span of text starts a new paragraph.

BOOLEAN

code

Use a monospace font. Useful to display the text as code.

BOOLEAN

color

The name of a color for this span of text.

TEXT

italics

Whether the span of text should be displayed as italics.

BOOLEAN

link

An URL to which the user should be taken when they click on this span of text.

URL

size

A number between 1 and 6 indicating the font size.

INTEGER

underline

Whether the span of text should be underlined.

BOOLEAN

Example 1

Rendering a simple text paragraph.

SELECT 
    'text' as component,
    'Hello, world ! <3' as contents;

Result

Hello, world ! <3

Example 2

Rendering a paragraph with links and styling.

SELECT 
    'text' as component,
    'About SQL' as title;
SELECT 
    'SQL' as contents,
    '1' as bold,
    '1' as italics;
SELECT 
    ' is a domain-specific language used in programming and designed for managing data held in a ' as contents;
SELECT 
    'relational database management system' as contents,
    'https://en.wikipedia.org/wiki/Relational_database' as link;
SELECT 
    '. It is particularly useful in handling structured data.' as contents;

Result

About SQL

SQL is a domain-specific language used in programming and designed for managing data held in a relational database management system. It is particularly useful in handling structured data.