https://github.com/frectonz/sql-studio

SQL Database Explorer [SQLite, libSQL, PostgreSQL, MySQL/MariaDB, DuckDB, ClickHouse]
https://github.com/frectonz/sql-studio

duckdb libsql mariadb mysql postgresql rust sqlite sqlite-browser

Last synced: 3 days ago
JSON representation

SQL Database Explorer [SQLite, libSQL, PostgreSQL, MySQL/MariaDB, DuckDB, ClickHouse]

• Host: GitHub
• URL: https://github.com/frectonz/sql-studio
• Owner: frectonz
• License: mit
• Created: 2024-06-11T18:32:36.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-05T17:38:06.000Z (2 months ago)
• Last Synced: 2025-01-02T03:02:51.407Z (10 days ago)
• Topics: duckdb, libsql, mariadb, mysql, postgresql, rust, sqlite, sqlite-browser
• Language: Rust
• Homepage: https://sql-studio.onrender.com/
• Size: 2.91 MB
• Stars: 2,488
• Watchers: 11
• Forks: 65
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-list - sql-studio
• awesome-clickhouse - frectonz/sql-studio - SQL Studio is a single command SQL database explorer that supports multiple databases including SQLite, PostgreSQL, and ClickHouse. (Integrations / Deployment and Management Tools)

README

        
![banner](./logo_banner.jpg)

# SQL Studio

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

### Local SQLite DB File

```bash

sql-studio sqlite [sqlite_db]

```

### Remote libSQL Server

```bash

sql-studio libsql [url] [auth_token]

```

### Local SQLite DB with libSQL driver

```bash

sql-studio local-libsql [database]

```

### PostgreSQL Server

```bash

sql-studio postgres [url]

```

### MySQL/MariaDB Server

```bash

sql-studio mysql [url]

```

### Local DuckDB File

```bash

sql-studio duckdb [duckdb_file]

```

### ClickHouse Server (Partial Support)

```bash

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](https://github.com/frectonz/sql-studio/releases).

## Screenshots

### Overview Page

![overview](./screenshots/overview.png)

![overview dark](./screenshots/overview-dark.png)

### Tables Page

![tables](./screenshots/tables.png)

![tables dark](./screenshots/tables-dark.png)

### Query Page

![query](./screenshots/query.png)

![query dark](./screenshots/query-dark.png)

## Installation

### Install prebuilt binaries via shell script (MacOS and Linux)

```bash

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

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

```

### Updating

```bash

sql-studio-update

```

## Nix

```bash

nix shell nixpkgs#sql-studio

```

## Docker

A Docker image of SQL Studio is available on [Docker Hub](https://hub.docker.com/r/frectonz/sql-studio). The following is an example of how to run SQL Studio with the Postgres driver on port `3030`.

```bash

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.

```bash

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

```