Data modeling is a journey - manage yours with jrny
Important: Journey is still very much a prototype; being version >= 1 simply means that it reached minimum required (and working) features, and development continues to be sporadic due to the responsibilities of life.
In other words: USE WITH DISCRETION
Other SQL-based schema migration tools already exist (like dbmate), but there is still room for another.
jrny is an option for people who...
... think database revision files should be an immutable record and are guaranteed to represent what was applied to database
... want a guaranteed revision order across all environments
... would rather write SQL than translate it to method calls or YAML entries that are often more verbose and less documented
... want explicit control of transactions and the ability to easily ignore them or leverage them across multiple revisions
... prefer to install compiled binaries rather than manage a language and dependencies on whatever system(s) run migrations
... like the idea of single responsibility, especially if multiple applications (potentially in different repos and written in different languages) access the same tables
... believe that separating migrations from application deploys encourages one to write non-breaking migrations and helps enable zero-downtime updates
... prefer to avoid reverse migrations, especially as they make it trivially easy to 'change' history by forgetting to add a preexisting index, check constraint, etc. during a typical upgrade/downgrade/edit/upgrade cycle. (Feel free to add your thoughts on this subject here)
jrny is primarily intended to be used as a precompiled, standalone CLI tool,
but it can also be used as a library.
Assuming cargo is installed (easiest is using rustup) then simply run:
```bash $ cargo install jrny --version 2.0.0-beta.7
Updating crates.io index
Downloaded jrny v2.0.0-beta.7
Downloaded 1 crate (28.6 KB) in 0.39s
Installing jrny v2.0.0-beta.7
...
...
...
Compiling jrny v2.0.0-beta.7
Finished release [optimized] target(s) in 2m 03s
Installing /Users/jrny v2.0.0-beta.7 (executable jrny)
```
There are 4 steps to managing schema changes with jrny:
beginplanreviewembarkProject setup is simple - all that is required is a config file and an empty revisions directory alongside it.
These can be created manually or via jrny begin.
```bash
$ jrny begin
A journey has begun
```
The default jrny.toml file specifies the directory in which to
locate revisions as well as the database schema & name for the
"state table" in which to record details for applied revisions.
```toml
[revisions] directory = "revisions"
[table] schema = "public" name = "jrny_revision" ```
The revision directory can be renamed any time, provided that the SQL
files themselves do not change,
but the schena & table cannot be changed once any revisions have been applied.
Otherwise, jrny will see an empty state table and attempt to
apply all revisions again.
Additionally, jrny-env.toml and jrny-env.example.toml files will be created.
The jrny-env.toml environment file is optional but is used to store
environment-specific information, including the database connection string.
```toml
[database]
url = "postgresql://user:password@host:port/dbname" ```
Both the config and environment files can be freely renamed,
but changing their names (or running jrny outside of the
project directory) will require passing in their paths via
-c [or --config] and -e [or --environment] respectively.
To create a new SQL revision, run jrny plan [-c <path-to-config>] either specifying the path to the
config file via -c or (if ommitted) by looking for jrny.toml in the current directory.
```bash $ jrny plan create-users
Created revisions/001.1606743300.create-users.sql
$ jrny plan 'name with spaces' -c /path/to/my/config.toml
Created /path/to/my/revisions/002.1606743400.name with spaces.sql ```
This will create a (mostly) empty SQL file for you to populate with wonderful statements.
Notice that jrny encourages transactions per-revision but you are free to remove these,
particularly if you need to execute statements outside of a transaction - or if you want to write several revision files that should
span the same transaction.
``` bash $ cat /path/to/my/revisions/002.1606743400.name\ with\ spaces.sql
-- Add description here
begin;
-- Add SQL here
commit; ```
Note: It's encouraged to comment-out the
commit;line so that you can run the revision in the database without changes actually persisting.
Revision filenames follow the pattern of [id].[timestamp].[name].sql.
Timestamps are just great metadata to capture, and jrny assigns a sequential id to each file.
The reason being this enforces a stricter revision order than simply using timestamps can,
all without needing pointers between files.
(For more information, see the rational behind sequencing.)
Gaps in the id sequence are fine (eg. if you create two new revisions, remove the first one, and then apply the second), and ids can be manually changed as long as the revision hasn't been applied.
To summarize the state of revisions, run jrny review.
If you are outside of the project directory, you'll need to
specify the config file location, and
you will either need to specify the path to the environment
file or provide the database URL directly, eg:
```bash
$ jrny review
#
jrny-env.toml in$ jrny review -c path/to/my-jrny-config.toml
$ jrny review -c path/to/my-jrny-config.toml -e path/to/my-jrny-env.toml
#
$ jrny review -d 'postgresql://user:password@host:5432/dbname' ```
This will list all ordered revisions, each with time of creation as well as time of application, if applied to the specified database.
```bash $ jrny review
The journey thus far
Id Revision Created Applied 1 my first revision 13-Apr-2021 23:18:18 15-Apr-2021 22:19:07 2 another-change 14-Apr-2021 21:22:43 15-Apr-2021 22:19:07 3 yet-another-change 14-Apr-2021 21:42:34 -- ```
Additionally, jrny performs several checks during review to guarantee that...
If any revision files that have been applied are removed, review will fail with...
```bash $ jrny review
The journey thus far
Id Revision Created Applied 1 my first revision 13-Apr-2021 23:18:18 13-Apr-2021 23:29:37 2 another-change 14-Apr-2021 21:42:34 14-Apr-2021 22:32:35 No corresponding file could not be found ```
Guaranteeing that revision files are still all present isn't useful without an additional guarantee that they haven't changed since being applied.
```bash $ jrny review
The journey thus far
Id Revision Created Applied 1 my first revision 13-Apr-2021 23:18:18 15-Apr-2021 22:22:23 2 another-change 14-Apr-2021 21:22:43 15-Apr-2021 22:22:23 The file has changed after being applied ```
Note: This will fail with even the addition of whitespace or comments; there is currently no attempt to scrub those out prior to generating the checksums.
Self-explanatory; an id isn't much of an id if it isn't unique. This is performed prior to applying to database, so that if there are 3 revisions to run and 1 has a duplicate id, no revisions will be attempted.
```bash $ jrny review
The journey thus far
Id Revision Created Applied 1 my first revision 13-Apr-2021 23:18:18 -- 1 another-change 14-Apr-2021 21:42:34 -- Revision has duplicate id ```
```bash The journey thus far
Id Revision Created Applied 1 my first revision 13-Apr-2021 23:18:18 13-Apr-2021 23:29:37 2 another-change 14-Apr-2021 21:42:34 -- Later revisions have already been applied 3 yet-another-change 14-Apr-2021 21:22:43 14-Apr-2021 21:37:17 ```
To apply pending revisions, run jrny embark.
As with jrny review, applying revisions looks for default config & environment files in the current directory,
but either can be overridden and, again, the database URL can be supplied directly.
Revisions will be reviewed prior to applying any pending, and if files have changed, are no longer
present on disk, etc., then jrny will issue an error and exit without applying any new revisions.
For instance, combining the examples of failed review above, you might see any or all of the following when attempting to embark.
```bash $ jrny embark
Error: Failed to run revisions: 1 changed since being applied 1 pending occur before applied revisions 1 no longer present on disk 1 has a duplicate id ```
If the files were restored, changes rejrny would move forward with applying 1606749809.so many things.sql and you would instead see...
If the errors were resolved...
... then you would see successful revision application.
```bash $ jrny embark
Applying 4 revision(s)
001.1618370298.my first revision.sql 003.1618449763.another-change.sql 004.1618450954.YET-another-change.sql 005.1618370304.my first revision.sql ```
Attempting to apply revisions again would simply find none available.
```bash $ jrny embark
No revisions to apply ```
The jrny CLI tool is a thin wrapper around several structs and functions that can
alternatively be imported into a Rust application, if one wants to manage revisions
more programmatically.
The library functions make no assumptions about configuration and environment, however; you must explicitly create those objects as necessary, which is admittedly not very ergonomic at the moment.
For a complete (basic) example:
```rust use std::env; use std::path::PathBuf;
use jrny::context as ctx;
fn main() {
// Initialize a new jrny setup in the ./jrny-test subdirectory.
//
// Note: In addition to creating the necessary revisions directory, this also
// creates the jrny.toml, etc files that, when using jrny as a library,
// are entirely unnecessary.
//
// See: https://github.com/kevlarr/jrny/issues/35
jrny::begin(&PathBuf::from("jrny-test")).unwrap();
// The rest of the commands will need to know the project configuration
// and potentially other environment details as well.
let cfg = ctx::Config {
revisions: ctx::RevisionsSettings {
directory: PathBuf::from("jrny-test/revisions"),
},
table: ctx::TableSettings {
schema: "public".to_owned(),
name: "jrny_revision".to_owned(),
},
};
let env = ctx::Environment::from_database_url(&env::var("DATABASE_URL").unwrap());
// Create a new empty migration
jrny::plan(&cfg, "my first migration", None).unwrap();
// Create another migration with some contents
jrny::plan(&cfg, "a more useful migration", Some("
create table my_cool_table (
id bigint
primary key
generated always as identity
)
")).unwrap();
// Review the migrations
//
// This SHOULD return an error if any revisions fail review but currently does not.
// See: https://github.com/kevlarr/jrny/issues/31
jrny::review(&cfg, &env).unwrap();
// Run the migrations
jrny::embark(&cfg, &env).unwrap();
} ```
Refactoring in Rust is fun - which is good, because there's a lot of room in this project for clearer patterns and modules, better code, etc.
Revisions are great, but we don't normally need revisions from 2 years ago sitting in the directory cluttering up the screen.
This could take several forms but could possible involve concatenating all files into a single 'base' revision and resetting the revision table to mark that base as applied.
Sometimes revisions are logically-related (ie. when developing a given feature) and it could make sense to group them together in a folder, just to help keep the files a little easier to browse.
No description necessary; there's barely any test coverage, and there's hardly any CI.