@@ -2,54 +2,54 @@
22
33[](https://github.com/fabianlindfors/reshape/actions/workflows/test.yaml) [](https://github.com/fabianlindfors/reshape/releases)
44
5−> Also check out [ReshapeDB](https://reshapedb.com), a new database built from the ground up to make zero-downtime schema and data migrations as simple and safe as possible. If you'd like to chat about it, please [reach out](contact@reshapedb.com)!
6−
75Reshape is an easy-to-use, zero-downtime schema migration tool for Postgres. It automatically handles complex migrations that would normally require downtime or manual multi-step changes. During a migration, Reshape ensures both the old and new schema are available at the same time, allowing you to gradually roll out your application. It will also perform all changes without excessive locking, avoiding downtime caused by blocking other queries. For a more thorough introduction to Reshape, check out the [introductory blog post](https://fabianlindfors.se/blog/schema-migrations-in-postgres-using-reshape/).
86
97Designed for Postgres 12 and later.
108
9+*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) break your application.*
10+
1111- [How it works](#how-it-works)
1212- [Getting started](#getting-started)
13− - [Installation](#installation)
14− - [Creating your first migration](#creating-your-first-migration)
15− - [Preparing your application](#preparing-your-application)
16− - [Running your migration](#running-your-migration)
17− - [Using during development](#using-during-development)
13+ - [Installation](#installation)
14+ - [Creating your first migration](#creating-your-first-migration)
15+ - [Preparing your application](#preparing-your-application)
16+ - [Running your migration](#running-your-migration)
17+ - [Using during development](#using-during-development)
1818- [Writing migrations](#writing-migrations)
19− - [Basics](#basics)
20− - [Tables](#tables)
21− - [Create table](#create-table)
22− - [Rename table](#rename-table)
23− - [Remove table](#remove-table)
24− - [Add foreign key](#add-foreign-key)
25− - [Remove foreign key](#remove-foreign-key)
26− - [Columns](#columns)
27− - [Add column](#add-column)
28− - [Alter column](#alter-column)
29− - [Remove column](#remove-column)
30− - [Indices](#indices)
31− - [Add index](#add-index)
32− - [Remove index](#remove-index)
33− - [Enums](#enums)
34− - [Create enum](#create-enum)
35− - [Remove enum](#remove-enum)
36− - [Custom](#custom)
37− - [Complex changes across tables](#complex-changes-across-tables)
19+ - [Basics](#basics)
20+ - [Tables](#tables)
21+ - [Create table](#create-table)
22+ - [Rename table](#rename-table)
23+ - [Remove table](#remove-table)
24+ - [Add foreign key](#add-foreign-key)
25+ - [Remove foreign key](#remove-foreign-key)
26+ - [Columns](#columns)
27+ - [Add column](#add-column)
28+ - [Alter column](#alter-column)
29+ - [Remove column](#remove-column)
30+ - [Indices](#indices)
31+ - [Add index](#add-index)
32+ - [Remove index](#remove-index)
33+ - [Enums](#enums)
34+ - [Create enum](#create-enum)
35+ - [Remove enum](#remove-enum)
36+ - [Custom](#custom)
3837- [Commands and options](#commands-and-options)
39− - [`reshape migration start`](#reshape-migration-start)
40− - [`reshape migration complete`](#reshape-migration-complete)
41− - [`reshape migration abort`](#reshape-migration-abort)
42− - [`reshape schema-query`](#reshape-schema-query)
43− - [Connection options](#connection-options)
38+ - [`reshape migration start`](#reshape-migration-start)
39+ - [`reshape migration complete`](#reshape-migration-complete)
40+ - [`reshape migration abort`](#reshape-migration-abort)
41+ - [`reshape schema-query`](#reshape-schema-query)
42+ - [Connection options](#connection-options)
4443- [License](#license)
4544
45+
4646## How it works
4747
4848Reshape works by creating views that encapsulate the underlying tables, which your application will interact with. During a migration, Reshape will automatically create a new set of views and set up triggers to translate inserts and updates between the old and new schema. This means that every deployment is a three-phase process:
4949
50501. **Start migration** (`reshape migration start`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
51512. **Roll out application**: Your application can be gradually rolled out without downtime. The existing deployment will continue using the old schema whilst the new deployment uses the new schema.
52−3. **Complete migration** (`reshape migration complete`): Removes the old schema and any intermediate data and triggers.
52+3. **Complete migration** (`reshape migration complete`): Removes the old schema and any intermediate data and triggers.
5353
5454If the application deployment fails, you should run `reshape migration abort` which will roll back any changes made by `reshape migration start` without losing data.
5555
@@ -71,7 +71,7 @@ cargo install reshape
7171
7272#### Docker
7373
74−Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
74+Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
7575
7676```shell
7777docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migration start
@@ -167,9 +167,9 @@ Every action has a `type`. The supported types are detailed below.
167167
168168#### Create table
169169
170−The `create_table` action will create a new table with the specified columns, indices and constraints. You can optionally provide an `up` option to backfill values from an existing table.
170+The `create_table` action will create a new table with the specified columns, indices and constraints.
171171
172−_Example: create a `customers` table with a few columns and a primary key_
172+*Example: create a `customers` table with a few columns and a primary key*
173173
174174```toml
175175[[actions]]
@@ -187,13 +187,13 @@ primary_key = ["id"]
187187 type = "TEXT"
188188
189189 # Columns default to nullable
190− nullable = false
190+ nullable = false
191191
192192 # default can be any valid SQL value, in this case a string literal
193− default = "'PLACEHOLDER'"
193+ default = "'PLACEHOLDER'"
194194```
195195
196−_Example: create `users` and `items` tables with a foreign key between them_
196+*Example: create `users` and `items` tables with a foreign key between them*
197197
198198```toml
199199[[actions]]
@@ -226,34 +226,11 @@ primary_key = ["id"]
226226 referenced_columns = ["id"]
227227```
228228
229−_Example: create `profiles` table based on existing `users` table_
230−
231−```toml
232−[[actions]]
233−type = "create_table"
234−name = "profiles"
235−primary_key = ["user_id"]
236−
237− [[actions.columns]]
238− name = "user_id"
239− type = "INTEGER"
240−
241− [[actions.columns]]
242− name = "user_email"
243− type = "TEXT"
244−
245− # Backfill from `users` table and copy `users.email` to `user_email` column
246− # This will perform an upsert based on the primary key to avoid duplicate rows
247− [actions.up]
248− table = "users"
249− values = { user_id = "id", user_email = "email" }
250−```
251−
252229#### Rename table
253230
254231The `rename_table` action will change the name of an existing table.
255232
256−_Example: change name of `users` table to `customers`_
233+*Example: change name of `users` table to `customers`*
257234
258235```toml
259236[[actions]]
@@ -266,7 +243,7 @@ new_name = "customers"
266243
267244The `remove_table` action will remove an existing table.
268245
269−_Example: remove `users` table_
246+*Example: remove `users` table*
270247
271248```toml
272249[[actions]]
@@ -278,7 +255,7 @@ table = "users"
278255
279256The `add_foreign_key` action will add a foreign key between two existing tables. The migration will fail if the existing column values aren't valid references.
280257
281−_Example: create foreign key from `items` to `users` table_
258+*Example: create foreign key from `items` to `users` table*
282259
283260```toml
284261[[actions]]
@@ -295,7 +272,7 @@ table = "items"
295272
296273The `remove_foreign_key` action will remove an existing foreign key. The foreign key will only be removed once the migration is completed, which means that your new application must continue to adhere to the foreign key constraint.
297274
298−_Example: remove foreign key `items_user_id_fkey` from `users` table_
275+*Example: remove foreign key `items_user_id_fkey` from `users` table*
299276
300277```toml
301278[[actions]]
@@ -308,9 +285,9 @@ foreign_key = "items_user_id_fkey"
308285
309286#### Add column
310287
311−The `add_column` action will add a new column to an existing table. You can optionally provide an `up` setting. This should be an SQL expression which will be run for all existing rows to backfill the new column. `up` may also reference another table to perform cross-table migrations (see ["Complex changes across tables"](#complex-changes-across-tables)).
288+The `add_column` action will add a new column to an existing table. You can optionally provide an `up` setting. This should be an SQL expression which will be run for all existing rows to backfill the new column.
312289
313−_Example: add a new column `reference` to table `products`_
290+*Example: add a new column `reference` to table `products`*
314291
315292```toml
316293[[actions]]
@@ -324,7 +301,7 @@ table = "products"
324301 default = "10"
325302```
326303
327−_Example: replace an existing `name` column with two new columns, `first_name` and `last_name`_
304+*Example: replace an existing `name` column with two new columns, `first_name` and `last_name`*
328305
329306```toml
330307[[actions]]
@@ -360,7 +337,7 @@ column = "name"
360337down = "first_name || ' ' || last_name"
361338```
362339
363−_Example: extract nested value from unstructured JSON `data` column to new `name` column_
340+*Example: extract nested value from unstructured JSON `data` column to new `name` column*
364341
365342```toml
366343[[actions]]
@@ -375,25 +352,6 @@ up = "data['path']['to']['value'] #>> '{}'"
375352 type = "TEXT"
376353```
377354
378−_Example: duplicate `email` column from `users` to `profiles` table_
379−
380−```toml
381−# `profiles` has `user_id` column which maps to `users.id`
382−[[actions]]
383−type = "add_column"
384−table = "profiles"
385−
386− [actions.column]
387− name = "email"
388− type = "TEXT"
389− nullable = false
390−
391− # When `users` is updated in the old schema, we write the email value to `profiles`
392− [actions.up]
393− table = "users"
394− value = "email"
395− where = "user_id = id"
396−```
397355
398356#### Alter column
399357
@@ -401,7 +359,7 @@ The `alter_column` action enables many different changes to an existing column,
401359
402360When performing more complex changes than a rename, `up` and `down` should be provided. These should be SQL expressions which determine how to transform between the new and old version of the column. Inside those expressions, you can reference the current column value by the column name.
403361
404−_Example: rename `last_name` column on `users` table to `family_name`_
362+*Example: rename `last_name` column on `users` table to `family_name`*
405363
406364```toml
407365[[actions]]
@@ -413,7 +371,7 @@ column = "last_name"
413371 name = "family_name"
414372```
415373
416−_Example: change the type of `reference` column from `INTEGER` to `TEXT`_
374+*Example: change the type of `reference` column from `INTEGER` to `TEXT`*
417375
418376```toml
419377[[actions]]
@@ -428,7 +386,7 @@ down = "CAST(reference AS INTEGER)" # Converts from text value to integer
428386 type = "TEXT" # Previous type was 'INTEGER'
429387```
430388
431−_Example: increment all values of an `index` column by one_
389+*Example: increment all values of an `index` column by one*
432390
433391```toml
434392[[actions]]
@@ -443,7 +401,7 @@ down = "index - 1" # Decrement to revert for old schema
443401 name = "index"
444402```
445403
446−_Example: make `name` column not nullable_
404+*Example: make `name` column not nullable*
447405
448406```toml
449407[[actions]]
@@ -458,7 +416,7 @@ up = "COALESCE(name, 'N/A')"
458416 nullable = false
459417```
460418
461−_Example: change default value of `created_at` column to current time_
419+*Example: change default value of `created_at` column to current time*
462420
463421```toml
464422[[actions]]
@@ -472,11 +430,11 @@ column = "created_at"
472430
473431#### Remove column
474432
475−The `remove_column` action will remove an existing column from a table. You can optionally provide a `down` setting. This should be an SQL expression which will be used to determine values for the old schema when inserting or updating rows using the new schema. `down` may also reference another table to perform cross-table migrations (see ["Complex changes across tables"](#complex-changes-across-tables)) . The `down` setting must be provided when the removed column is `NOT NULL` or doesn't have a default value.
433+The `remove_column` action will remove an existing column from a table. You can optionally provide a `down` setting. This should be an SQL expression which will be used to determine values for the old schema when inserting or updating rows using the new schema. The `down` setting must be provided when the removed column is `NOT NULL` or doesn't have a default value.
476434
477435Any indices that cover the column will be removed.
478436
479−_Example: remove column `name` from table `users`_
437+*Example: remove column `name` from table `users`*
480438
481439```toml
482440[[actions]]
@@ -488,29 +446,13 @@ column = "name"
488446down = "'N/A'"
489447```
490448
491−_Example: remove `email` column from `users` table and use column from `profiles` table instead_
492−
493−```toml
494−[[actions]]
495−type = "remove_column"
496−table = "users"
497−column = "email"
498−
499− # Our application will use the `profiles.email` column instead
500− # For backwards compatibility, we will write back to the removed `email` column whenever `profiles` is changed
501− [actions.down]
502− table = "profiles"
503− value = "profiles.email"
504− where = "users.id = profiles.user_id"
505−```
506−
507449### Indices
508450
509451#### Add index
510452
511453The `add_index` action will add a new index to an existing table.
512454
513−_Example: create a `users` table with a unique index on the `name` column_
455+*Example: create a `users` table with a unique index on the `name` column*
514456
515457```toml
516458[[actions]]
@@ -539,7 +481,7 @@ table = "users"
539481 unique = true
540482```
541483
542−_Example: add GIN index to `data` column on `products` table_
484+*Example: add GIN index to `data` column on `products` table*
543485
544486```toml
545487[[actions]]
@@ -558,7 +500,7 @@ table = "products"
558500
559501The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
560502
561−_Example: remove the `name_idx` index_
503+*Example: remove the `name_idx` index*
562504
563505```toml
564506[[actions]]
@@ -572,7 +514,7 @@ index = "name_idx"
572514
573515The `create_enum` action will create a new [enum type](https://www.postgresql.org/docs/current/datatype-enum.html) with the specified values.
574516
575−_Example: add a new `mood` enum type with three possible values_
517+*Example: add a new `mood` enum type with three possible values*
576518
577519```toml
578520[[actions]]
@@ -585,7 +527,7 @@ values = ["happy", "ok", "sad"]
585527
586528The `remove_enum` action will remove an existing [enum type](https://www.postgresql.org/docs/current/datatype-enum.html). Make sure all usages of the enum has been removed before running the migration. The enum will only be removed once the migration is completed.
587529
588−_Example: remove the `mood` enum type_
530+*Example: remove the `mood` enum type*
589531
590532```toml
591533[[actions]]
@@ -603,7 +545,7 @@ There are three optional settings available which all accept SQL queries. All qu
603545- `complete`: run when a migration is completed using `reshape migration complete`
604546- `abort`: run when a migration is aborted using `reshape migration abort`
605547
606−_Example: enable PostGIS and pg_stat_statements extensions_
548+*Example: enable PostGIS and pg_stat_statements extensions*
607549
608550```toml
609551[[actions]]
@@ -620,92 +562,6 @@ abort = """
620562"""
621563```
622564
623−### Complex changes across tables
624−
625−The `up` and `down` options available when creating tables, adding columns and removing columns can also perform more complex changes that span tables.
626−
627−_Example: move `email` column from `users` to `profiles` table_
628−
629−```toml
630−[[actions]]
631−type = "add_column"
632−table = "profiles"
633−
634− [actions.column]
635− name = "email"
636− type = "TEXT"
637− nullable = false
638−
639− # When `users` is updated in the old schema, we write the email value to `profiles`
640− [actions.up]
641− table = "users"
642− value = "users.email"
643− where = "profiles.user_id = users.id"
644−
645−[[actions]]
646−type = "remove_column"
647−table = "users"
648−column = "email"
649−
650− # When `profiles` is changed in the new schema, we write the email address back to the removed column
651− [actions.down]
652− table = "profiles"
653− value = "profiles.email"
654− where = "users.id = profiles.user_id"
655−```
656−
657−_Example: turn a 1:N relationship between `users` and `accounts` into N:M and change the format of the associated `role`_
658−
659−```toml
660−# Add `user_account_connections` as a junction table
661−[[actions]]
662−type = "create_table"
663−name = "user_account_connections"
664−primary_key = ["account_id", "user_id"]
665−
666− [[actions.columns]]
667− name = "account_id"
668− type = "INTEGER"
669−
670− [[actions.columns]]
671− name = "user_id"
672− type = "INTEGER"
673−
674− # `role` is currently stored directly on the `users` table but is part of the relationship
675− [[actions.columns]]
676− name = "role"
677− type = "TEXT"
678− nullable = false
679−
680− # Backfill the new table from `users` and uppercase the `role`
681− [actions.up]
682− table = "users"
683− values = { user_id = "id", account_id = "account_id", role = "UPPER(account_role)" }
684− where = "user_account_connections.user_id = users.id"
685−
686−[[actions]]
687−type = "remove_column"
688−table = "users"
689−column = "account_id"
690−
691− # When `user_account_connections` is updated, we write the `account_id` back to `users`
692− [actions.down]
693− table = "user_account_connections"
694− value = "user_account_connections.account_id"
695− where = "users.id = user_account_connections.user_id"
696−
697−[[actions]]
698−type = "remove_column"
699−table = "users"
700−column = "account_role"
701−
702− # When `user_account_connections` is updated, we write the lowercase role back to `users`
703− [actions.down]
704− table = "user_account_connections"
705− value = "LOWER(user_account_connections.role)"
706− where = "users.id = user_account_connections.user_id"
707−```
708−
709565## Commands and options
710566
711567### `reshape migration start`
@@ -714,16 +570,16 @@ Starts a new migration, applying all migrations under `migrations/` that haven't
714570
715571#### Options
716572
717−_See also [Connection options](#connection-options)_
573+*See also [Connection options](#connection-options)*
718574
719−| Option | Default | Description |
720−| ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- |
721−| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
722−| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
575+| Option | Default | Description |
576+| ------ | ------- | ----------- |
577+| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
578+| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
723579
724580### `reshape migration complete`
725581
726−Completes migrations previously started with `reshape migration complete`.
582+Completes migrations previously started with `reshape migration complete`.
727583
728584#### Options
729585
@@ -731,7 +587,7 @@ See [Connection options](#connection-options)
731587
732588### `reshape migration abort`
733589
734−Aborts any migrations which haven't yet been completed.
590+Aborts any migrations which haven't yet been completed.
735591
736592#### Options
737593
@@ -747,8 +603,8 @@ The query should look something like `SET search_path TO migration_1_initial_mig
747603
748604#### Options
749605
750−| Option | Default | Description |
751−| -------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
606+| Option | Default | Description |
607+| ------ | ------- | ----------- |
752608| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
753609
754610### Connection options
@@ -757,14 +613,14 @@ The options below can be used with all commands that communicate with Postgres.
757613
758614All options can also be set using environment variables instead of flags. If a `.env` file exists, then variables will be automatically loaded from there.
759615
760−| Option | Default | Environment variable | Description |
761−| ------------ | ----------- | -------------------- | ------------------------------------------- |
762−| `--url` | | `DB_URL` | URL to your Postgres database |
763−| `--host` | `localhost` | `DB_HOST` | Hostname to use when connecting to Postgres |
764−| `--port` | `5432` | `DB_PORT` | Port which Postgres is listening on |
765−| `--database` | `postgres` | `DB_NAME` | Database name |
766−| `--username` | `postgres` | `DB_USERNAME` | Postgres username |
767−| `--password` | `postgres` | `DB_PASSWORD` | Postgres password |
616+| Option | Default | Environment variable | Description |
617+| ------ | ------- | -------------------- | ----------- |
618+| `--url` | | `DB_URL` | URL to your Postgres database |
619+| `--host` | `localhost` | `DB_HOST` | Hostname to use when connecting to Postgres |
620+| `--port` | `5432` | `DB_PORT` | Port which Postgres is listening on |
621+| `--database` | `postgres` | `DB_NAME` | Database name |
622+| `--username` | `postgres` | `DB_USERNAME` | Postgres username |
623+| `--password` | `postgres` | `DB_PASSWORD` | Postgres password |
768624
769625## License
770626