search

lovasoa / SQLpage

SQL-only webapp builder, empowering data analysts to build websites and applications quickly
https://sql.ophir.dev
MIT License
880 stars 62 forks source link
database framework mysql postgresql server serverless sql sqlite web

readme

SQLpage

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

CodeResult
```sql SELECT 'list' as component, 'Popular websites' as title; SELECT name as title, url as link, CASE type WHEN 1 THEN 'blue' ELSE 'red' END as color, description, icon, active FROM website; ``` ![SQLPage list component](./docs/demo-list.png)
```sql SELECT 'chart' as component, 'Quarterly Revenue' as title, 'area' as type; SELECT quarter AS x, SUM(revenue) AS y FROM finances GROUP BY quarter ``` ![SQLPage list component](./docs/demo-graph.png)
```sql SELECT 'form' as component, 'User' as title, 'Create new user' as validate; SELECT name, type, placeholder, required, description FROM user_form; INSERT INTO user SELECT $first_name, $last_name, $birth_date WHERE $first_name IS NOT NULL; ``` ![SQLPage list component](./docs/demo-form.png)
```sql select 'tab' as component, true as center; select 'Show all cards' as title, '?' as link, $tab is null as active; select format('Show %s cards', color) as title, format('?tab=%s', color) as link, $tab=color as active from tab_example_cards group by color; select 'card' as component; select title, description, color image_url as top_image, link from tab_example_cards where $tab is null or $tab = color; select 'text' as component, sqlpage.read_file_as_text('footer.md') as contents_md ``` ![card component sql example](./docs/cards.png)

Supported databases

How it works

architecture diagram

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

Read the official get started guide on SQLPage's website.

Using executables

The easiest way to get started is to download the latest release from the releases page.

With docker

To run on a server, you can use the docker image:

We provide compiled binaries only for the x86_64 architecture, but provide docker images for other architectures, including arm64 and armv7. If you want to run SQLPage on a Raspberry Pi or a cheaper ARM cloud instance, using the docker image is the easiest way to do it.

On Mac OS, with homebrew

An alternative for Mac OS users is to use SQLPage's homebrew package.

Examples

You can try all the examples online without installing anything on your computer using SQLPage's online demo on replit.

Configuration

SQLPage can be configured through either a configuration file placed in sqlpage/sqlpage.json or environment variables such as DATABASE_URL or LISTEN_ON.

For more information, read configuration.md.

Additionally, custom components can be created by placing .handlebars files in sqlpage/templates. Example.

HTTPS

SQLPage supports HTTP/2 and HTTPS natively and transparently. Just set SQLPAGE_HTTPS_DOMAIN=example.com, and SQLPage will automatically request a trusted certificate and start encrypting all your user's traffic with it. No tedious manual configuration for you, and no annoying "Connection is Not Secure" messages for your users !

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 > sqlpage-aws-lambda.zip

You can then just add your own SQL files to sqlpage-aws-lambda.zip, and upload it to AWS Lambda, selecting Custom runtime on Amazon Linux 2 as a runtime.

Hosting sql files directly inside the database

When running serverless, you can include the SQL files directly in the image that you are deploying. But if you want to be able to update your sql files on the fly without creating a new image, you can store the files directly inside the database, in a table that has the following structure: 

CREATE TABLE sqlpage_files(
  path VARCHAR(255) NOT NULL PRIMARY KEY,
  contents BLOB,
  last_modified TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

Make sure to update last_modified every time you update the contents of a file (or do it inside a TRIGGER). SQLPage will re-parse a file from the database only when it has been modified.

Technologies and libraries used

Frequently asked questions

Why would I want to write SQL instead of a real programming language? SQL is not even Turing-complete!

Just Because You Can Doesn’t Mean You Should...

— someone being mean on reddit

Life's too short to always play it safe. Where's the fun in should? I think SQLPage has some real value to offer, despite its unconventional approach ! SQLPage isn't intended to replace traditional web development frameworks or discourage their usage. Instead, it caters to a specific group of people who want to leverage their SQL skills to rapidly build web applications, without spending months learning all of the technologies involved in traditional web development, and then weeks using them to build a simple CRUD application.

Is this the same as Microsoft Access?

The goal is the same: make it easy to create simple data-centric applications. But the tools are very different:

Is the name a reference to Microsoft Frontpage ?

Frontpage was a visual static website building software popular in the late 90s. I had never heard of it before someone asked me this question.

I like CSS, I want to design websites, not write SQL.

Are you human ? Human beings hate CSS.

The take of SQLPage is that you should not spend time designing the border radius of your buttons until you have a working prototype. We provide a set of components that look decent out of the box, so that you can focus on your data model instead.

However, if you really want to write your own HTML and CSS, you can do it by creating your own components. Just create a .handlebars file in sqlpage/templates and write your HTML and CSS in it. (example)