#postgresql #migration #sql #schema #declarative #alter #ast

bin+lib declare_schema

CLI / Library for Postgres schema migrations

9 releases

0.0.9 Oct 28, 2024
0.0.8 Oct 28, 2024
0.0.4 Aug 3, 2024
0.0.1 Jul 9, 2024

#1569 in Database interfaces

Download history 290/week @ 2024-07-30 215/week @ 2024-08-06 165/week @ 2024-08-13 96/week @ 2024-08-20 44/week @ 2024-08-27 33/week @ 2024-09-03 36/week @ 2024-09-10 335/week @ 2024-09-17 211/week @ 2024-09-24 398/week @ 2024-10-01 130/week @ 2024-10-08 279/week @ 2024-10-15 815/week @ 2024-10-22 348/week @ 2024-10-29 188/week @ 2024-11-05 179/week @ 2024-11-12

1,539 downloads per month

Apache-2.0

65KB
1.5K SLoC

declare-schema

Experiments with Rust declarative schemas

Use sqlparser-rs for SQL -> AST, then diff ASTs to generate ALTER ASTs, then output SQL.

WARNING: Alpha software, you will likely lose data with this library.

Goal

In application

Include database schema management in to Rust applications without the need for migration steps.

As a CLI

Provide a CLI tool that can generate diffs of schemas and the required ALTER statements for review to detect schema drift.

Easy development experience

When embedded in an application or with a CLI tool keep an easy SQL -> DB flow that is clear to developers with an easy to modify schema.

Current State

Limitations

CREATE EXTENSION - Can be created by name only. Cannot be DROPed.

CONSTRAINT - Cannot be changed, create a new one then drop the old one.

CREATE INDEX - Indexes cannot be ALTERed. To avoid errors in change detection/halting

  • Specify the schema name for the table when creating the index
  • Specify the method for USING that matches defaults:

example: CREATE INDEX idx_id on public.test USING BTREE (id DESC)

Dependencies

~19–31MB
~494K SLoC