https://github.com/gigagrug/schema
All in one CLI tool for the database | Migration, Studio, LSP
https://github.com/gigagrug/schema
bubbletea cli database-migrations database-schema lsp lsp-server mariadb mysql postgres sql sqlite studio tui turso
Last synced: 4 days ago
JSON representation
All in one CLI tool for the database | Migration, Studio, LSP
- Host: GitHub
- URL: https://github.com/gigagrug/schema
- Owner: gigagrug
- License: apache-2.0
- Created: 2025-04-07T00:12:55.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-12-25T00:18:17.000Z (about 1 month ago)
- Last Synced: 2026-01-19T22:55:35.886Z (6 days ago)
- Topics: bubbletea, cli, database-migrations, database-schema, lsp, lsp-server, mariadb, mysql, postgres, sql, sqlite, studio, tui, turso
- Language: Go
- Homepage: https://schema.gigagrug.com
- Size: 19.6 MB
- Stars: 212
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Schema
All in one CLI tool for the database | SQLite, libSQL, Turso, PostgreSQL, MySQL, MariaDB
## Installation
Install/upgrade latest version
```shell
curl -sSfL https://raw.githubusercontent.com/gigagrug/schema/main/install.sh | sh -s
```
Install specific version
```shell
curl -sSfL https://raw.githubusercontent.com/gigagrug/schema/main/install.sh | sh -s 0.1.0
```
## Get Started
### Step 1
Init project (default: db=sqlite url=./schema/dev.db)
```shell
schema i
```
Init project using another db and url
```shell
schema i -db "postgres" -url "postgresql://postgres:postgres@localhost:5432/postgres"
```
Init project with different root directory
```shell
schema i -rdir "schema2"
```
### Step 2
Nessesary if using existing database
```shell
schema pull
```
## Migrations
### Step 1
Create a SQL file
```shell
schema create "initschema"
```
### Step 2
Go to ./schema/migrations/1_initschema.sql (This SQL is for sqlite)
```sql
CREATE TABLE IF NOT EXISTS users (
id INTEGER PRIMARY KEY AUTOINCREMENT,
username TEXT NOT NULL UNIQUE,
email TEXT NOT NULL UNIQUE,
password TEXT NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE IF NOT EXISTS posts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id INTEGER REFERENCES users(id) ON DELETE CASCADE,
title TEXT NOT NULL,
content TEXT NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
-- schema rollback
DROP TABLE users;
DROP TABLE posts;
```
### Step 3
Migrates all the sql files not migrated
```shell
schema migrate
```
Migrates specific sql file
```shell
schema migrate "1_initschema"
```
## Rollback
Rollbacks last migrated file
```shell
schema rollback
```
```shell
schema rollback "1_initschema"
```
## Remove
Removes if file not migrated
```shell
schema remove "1_initschema"
```
## Insert Dummy Data
### Step 1
Doesn't save in _schema_migrations table if not in migrations dir so they can be reused
```shell
schema create "insertdata" -dir "inserts"
```
### Step 2
Insert based on the SQL schema above.
```sql
WITH RECURSIVE generate_users AS (
SELECT ABS(RANDOM() % 10000) AS random_number, 1 AS row_number
UNION ALL
SELECT ABS(RANDOM() % 10000), row_number + 1
FROM generate_users
WHERE row_number < 5
)
INSERT INTO users (username, email, password)
SELECT
'user_' || random_number,
'user_' || random_number || '@example.com',
'password'
FROM generate_users;
WITH RECURSIVE user_list AS (
SELECT id, ROW_NUMBER() OVER () AS rn
FROM users
ORDER BY RANDOM()
LIMIT 5
),
post_insert AS (
SELECT
'Post #' || ABS(RANDOM() % 10000) AS title,
'This is a post about random topic #' || ABS(RANDOM() % 10000) AS content,
id AS user_id
FROM user_list
)
INSERT INTO posts (user_id, title, content)
SELECT user_id, title, content FROM post_insert;
```
### Step 3
```shell
schema sql "0_insertdata.sql" -dir "inserts"
```
## Select query and prints table in console
```shell
schema sql "SELECT * FROM users;"
```
## TUI SQL Studio
```shell
schema studio
```
## LSP
```shell
schema lsp
```
## Headless
If you don't want to use .env and schema.db
Example:
```shell
schema studio -db "sqlite" -url "./schema/dev.db"
```
## Subcommands
`version`, `v`: Shows current and latest version
`init`, `i`: Initializes project
`pull`: Pulls database schema
`migrate`: Migrates pending migrations
`rollback`: Rollbacks last migration
`studio`: Launch SQL TUI Studio
`lsp`: Connect to your editor
`rollback "[filename]"` Rollback a specific migration
`migrate "[filename under migrations/]"` Run a specific migration
`sql "[filename or sql query]"` Run SQL directly or from a file
`create "[filename]"`: Create a new migration file
`remove "[filename]"`, `rm`: Remove an unmigrated file from disk and db
`config`: Edit config files for db type and db url
## Flags
`db="[db type]"` (default sqlite)
`url="[db url]"` (default ./schema/dev.db)
`dir="[dir under rdir]"` (default migration)
`rdir="[root directory]"` (default schema)