sql-schema 0.5.0

Declarative SQL schema migrations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

sql-schema
==========

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Build Status](https://github.com/jvatic/sql-schema/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/jvatic/sql-schema/actions?query=workflow%3ARust+branch%3Amain)
[![Crates.io Version](https://img.shields.io/crates/v/sql-schema)](https://crates.io/crates/sql-schema)
[![docs.rs](https://img.shields.io/docsrs/sql-schema)](https://docs.rs/sql-schema)

This crate provides a command line tool for generating schema migrations based on edits to a canonical schema file.

## Status

This crate is in an early stage of development and may not work with your schema or have unexpected behaviour—always double check the output.

## Usage

```sh
# install the cli
cargo install sql-schema

# generate a schema file from existing migrations
sql-schema schema \
    --schema-path ./schema/schema.sql \ # this is the default value
    --migrations-dir ./schema/migrations # this is the default value
# -> writing ./schema/schema.sql

# generate a migration after editing the schema file
sql-schema migration \
    --name my_new_migration \ # default is "generated_migration"
    --include-down true \ # default is true if any down migration exists OR if there aren't any
    --schema-path ./schema/schema.sql \ # this is the default value
    --migrations-dir ./schema/migrations # this is the default value
# -> writing schema/migrations/1739486729_my_new_migration.up.sql
# -> writing schema/migrations/1739486729_my_new_migration.down.sql
```

## Goals

- Time saver: You can generate an up _and_ down migration for the cost of editing a schema.
- Non restrictive: You can edit the generated migrations as needed (e.g. if you need to migrate data along side a schema change).
- Minimal buy-in: You don't have to change anything about your project to start or stop using it (committing the generated schema is optional).
- Works with any SQL dialect.
- Plays nicely with other tools such as [sqlc](https://github.com/sqlc-dev/sqlc) and [sqlx](https://github.com/launchbadge/sqlx).

## Assumptions

- You have a dir containing migrations written in SQL using the `.sql` file extension.
- The sum of all the migrations is your full database schema.
- The migration file names are sortable and follow a supported naming convention.

## Licensing

All code in this repository is licensed under the [Apache Software License 2.0](LICENSE.txt).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.