# sql-studio

**Repository Path**: dongtianwk/sql-studio

## Basic Information

- **Project Name**: sql-studio
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-05
- **Last Updated**: 2024-07-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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]
```

### PostgreSQL Server

```bash
sql-studio postgres [url]
```

### MySQL/MariaDB Server

```bash
sql-studio mysql [url]
```

### Local DuckDB File

```bash
sql-studio duckdb [duckdb_file]
```

## Features

- Overview page with common metadata.
- Tables page with each table's metadata, including the disk size being used by each table.
- Infinite scroll rows view.
- A custom query page that gives you more access to your db.

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.19/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.19/sql-studio-installer.ps1 | iex"
```

### Updating

```bash
sql-studio-update
```

## Nix

```bash
nix shell github:frectonz/sql-studio
```

## 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 git@github.com:frectonz/sql-studio.git
cd sql-studio
nix develop # if you use nix
cd ui
npm install
npm run build
cd ..
cargo run
```