Skip to content
This repository was archived by the owner on Aug 23, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# SQLPad

[![Build Status](https://travis-ci.org/rickbergfalk/sqlpad.svg?branch=master)](https://travis-ci.org/rickbergfalk/sqlpad)
A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, ClickHouse, Crate, Vertica, Presto, SAP HANA, Cassandra, Snowflake, Google BigQuery, SQLite, and many more via [ODBC](https://github.com/rickbergfalk/sqlpad/wiki/ODBC).

A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, Crate, Vertica, Presto, SAP HANA, Cassandra, Snowflake, Google BigQuery, SQLite, and many more via [ODBC](https://github.com/rickbergfalk/sqlpad/wiki/ODBC).

![SQLPad Query Editor](https://rickbergfalk.github.io/sqlpad/images/screenshots/v3-beta.png)
![SQLPad Query Editor](https://rickbergfalk.github.io/sqlpad/images/screenshots/v5.1.0.png)

## Docker Image

Expand Down
7 changes: 5 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SQLPad

A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, Crate, Vertica, Presto, SAP HANA, Snowflake, BigQuery, SQLite, and many others via ODBC.
A web app for writing and running SQL queries and visualizing the results. Supports Postgres, MySQL, SQL Server, ClickHouse, Crate, Vertica, Presto, SAP HANA, Snowflake, BigQuery, SQLite, and many others via ODBC.

![SQLPad](images/screenshots/v3-beta.png)
<img class="screenshot" src="images/screenshots/v5.1.0.png" data-origin="images/screenshots/v5.1.0.png" alt="SQLPad screenshot" >

## Database Support

Expand All @@ -22,6 +22,9 @@ A web app for writing and running SQL queries and visualizing the results. Suppo
<div class="db-container">
<img src="images/logo-crate.svg" data-origin="images/logo-crate.svg" alt="Crate" >
</div>
<div class="db-container">
<img src="images/logo-clickhouse.png" data-origin="images/logo-clickhouse.png" alt="ClickHouse" >
</div>
<div class="db-container db-container-bg">
<img src="images/logo-presto.png" data-origin="images/logo-presto.png" alt="Presto" >
</div>
Expand Down
16 changes: 16 additions & 0 deletions docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,19 @@ LDAP-based authentication can be enabled and used with local authencation togeth
## Allowed Domains for User Administration

An entire domain can be allowed for username administration by setting enviornment variable `SQLPAD_ALLOWED_DOMAINS`. This may be particularly useful in combination with OAuth.

## Service Token

The REST API may be called using generated service tokens scoped by role and some optional amount of time.

To enable the creation of service tokens, a token secret must be supplied via `SQLPAD_SERVICE_TOKEN_SECRET`.

To generate a service token, log into SQLPad as an `admin` user and click `Service Tokens`. A service token can be scoped to a certain role (admin or editor) and limited to a window of time.

The generated Bearer token may be used by passing it via the Authorization header:

```sh
curl -X GET -H 'Accept: application/json' -H "Authorization: Bearer the.generated.token" http://localhost:3010/sqlpad/api/users
```

For more information on APIs available see [API Overview](/api-overview).
12 changes: 11 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,17 @@ Default role to assign user created when `samlAutoSignUp` is turned on. Accepted

## serviceTokenSecret

Secret to sign the generated Service Tokens
Secret to sign the generated Service Tokens.

To generate a service token, log into SQLPad as an `admin` user and click `Service Tokens`. A service token can be scoped to a certain role (admin or editor) and limited to a window of time.

The generated Bearer token may be used by passing it via the Authorization header:

```sh
curl -X GET -H 'Accept: application/json' -H "Authorization: Bearer the.generated.token" http://localhost:3010/sqlpad/api/users
```

For more information on APIs available see [API Overview](/api-overview).

- Key: `serviceTokenSecret`
- Env: `SQLPAD_SERVICE_TOKEN_SECRET`
Expand Down
2 changes: 2 additions & 0 deletions docs/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Work is under way to add multi-statement transaction support to drivers that ben

?> As of 3.2.0 connections may be defined via application configuration.

?> JSON & INI config files deprecated as of 5.1.0

### Via Environment Variable & .env File

When defining connections via environment variables, connection field values must be provided using an environment variable with the convention `SQLPAD_CONNECTIONS__<connectionId>__<fieldName>`. Note double underscores between `SQLPAD_CONNECTIONS`, `<connectionId>`, and `<fieldName>`.
Expand Down
Binary file added docs/images/logo-clickhouse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/screenshots/v5.1.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/styles/docs.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.screenshot {
box-shadow: 3px 3px 12px rgba(0, 0, 0, 0.4);
}

.db-images {
display: flex;
flex-wrap: wrap;
Expand Down