File tree 1 file changed +9
-2
lines changed
1 file changed +9
-2
lines changed Original file line number Diff line number Diff line change @@ -6,11 +6,11 @@ sql-schema
6
6
[ ![ Crates.io Version] ( https://img.shields.io/crates/v/sql-schema )] ( https://crates.io/crates/sql-schema )
7
7
[ ![ docs.rs] ( https://img.shields.io/docsrs/sql-schema )] ( https://docs.rs/sql-schema )
8
8
9
- This crate provides tools for generating schema migrations based on edits to a canonical schema file.
9
+ This crate provides a command line tool for generating schema migrations based on edits to a canonical schema file.
10
10
11
11
## Status
12
12
13
- This crate is in a very early stage of development and is missing many features .
13
+ 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 .
14
14
15
15
## Usage
16
16
@@ -33,6 +33,13 @@ sql-schema migration --name my_new_migration \
33
33
# -> writing schema/migrations/1739486729_my_new_migration.down.sql
34
34
```
35
35
36
+ ## Goals
37
+
38
+ - Time saver: You can generate an up _ and_ down migration for the cost of editing a schema.
39
+ - Non restrictive: You can edit the generated migrations as needed (e.g. if you need to migrate data along side a schema change).
40
+ - 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).
41
+ - Works with any SQL dialect.
42
+
36
43
## Licensing
37
44
38
45
All code in this repository is licensed under the [ Apache Software License 2.0] ( LICENSE.txt ) .
You can’t perform that action at this time.
0 commit comments