Home
Softono
sql-studio

sql-studio

Open source MIT Rust
Website GitHub
3.5K
Stars
123
Forks
1
Issues
17
Watchers
3 months
Last Commit
DB Admin & GUI Clients Database

About sql-studio

SQL Studio is a single binary, single command SQL database explorer that supports SQLite, libSQL, PostgreSQL, MySQL, MariaDB, DuckDB, ClickHouse, Microsoft SQL Server, Parquet, and CSV files. It can be launched with simple commands such as "sql-studio sqlite [file]" for local databases, "sql-studio postgres [url]" for remote servers, or similar syntax for other supported data sources. The web-based interface provides an overview page with common database metadata, a tables page showing each table's metadata, a queries page for executing custom SQL, and an infinite scroll rows view for browsing large result sets. Rich SQL IntelliSense assists with writing queries. SQL Studio is distributed as prebuilt binaries for macOS and Linux via shell script and for Windows via PowerShell, and it is also available through Nix and Docker, making deployment straightforward across environments.

Platforms

Web Self-hosted

Languages

Rust

Links

Website Source Code
f
Published by
frectonz
Visit View Profile

README.md

View on GitHub

banner

SQL Studio

Single binary, single command SQL database explorer. SQL studio supports SQLite, libSQL, PostgreSQL, MySQL, DuckDB, ClickHouse, Microsoft SQL Server, Parquet and CSV.

Documentation

Local SQLite DB File

sql-studio sqlite [sqlite_db]

Remote libSQL Server

sql-studio libsql [url] [auth_token]

Local SQLite DB with libSQL driver

sql-studio local-libsql [database]

PostgreSQL Server

sql-studio postgres [url]

MySQL/MariaDB Server

sql-studio mysql [url]

Local DuckDB File

sql-studio duckdb [duckdb_file]

Local Parquet File

sql-studio parquet [parquet_file]

Local CSV File

sql-studio csv [csv_file]

ClickHouse Server (Partial Support)

sql-studio clickhouse [URL] [USER] [PASSWORD] [DATABASE]

Microsoft SQL Server

sql-studio mssql [connection]

Features

  • Overview page with common metadata.
  • Tables page with each table's metadata.
  • Queries page with more access to your db.
  • Infinite scroll rows view.
  • Rich SQL IntelliSense for custom queries.

More features available on the releases page.

Screenshots

Overview Page

schema dark

Tables Page

query dark

Query Page

table dark

Schema Page

overview dark

Installation

Install prebuilt binaries via shell script (MacOS and Linux)

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/frectonz/sql-studio/releases/download/0.1.51/sql-studio-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -ExecutionPolicy Bypass -c "irm https://github.com/frectonz/sql-studio/releases/download/0.1.51/sql-studio-installer.ps1 | iex"

Updating

sql-studio-update

Nix

nix shell nixpkgs#sql-studio

Docker

A Docker image of SQL Studio is available on Docker Hub. The following is an example of how to run SQL Studio with the Postgres driver on port 3030.

docker run -p 3030:3030 frectonz/sql-studio /bin/sql-studio \
  --no-browser \
  --no-shutdown \
  --address=0.0.0.0:3030 \
  postgres \
  postgres://localhost:5432/

Contributing

Before executing cargo run you need to build the UI because the rust app statically embedded the UI files in the binary.

git clone [email protected]:frectonz/sql-studio.git
cd sql-studio
nix develop # if you use nix
cd ui
npm install
npm run build
cd ..
cargo run