Skip to content

Latest commit

 

History

History
128 lines (87 loc) · 2.47 KB

README.md

File metadata and controls

128 lines (87 loc) · 2.47 KB
Raw

banner

SQL Studio

Single binary, single command SQL database explorer. SQL studio supports SQLite, libSQL, PostgreSQL, MySQL and DuckDB.

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]

ClickHouse Server (Partial Support)

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

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

overview overview dark

Tables Page

tables tables dark

Query Page

query query 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.32/sql-studio-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -c "irm https://github.com/frectonz/sql-studio/releases/download/0.1.26/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