SQLPage v0.20.5 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.

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

Visualize any set of values as JSON. Can be used to display all the parameters passed to the component. Useful for debugging: just replace the name of the component you want to debug with 'debug', and see all the top-level and row-level parameters that are passed to it, and their types.

Top-level parameters

Example 1

At any time, if you are confused about what data you are passing to a component, just replace the component name with 'debug' to see all the parameters that are passed to it.

select 
    'debug' as component,
    TRUE    as my_top_level_property;
select 
    'y' as x,
    42  as z;
select 
    'b'  as a,
    NULL as c;

Result

Debug output

{"component":"debug","my_top_level_property":true}
{"x":"y","z":42}
{"a":"b","c":null}

Examples

Show the result of a SQLPage function:

select 'debug' as component, sqlpage.environment_variable('HOME');

Official SQLPage documentation