sqlpage 0.3.1

A SQL-only web application framework. Takes .sql files and formats the query result using pre-made configurable professional-looking components.
sqlpage-0.3.1 is not a library.

A short video explaining the concept of sqlpage

SQLPage is an SQL-only webapp builder. It is meant for data scientists, analysts, and business intelligence teams to build powerful data-centric applications quickly, without worrying about any of the traditional web programming languages and concepts.

With SQLPage, you write simple .sql files containing queries to your database to select, group, update, insert, and delete your data, and you get good-looking clean webpages displaying your data as text, lists, grids, plots, and forms.

Examples

SELECT 
    'list' as component,
    'Popular websites' as title;
SELECT 
    name as title,
    url as link,
    CASE type
      WHEN 1 THEN 'green'
      ELSE 'red'
    END as color,
    description, icon, active
FROM website;

SQLPage list component

SELECT
  'chart' as component,
  'Syracuse' as title, 'area' as type;
SELECT month AS x, SUM(revenue) AS y
FROM income GROUP BY month;  

SQLPage list component

SELECT 
    'form' as component,
    'User' as title,
    'Create new user' as validate;
SELECT 
    name, type, placeholder, required,
    description, min, max
FROM user_form;

SQLPage list component

Supported databases

  • sqlite
  • PostgreSQL, and other compatible databases such as CockroachDB and Aurora.
  • MySQL, and other compatible databases such as MariaDB and TiDB.

How it works

SQLPage is a web server written in rust and distributed as a single executable file. When it receives a request to a URL ending in .sql, it finds the corresponding SQL file, runs it on the database, passing it information from the web request as SQL statement parameters. When the database starts returning rows for the query, SQLPage maps each piece of information in the row to a parameter in one of its pre-defined components' templates, and streams the result back to the user's browser.

Get started

  • Install docker
  • In a terminal, run the following command: docker run -it --name sqlpage -p 8080:8080 --volume "$(pwd):/var/www" --rm lovasoa/sqlpage
  • Create a file called index.sql with the contents from this example
  • Open https://localhost:8080 in your browser

Environment variables

variable default description
LISTEN_ON 0.0.0.0:8080 Interface and port on which the web server should listen
DATABASE_URL sqlite://sqlpage.db?mode=rwc Database connection URL

Serverless

You can run SQLpage serverless by compiling it to an AWS Lambda function. An easy way to do so is using the provided docker image:

 docker build -t sqlpage-lambda-builder . -f lambda.Dockerfile --target builder
 docker run sqlpage-lambda-builder cat deploy.zip > deploy.zip

You can then use deploy.zip as the source for an AWS Lambda, selecting Custom runtime on Amazon Linux 2 as a runtime.

Technologies and libraries used

  • actix web handles HTTP requests at an incredible speed,
  • tabler handles the styling for professional-looking clean components,
  • tabler icons is a large set of icons you can select directly from your SQL,
  • handlebars render HTML pages from readable templates for each component.