on 35a52eb help sign in
38 files changed+1630−4329
since splitsnapshots
unifiedsplit
.github/workflows/lint.yaml+3−3 .github/workflows/publish-crate.yaml−20 .github/workflows/publish-docker.yaml−25 Cargo.toml+3−6 Dockerfile+1−1 README.md+81−356 src/db.rs+5−76 src/helpers.rs+16−7 src/lib.rs+36−39 src/main.rs+18−93 src/migrations/add_column.rs+60−214 src/migrations/add_foreign_key.rs−122 src/migrations/alter_column.rs+16−17 src/migrations/common.rs+26−42 src/migrations/create_enum.rs−83 src/migrations/create_table.rs+24−128 src/migrations/custom.rs−61 src/migrations/mod.rs+3−24 src/migrations/remove_column.rs+35−353 src/migrations/remove_enum.rs−51 src/migrations/remove_foreign_key.rs−91 src/schema.rs+1−18 tests/add_column.rs+153−225 tests/add_foreign_key.rs−166 tests/add_index.rs+207−199 tests/alter_column.rs+498−637 tests/common.rs+19−45 tests/complex.rs−379 tests/create_enum.rs−41 tests/create_table.rs+83−81 tests/custom.rs−128 tests/failure.rs+58−34 tests/remove_column.rs+73−209 tests/remove_enum.rs−69 tests/remove_foreign_key.rs−124 tests/remove_index.rs+97−68 tests/remove_table.rs+48−38 tests/rename_table.rs+66−56
.github/workflows/lint.yaml+3−3
@@ -15,7 +15,7 @@ jobs:
1515 runs-on: ubuntu-latest
1616 steps:
1717 - name: Checkout
18− uses: actions/checkout@v4
18+ uses: actions/checkout@v2
1919 - name: Select Rust toolchain with Clippy
2020 uses: actions-rs/toolchain@v1
2121 with:
@@ -23,6 +23,6 @@ jobs:
2323 components: clippy
2424 override: true
2525 - name: Use cache for Rust dependencies
26− uses: Swatinem/rust-cache@v2
26+ uses: Swatinem/rust-cache@v1
2727 - name: Lint using Clippy
28− run: cargo clippy
28+ run: cargo clippy
.github/workflows/publish-crate.yamldeleted−20
@@ -1,20 +0,0 @@
1−name: Publish crate
2−
3−on: workflow_dispatch
4−
5−jobs:
6− publish-crate:
7− runs-on: ubuntu-latest
8− steps:
9− - name: Checkout
10− uses: actions/checkout@v2
11− - name: Select Rust toolchain
12− uses: actions-rs/toolchain@v1
13− with:
14− toolchain: stable
15− - name: Publish to crates.io
16− uses: actions-rs/cargo@v1
17− with:
18− command: publish
19− env:
20− CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
.github/workflows/publish-docker.yamldeleted−25
@@ -1,25 +0,0 @@
1−name: Publish Docker image
2−
3−on:
4− workflow_dispatch:
5− inputs:
6− version:
7− description: "Version (without 'v' prefix)"
8− required: true
9− type: string
10−
11−jobs:
12− publish-docker:
13− runs-on: ubuntu-latest
14− steps:
15− - name: Checkout
16− uses: actions/checkout@v2
17− - name: Log in to Docker
18− env:
19− DOCKER_PASSWORD: ${{ secrets.DOCKER_ACCESS_TOKEN }}
20− run: |
21− docker login -u ${{ secrets.DOCKER_USER }} -p $DOCKER_PASSWORD
22− - name: Build Docker image
23− run: docker build . --tag ${{ secrets.DOCKER_USER }}/reshape:${{ inputs.version }} --tag ${{ secrets.DOCKER_USER }}/reshape:latest
24− - name: Push Docker image
25− run: docker push --all-tags ${{ secrets.DOCKER_USER }}/reshape
Cargo.toml+3−6
@@ -1,6 +1,6 @@
11[package]
22name = "reshape"
3−version = "0.7.0"
3+version = "0.3.0"
44description = "An easy-to-use, zero-downtime schema migration tool for Postgres"
55homepage = "https://github.com/fabianlindfors/reshape"
66documentation = "https://github.com/fabianlindfors/reshape"
@@ -9,7 +9,6 @@ license = "MIT"
99keywords = ["postgres", "migrations"]
1010edition = "2021"
1111authors = ["Fabian Lindfors"]
12−rust-version = "1.70"
1312
1413[dependencies]
1514postgres = { version = "0.19.2", features = ["with-serde_json-1"] }
@@ -17,10 +16,8 @@ serde = { version = "1.0", features = ["derive"] }
1716serde_json = "1.0"
1817typetag = "0.1.7"
1918anyhow = { version = "1.0.44", features = ["backtrace"] }
20−clap = { version = "3.1.9", features = ["derive"] }
19+clap = { version = "3.0.0", features = ["derive"] }
2120toml = "0.5"
2221version = "3.0.0"
2322colored = "2"
24−rand = "0.8"
25−dotenv = "0.15.0"
26−lexical-sort = "0.3.1"
23+"derive_builder" = "0.10.2"
Dockerfile+1−1
@@ -1,4 +1,4 @@
1−FROM rust:1.70.0 AS builder
1+FROM rust:1.58.0 AS builder
22WORKDIR /usr/src/reshape
33COPY . .
44RUN cargo build --release
README.md+81−356
@@ -2,56 +2,50 @@
22
33[![Test status badge](https://github.com/fabianlindfors/Reshape/actions/workflows/test.yaml/badge.svg)](https://github.com/fabianlindfors/reshape/actions/workflows/test.yaml) [![Latest release](https://shields.io/github/v/release/fabianlindfors/reshape?display_name=tag&sort=semver&color=blue)](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)!
5+Reshape 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.
66
7−Reshape 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/).
7+Reshape is designed for Postgres 12 and later.
88
9−Designed for Postgres 12 and later.
9+*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) break your application.*
1010
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+ - [Columns](#columns)
25+ - [Add column](#add-column)
26+ - [Alter column](#alter-column)
27+ - [Remove column](#remove-column)
28+ - [Indices](#indices)
29+ - [Add index](#add-index)
30+ - [Remove index](#remove-index)
3831- [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)
32+ - [`reshape migrate`](#reshape-migrate)
33+ - [`reshape complete`](#reshape-complete)
34+ - [`reshape abort`](#reshape-abort)
35+ - [`reshape generate-schema-query`](#reshape-generate-schema-query)
36+ - [Connection options](#connection-options)
4437- [License](#license)
4538
39+
4640## How it works
4741
4842Reshape 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:
4943
50−1. **Start migration** (`reshape migration start`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
44+1. **Start migration** (`reshape migrate`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
51452. **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.
46+3. **Complete migration** (`reshape complete`): Removes the old schema and any intermediate data and triggers.
5347
54−If the application deployment fails, you should run `reshape migration abort` which will roll back any changes made by `reshape migration start` without losing data.
48+If the application deployment fails, you should run `reshape abort` which will roll back any changes made by `reshape migrate` without losing data.
5549
5650## Getting started
5751
@@ -63,7 +57,7 @@ Binaries are available for macOS and Linux under [Releases](https://github.com/f
6357
6458#### Cargo
6559
66−Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/) (requires Rust 1.58 or later):
60+Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/):
6761
6862```shell
6963cargo install reshape
@@ -71,10 +65,10 @@ cargo install reshape
7165
7266#### Docker
7367
74−Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
68+Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
7569
7670```shell
77−docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migration start
71+docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migrate
7872```
7973
8074### Creating your first migration
@@ -103,14 +97,9 @@ This is the equivalent of running `CREATE TABLE users (id INTEGER GENERATED ALWA
10397
10498### Preparing your application
10599
106−Reshape relies on your application using a specific schema. When establishing the connection to Postgres in your application, you need to run a query to select the most recent schema. The simplest way to do this is to use one of the helper libraries:
107−
108−- [Rust](https://github.com/fabianlindfors/reshape-helper)
109−- [Ruby (and Rails)](https://github.com/fabianlindfors/reshape-ruby)
110−- [Python (and Django)](https://github.com/fabianlindfors/reshape-python)
111−- [Go](https://github.com/leourbina/reshape-helper)
100+Reshape relies on your application using a specific schema. When establishing the connection to Postgres in your application, you need to run a query to select the most recent schema. This query can be generated using: `reshape generate-schema-query`.
112101
113−If your application is not using one of the languages with an available helper library, you can instead generate the query with the command: `reshape schema-query`. To pass it along to your application, you can for example use an environment variable in your run script: `RESHAPE_SCHEMA_QUERY=$(reshape schema-query)`. Then in your application:
102+To pass it along to your application, you can for example use an environment variable in your run script: `RESHAPE_SCHEMA_QUERY=$(reshape generate-schema-query)`. Then in your application:
114103
115104```python
116105# Example for Python
@@ -123,16 +112,16 @@ db.execute(reshape_schema_query)
123112To create your new `users` table, run:
124113
125114```bash
126−reshape migration start --complete
115+reshape migrate
127116```
128117
129−We use the `--complete` flag to automatically complete the migration. During a production deployment, you should first run `reshape migration start` followed by `reshape migration complete` once your application has been fully rolled out.
118+As this is the first migration, Reshape will automatically complete it. For subsequent migrations, you will need to first run `reshape migrate`, roll out your application and then complete the migration using `reshape complete`.
130119
131120If nothing else is specified, Reshape will try to connect to a Postgres database running on `localhost` using `postgres` as both username and password. See [Connection options](#connection-options) for details on how to change the connection settings.
132121
133122### Using during development
134123
135−When adding new migrations during development, we recommend running `reshape migration start` but skipping `reshape migration complete`. This way, the new migrations can be iterated on by updating the migration file and running `reshape migration abort` followed by `reshape migration start`.
124+When adding new migrations during development, we recommend running `reshape migrate` but skipping `reshape complete`. This way, the new migrations can be iterated on by updating the migration file and running `reshape abort` followed by `reshape migrate`.
136125
137126## Writing migrations
138127
@@ -167,9 +156,9 @@ Every action has a `type`. The supported types are detailed below.
167156
168157#### Create table
169158
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.
159+The `create_table` action will create a new table with the specified columns, indices and constraints.
171160
172−_Example: create a `customers` table with a few columns and a primary key_
161+*Example: create a `customers` table with a few columns and a primary key*
173162
174163```toml
175164[[actions]]
@@ -187,13 +176,13 @@ primary_key = ["id"]
187176 type = "TEXT"
188177
189178 # Columns default to nullable
190− nullable = false
179+ nullable = false
191180
192181 # default can be any valid SQL value, in this case a string literal
193− default = "'PLACEHOLDER'"
182+ default = "'PLACEHOLDER'"
194183```
195184
196−_Example: create `users` and `items` tables with a foreign key between them_
185+*Example: create `users` and `items` tables with a foreign key between them*
197186
198187```toml
199188[[actions]]
@@ -226,34 +215,11 @@ primary_key = ["id"]
226215 referenced_columns = ["id"]
227216```
228217
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−
252218#### Rename table
253219
254220The `rename_table` action will change the name of an existing table.
255221
256−_Example: change name of `users` table to `customers`_
222+*Example: change name of `users` table to `customers`*
257223
258224```toml
259225[[actions]]
@@ -266,7 +232,7 @@ new_name = "customers"
266232
267233The `remove_table` action will remove an existing table.
268234
269−_Example: remove `users` table_
235+*Example: remove `users` table*
270236
271237```toml
272238[[actions]]
@@ -274,43 +240,13 @@ type = "remove_table"
274240table = "users"
275241```
276242
277−#### Add foreign key
278−
279−The `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.
280−
281−_Example: create foreign key from `items` to `users` table_
282−
283−```toml
284−[[actions]]
285−type = "add_foreign_key"
286−table = "items"
287−
288− [actions.foreign_key]
289− columns = ["user_id"]
290− referenced_table = "users"
291− referenced_columns = ["id"]
292−```
293−
294−#### Remove foreign key
295−
296−The `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.
297−
298−_Example: remove foreign key `items_user_id_fkey` from `users` table_
299−
300−```toml
301−[[actions]]
302−type = "remove_foreign_key"
303−table = "items"
304−foreign_key = "items_user_id_fkey"
305−```
306−
307243### Columns
308244
309245#### Add column
310246
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)).
247+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.
312248
313−_Example: add a new column `reference` to table `products`_
249+*Example: add a new column `reference` to table `products`*
314250
315251```toml
316252[[actions]]
@@ -324,7 +260,7 @@ table = "products"
324260 default = "10"
325261```
326262
327−_Example: replace an existing `name` column with two new columns, `first_name` and `last_name`_
263+*Example: replace an existing `name` column with two new columns, `first_name` and `last_name`*
328264
329265```toml
330266[[actions]]
@@ -360,48 +296,14 @@ column = "name"
360296down = "first_name || ' ' || last_name"
361297```
362298
363−_Example: extract nested value from unstructured JSON `data` column to new `name` column_
364−
365−```toml
366−[[actions]]
367−type = "add_column"
368−table = "users"
369−
370−# #>> '{}' converts the JSON string value to TEXT
371−up = "data['path']['to']['value'] #>> '{}'"
372−
373− [actions.column]
374− name = "name"
375− type = "TEXT"
376−```
377−
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−```
397299
398300#### Alter column
399301
400302The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
401303
402−When 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.
304+When performing more complex changes than a rename, `up` and `down` must 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.
403305
404−_Example: rename `last_name` column on `users` table to `family_name`_
306+*Example: rename `last_name` column on `users` table to `family_name`*
405307
406308```toml
407309[[actions]]
@@ -413,7 +315,7 @@ column = "last_name"
413315 name = "family_name"
414316```
415317
416−_Example: change the type of `reference` column from `INTEGER` to `TEXT`_
318+*Example: change the type of `reference` column from `INTEGER` to `TEXT`*
417319
418320```toml
419321[[actions]]
@@ -428,7 +330,7 @@ down = "CAST(reference AS INTEGER)" # Converts from text value to integer
428330 type = "TEXT" # Previous type was 'INTEGER'
429331```
430332
431−_Example: increment all values of an `index` column by one_
333+*Example: increment all values of an `index` column by one*
432334
433335```toml
434336[[actions]]
@@ -443,22 +345,7 @@ down = "index - 1" # Decrement to revert for old schema
443345 name = "index"
444346```
445347
446−_Example: make `name` column not nullable_
447−
448−```toml
449−[[actions]]
450−type = "alter_column"
451−table = "users"
452−column = "name"
453−
454−# Use "N/A" for any rows that currently have a NULL name
455−up = "COALESCE(name, 'N/A')"
456−
457− [actions.changes]
458− nullable = false
459−```
460−
461−_Example: change default value of `created_at` column to current time_
348+*Example: change default value of `created_at` column to current time*
462349
463350```toml
464351[[actions]]
@@ -472,11 +359,9 @@ column = "created_at"
472359
473360#### Remove column
474361
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.
476−
477−Any indices that cover the column will be removed.
362+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.
478363
479−_Example: remove column `name` from table `users`_
364+*Example: remove column `name` from table `users`*
480365
481366```toml
482367[[actions]]
@@ -488,34 +373,18 @@ column = "name"
488373down = "'N/A'"
489374```
490375
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−
507376### Indices
508377
509378#### Add index
510379
511380The `add_index` action will add a new index to an existing table.
512381
513−_Example: create a `users` table with a unique index on the `name` column_
382+*Example: create a `users` table with a unique index on the `name` column*
514383
515384```toml
516385[[actions]]
517386type = "create_table"
518−name = "users"
387+table = "users"
519388primary_key = "id"
520389
521390 [[actions.columns]]
@@ -539,7 +408,7 @@ table = "users"
539408 unique = true
540409```
541410
542−_Example: add GIN index to `data` column on `products` table_
411+*Example: add GIN index to `data` column on `products` table*
543412
544413```toml
545414[[actions]]
@@ -558,7 +427,7 @@ table = "products"
558427
559428The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
560429
561−_Example: remove the `name_idx` index_
430+*Example: remove the `name_idx` index*
562431
563432```toml
564433[[actions]]
@@ -566,205 +435,61 @@ type = "remove_index"
566435index = "name_idx"
567436```
568437
569−### Enums
570−
571−#### Create enum
572−
573−The `create_enum` action will create a new [enum type](https://www.postgresql.org/docs/current/datatype-enum.html) with the specified values.
574−
575−_Example: add a new `mood` enum type with three possible values_
576−
577−```toml
578−[[actions]]
579−type = "create_enum"
580−name = "mood"
581−values = ["happy", "ok", "sad"]
582−```
583−
584−#### Remove enum
585−
586−The `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.
587−
588−_Example: remove the `mood` enum type_
589−
590−```toml
591−[[actions]]
592−type = "remove_enum"
593−enum = "mood"
594−```
595−
596−### Custom
597−
598−The `custom` action lets you create a migration which runs custom SQL. It should be used with great care as it provides no guarantees of zero-downtime and will simply run whatever SQL is provided. Use other actions whenever possible as they are explicitly designed for zero downtime.
599−
600−There are three optional settings available which all accept SQL queries. All queries need to be idempotent, for example by using `IF NOT EXISTS` wherever available.
601−
602−- `start`: run when a migration is started using `reshape migration start`
603−- `complete`: run when a migration is completed using `reshape migration complete`
604−- `abort`: run when a migration is aborted using `reshape migration abort`
605−
606−_Example: enable PostGIS and pg_stat_statements extensions_
607−
608−```toml
609−[[actions]]
610−type = "custom"
611−
612−start = """
613− CREATE EXTENSION IF NOT EXISTS postgis;
614− CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
615−"""
616−
617−abort = """
618− DROP EXTENSION IF EXISTS postgis;
619− DROP EXTENSION IF EXISTS pg_stat_statements;
620−"""
621−```
622−
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−
709438## Commands and options
710439
711−### `reshape migration start`
440+### `reshape migrate`
712441
713−Starts a new migration, applying all migrations under `migrations/` that haven't yet been applied. After the command has completed, both the old and new schema will be usable at the same time. When you have rolled out the new version of your application which uses the new schema, you should run `reshape migration complete`.
442+Starts a new migration, applying all migrations under `migrations/` that haven't yet been applied. After the command has completed, both the old and new schema will be usable at the same time. When you have rolled out the new version of your application which uses the new schema, you should run `reshape complete`.
714443
715444#### Options
716445
717−_See also [Connection options](#connection-options)_
446+*See also [Connection options](#connection-options)*
718447
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`. |
448+| Option | Default | Description |
449+| ------ | ------- | ----------- |
450+| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
451+| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
723452
724−### `reshape migration complete`
453+### `reshape complete`
725454
726−Completes migrations previously started with `reshape migration complete`.
455+Completes migrations previously started with `reshape complete`.
727456
728457#### Options
729458
730459See [Connection options](#connection-options)
731460
732−### `reshape migration abort`
461+### `reshape abort`
733462
734−Aborts any migrations which haven't yet been completed.
463+Aborts any migrations which haven't yet been completed.
735464
736465#### Options
737466
738467See [Connection options](#connection-options)
739468
740−### `reshape schema-query`
469+### `reshape generate-schema-query`
741470
742471Generates the SQL query you need to run in your application before using the database. This command does not require a database connection. Instead it will generate the query based on the latest migration in the `migrations/` directory (or the directories specified by `--dirs`).
743472
744−If your application is written in Rust, we recommend using the [Rust helper library](https://github.com/fabianlindfors/reshape-helper/) instead.
745−
746473The query should look something like `SET search_path TO migration_1_initial_migration`.
747474
748475#### Options
749476
750−| Option | Default | Description |
751−| -------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
477+| Option | Default | Description |
478+| ------ | ------- | ----------- |
752479| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
753480
754481### Connection options
755482
756−The options below can be used with all commands that communicate with Postgres. Use either a [connection URL](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) or specify each connection option individually.
757−
758−All options can also be set using environment variables instead of flags. If a `.env` file exists, then variables will be automatically loaded from there.
483+The options below can be used with all commands that communicate with Postgres. Use either a connection URL or specify each connection option individually.
759484
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 |
485+| Option | Default | Description |
486+| ------ | ------- | ----------- |
487+| `--url` | | URI to connect to your Postgres database.<br>Can also be provided with the environment variable `DATABASE_URL`. |
488+| `--host` | `localhost` | Hostname to use when connecting to Postgres |
489+| `--port` | `5432` | Port which Postgres is listening on |
490+| `--database` | `postgres` | Database name |
491+| `--username` | `postgres` | Postgres username |
492+| `--password` | `postgres` | Postgres password |
768493
769494## License
770495
src/db.rs+5−76
@@ -1,8 +1,5 @@
1−use std::{cmp::min, time::Duration};
2−
3−use anyhow::{anyhow, Context};
1+use anyhow::anyhow;
42use postgres::{types::ToSql, NoTls, Row};
5−use rand::prelude::*;
63
74// DbLocker wraps a regular DbConn, only allowing access using the
85// `lock` method. This method will acquire the advisory lock before
@@ -25,24 +22,7 @@ impl DbLocker {
2522 const LOCK_KEY: i64 = 4036779288569897133;
2623
2724 pub fn connect(config: &postgres::Config) -> anyhow::Result<Self> {
28− let mut pg = config.connect(NoTls)?;
29−
30− // When running DDL queries that acquire locks, we risk causing a "lock queue".
31− // When attempting to acquire a lock, Postgres will wait for any long running queries to complete.
32− // At the same time, it will block other queries until the lock has been acquired and released.
33− // This has the bad effect of the long-running query blocking other queries because of us, forming
34− // a queue of other queries until we release our lock.
35− //
36− // We set the lock_timeout setting to avoid this. This puts an upper bound for how long Postgres will
37− // wait to acquire locks and also the maximum amount of time a long-running query can block other queries.
38− // We should also add automatic retries to handle these timeouts gracefully.
39− //
40− // Reference: https://medium.com/paypal-tech/postgresql-at-scale-database-schema-changes-without-downtime-20d3749ed680
41− //
42− // TODO: Make lock_timeout configurable
43− pg.simple_query("SET lock_timeout = '1s'")
44− .context("failed to set lock_timeout")?;
45−
25+ let pg = config.connect(NoTls)?;
4626 Ok(Self {
4727 client: DbConn::new(pg),
4828 })
@@ -106,12 +86,12 @@ impl DbConn {
10686
10787impl Conn for DbConn {
10888 fn run(&mut self, query: &str) -> anyhow::Result<()> {
109− retry_automatically(|| self.client.batch_execute(query))?;
89+ self.client.batch_execute(query)?;
11090 Ok(())
11191 }
11292
11393 fn query(&mut self, query: &str) -> anyhow::Result<Vec<Row>> {
114− let rows = retry_automatically(|| self.client.query(query, &[]))?;
94+ let rows = self.client.query(query, &[])?;
11595 Ok(rows)
11696 }
11797
@@ -120,7 +100,7 @@ impl Conn for DbConn {
120100 query: &str,
121101 params: &[&(dyn ToSql + Sync)],
122102 ) -> anyhow::Result<Vec<Row>> {
123− let rows = retry_automatically(|| self.client.query(query, params))?;
103+ let rows = self.client.query(query, params)?;
124104 Ok(rows)
125105 }
126106
@@ -171,54 +151,3 @@ impl Conn for Transaction<'_> {
171151 Ok(Transaction { transaction })
172152 }
173153}
174−
175−// Retry a database operation with exponential backoff and jitter
176−fn retry_automatically<T>(
177− mut f: impl FnMut() -> Result<T, postgres::Error>,
178−) -> Result<T, postgres::Error> {
179− const STARTING_WAIT_TIME: u64 = 100;
180− const MAX_WAIT_TIME: u64 = 3_200;
181− const MAX_ATTEMPTS: u32 = 10;
182−
183− let mut rng = rand::thread_rng();
184− let mut attempts = 0;
185− loop {
186− let result = f();
187−
188− let error = match result {
189− Ok(_) => return result,
190− Err(err) => err,
191− };
192−
193− // If we got a database error, we check if it's retryable.
194− // If we didn't get a database error, then it's most likely some kind of connection
195− // error which should also be retried.
196− if let Some(db_error) = error.as_db_error() {
197− if !error_retryable(db_error) {
198− return Err(error);
199− }
200− }
201−
202− attempts += 1;
203− if attempts >= MAX_ATTEMPTS {
204− return Err(error);
205− }
206−
207− // The wait time increases exponentially, starting at 100ms and doubling up to a max of 3.2s.
208− let wait_time = min(
209− MAX_WAIT_TIME,
210− STARTING_WAIT_TIME * u64::pow(2, attempts - 1),
211− );
212−
213− // The jitter is up to half the wait time
214− let jitter: u64 = rng.gen_range(0..wait_time / 2);
215−
216− std::thread::sleep(Duration::from_millis(wait_time + jitter));
217− }
218−}
219−
220−// Check if a database error can be retried
221−fn error_retryable(error: &postgres::error::DbError) -> bool {
222− // LOCK_NOT_AVAILABLE is caused by lock_timeout being exceeded
223− matches!(error.code(), &postgres::error::SqlState::LOCK_NOT_AVAILABLE)
224−}
src/helpers.rs+16−7
@@ -2,28 +2,37 @@ use anyhow::Context;
22
33use crate::db::Conn;
44
5−pub fn set_up_helpers(db: &mut dyn Conn, target_migration: &str) -> anyhow::Result<()> {
5+pub fn set_up_helpers(db: &mut dyn Conn, current_migration: &Option<String>) -> anyhow::Result<()> {
6+ let predicate = if let Some(current_migration) = current_migration {
7+ format!(
8+ "current_setting('search_path') = 'migration_{}' OR setting_bool",
9+ current_migration
10+ )
11+ } else {
12+ "setting_bool".to_string()
13+ };
14+
615 let query = format!(
716 "
8− CREATE OR REPLACE FUNCTION reshape.is_new_schema()
17+ CREATE OR REPLACE FUNCTION reshape.is_old_schema()
918 RETURNS BOOLEAN AS $$
1019 DECLARE
11− setting TEXT := current_setting('reshape.is_new_schema', TRUE);
20+ setting TEXT := current_setting('reshape.is_old_schema', TRUE);
1221 setting_bool BOOLEAN := setting IS NOT NULL AND setting = 'YES';
1322 BEGIN
14− RETURN current_setting('search_path') = 'migration_{}' OR setting_bool;
23+ RETURN {};
1524 END
1625 $$ language 'plpgsql';
1726 ",
18− target_migration,
27+ predicate
1928 );
2029 db.query(&query)
21− .context("failed creating helper function reshape.is_new_schema()")?;
30+ .context("failed creating helper function reshape.is_old_schema()")?;
2231
2332 Ok(())
2433}
2534
2635pub fn tear_down_helpers(db: &mut dyn Conn) -> anyhow::Result<()> {
27− db.query("DROP FUNCTION IF EXISTS reshape.is_new_schema;")?;
36+ db.query("DROP FUNCTION IF EXISTS reshape.is_old_schema;")?;
2837 Ok(())
2938}
src/lib.rs+36−39
@@ -30,7 +30,6 @@ impl Reshape {
3030 pub fn new_with_options(
3131 host: &str,
3232 port: u16,
33− database: &str,
3433 username: &str,
3534 password: &str,
3635 ) -> anyhow::Result<Reshape> {
@@ -39,7 +38,6 @@ impl Reshape {
3938 .host(host)
4039 .port(port)
4140 .user(username)
42− .dbname(database)
4341 .password(password);
4442
4543 Self::new_with_config(&config)
@@ -105,16 +103,6 @@ impl Reshape {
105103 ))?;
106104 }
107105
108− // Remove all enums
109− let enums: Vec<String> = db
110− .query("SELECT typname FROM pg_type WHERE typcategory = 'E'")?
111− .iter()
112− .map(|row| row.get("typname"))
113− .collect();
114− for enum_type in enums {
115− db.run(&format!("DROP TYPE {}", enum_type))?;
116− }
117−
118106 // Reset state
119107 state.clear(db)?;
120108
@@ -147,15 +135,13 @@ fn migrate(
147135) -> anyhow::Result<()> {
148136 // Make sure no migration is in progress
149137 if let State::InProgress { .. } = &state {
150− println!(
151− "Migration already in progress, please complete using 'reshape migration complete'"
152− );
138+ println!("Migration already in progress, please complete using 'reshape complete'");
153139 return Ok(());
154140 }
155141
156142 if let State::Completing { .. } = &state {
157143 println!(
158− "Migration already in progress and has started completion, please finish using 'reshape migration complete'"
144+ "Migration already in progress and has started completion, please finish using 'reshape complete'"
159145 );
160146 return Ok(());
161147 }
@@ -164,6 +150,7 @@ fn migrate(
164150 // with the already applied ones stored in the state. This will throw an error if the
165151 // two sets of migrations don't agree, for example if a new migration has been added
166152 // in between two existing ones.
153+ let current_migration = state::current_migration(db)?;
167154 let remaining_migrations = state::remaining_migrations(db, migrations)?;
168155 if remaining_migrations.is_empty() {
169156 println!("No migrations left to apply");
@@ -178,8 +165,8 @@ fn migrate(
178165 {
179166 if existing_migrations != &remaining_migrations {
180167 return Err(anyhow!(
181− "a previous migration seems to have failed without cleaning up. Please run `reshape migration abort` and then run migrate again."
182− ));
168+ "a previous migration seems to have failed without cleaning up. Please run `reshape abort` and then run migrate again."
169+ ));
183170 }
184171 }
185172
@@ -192,15 +179,14 @@ fn migrate(
192179
193180 println!("Applying {} migrations\n", remaining_migrations.len());
194181
195− let target_migration = remaining_migrations.last().unwrap().name.to_string();
196− helpers::set_up_helpers(db, &target_migration).context("failed to set up helpers")?;
182+ helpers::set_up_helpers(db, &current_migration).context("failed to set up helpers")?;
197183
198184 let mut new_schema = Schema::new();
199185 let mut last_migration_index = usize::MAX;
200186 let mut last_action_index = usize::MAX;
201187 let mut result: anyhow::Result<()> = Ok(());
202188
203− 'outer: for (migration_index, migration) in remaining_migrations.iter().enumerate() {
189+ for (migration_index, migration) in remaining_migrations.iter().enumerate() {
204190 println!("Migrating '{}':", migration.name);
205191 last_migration_index = migration_index;
206192
@@ -210,8 +196,7 @@ fn migrate(
210196 let description = action.describe();
211197 print!(" + {} ", description);
212198
213− let ctx =
214− MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
199+ let ctx = MigrationContext::new(migration_index, action_index);
215200 result = action
216201 .run(&ctx, db, &new_schema)
217202 .with_context(|| format!("failed to {}", description));
@@ -221,7 +206,7 @@ fn migrate(
221206 println!("{}", "done".green());
222207 } else {
223208 println!("{}", "failed".red());
224− break 'outer;
209+ break;
225210 }
226211 }
227212
@@ -235,7 +220,7 @@ fn migrate(
235220 // Set to the Aborting state. This is to ensure that the failed
236221 // migration is fully aborted and nothing is left dangling.
237222 // If the abort is interrupted for any reason, the user can try again
238− // by running `reshape migration abort`.
223+ // by running `reshape abort`.
239224 state.aborting(
240225 remaining_migrations.clone(),
241226 last_migration_index + 1,
@@ -249,6 +234,7 @@ fn migrate(
249234 }
250235
251236 // Create schema and views for migration
237+ let target_migration = remaining_migrations.last().unwrap().name.to_string();
252238 create_schema_for_migration(db, &target_migration, &new_schema)
253239 .with_context(|| format!("failed to create schema for migration {}", target_migration))?;
254240
@@ -256,14 +242,27 @@ fn migrate(
256242 state.in_progress(remaining_migrations);
257243 state.save(db).context("failed to save in-progress state")?;
258244
259− println!("Migrations have been applied and the new schema is ready for use:");
260− println!(
261− " - Run '{}' from your application to use the latest schema",
262− schema_query_for_migration(&target_migration)
263− );
264− println!(
265− " - Run 'reshape migration complete' once your application has been updated and the previous schema is no longer in use"
266− );
245+ // If we started from a blank slate, we can finish the migration immediately
246+ if current_migration.is_none() {
247+ println!("Automatically completing migrations\n");
248+ complete(db, state).context("failed to automatically complete migrations")?;
249+
250+ println!("Migrations complete:");
251+ println!(
252+ " - Run '{}' from your application to use the latest schema",
253+ schema_query_for_migration(&target_migration)
254+ );
255+ } else {
256+ println!("Migrations have been applied and the new schema is ready for use:");
257+ println!(
258+ " - Run '{}' from your application to use the latest schema",
259+ schema_query_for_migration(&target_migration)
260+ );
261+ println!(
262+ " - Run 'reshape complete' once your application has been updated and the previous schema is no longer in use"
263+ );
264+ }
265+
267266 Ok(())
268267}
269268
@@ -284,7 +283,7 @@ fn complete(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
284283 current_action_index
285284 } => (migrations, current_migration_index, current_action_index),
286285 State::Aborting { .. } => {
287− return Err(anyhow!("migration been aborted and can't be completed. Please finish using `reshape migration abort`."))
286+ return Err(anyhow!("migration been aborted and can't be completed. Please finish using `reshape abort`."))
288287 }
289288 State::Applying { .. } => {
290289 return Err(anyhow!("a previous migration unexpectedly failed. Please run `reshape migrate` to try applying the migration again."))
@@ -321,8 +320,7 @@ fn complete(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
321320 let description = action.describe();
322321 print!(" + {} ", description);
323322
324− let ctx =
325− MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
323+ let ctx = MigrationContext::new(migration_index, action_index);
326324
327325 // Update state to indicate that this action has been completed.
328326 // We won't save this new state until after the action has completed.
@@ -413,7 +411,7 @@ fn abort(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
413411 last_action_index,
414412 } => (migrations, last_migration_index, last_action_index),
415413 State::Completing { .. } => {
416− return Err(anyhow!("migration completion has already been started. Please run `reshape migration complete` again to finish it."));
414+ return Err(anyhow!("Migration completion has already been started. Please run `reshape complete` again to finish it."));
417415 }
418416 State::Idle => {
419417 println!("No migration is in progress");
@@ -447,8 +445,7 @@ fn abort(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
447445 continue;
448446 }
449447
450− let ctx =
451− MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
448+ let ctx = MigrationContext::new(migration_index, action_index);
452449 action
453450 .abort(&ctx, db)
454451 .with_context(|| format!("failed to abort migration {}", migration.name))
src/main.rs+18−93
@@ -4,7 +4,6 @@ use std::{
44 path::Path,
55};
66
7−use anyhow::Context;
87use clap::{Args, Parser};
98use reshape::{
109 migrations::{Action, Migration},
@@ -13,69 +12,22 @@ use reshape::{
1312use serde::{Deserialize, Serialize};
1413
1514#[derive(Parser)]
16−#[clap(name = "Reshape", version, about)]
1715struct Opts {
1816 #[clap(subcommand)]
1917 cmd: Command,
2018}
2119
2220#[derive(Parser)]
23−#[clap(about)]
2421enum Command {
25− #[clap(subcommand)]
26− Migration(MigrationCommand),
27−
28− #[clap(
29− about = "Output the query your application should use to select the right schema",
30− display_order = 2
31− )]
32− SchemaQuery(FindMigrationsOptions),
33−
34− #[clap(
35− about = "Deprecated. Use `reshape schema-query` instead",
36− display_order = 3
37− )]
38− GenerateSchemaQuery(FindMigrationsOptions),
39−
40− #[clap(
41− about = "Deprecated. Use `reshape migration start` instead",
42− display_order = 4
43− )]
4422 Migrate(MigrateOptions),
45− #[clap(
46− about = "Deprecated. Use `reshape migration complete` instead",
47− display_order = 5
48− )]
49− Complete(ConnectionOptions),
50− #[clap(
51− about = "Deprecated. Use `reshape migration abort` instead",
52− display_order = 6
53− )]
54− Abort(ConnectionOptions),
55−}
56−
57−#[derive(Parser)]
58−#[clap(about = "Commands for managing migrations", display_order = 1)]
59−enum MigrationCommand {
60− #[clap(
61− about = "Starts a new migration, applying any migrations which haven't yet been applied",
62− display_order = 1
63− )]
64− Start(MigrateOptions),
65−
66− #[clap(about = "Completes an in-progress migration", display_order = 2)]
6723 Complete(ConnectionOptions),
68−
69− #[clap(
70− about = "Aborts an in-progress migration without losing any data",
71− display_order = 3
72− )]
24+ Remove(ConnectionOptions),
7325 Abort(ConnectionOptions),
26+ GenerateSchemaQuery(FindMigrationsOptions),
7427}
7528
7629#[derive(Args)]
7730struct MigrateOptions {
78− // Some comment
7931 #[clap(long, short)]
8032 complete: bool,
8133 #[clap(flatten)]
@@ -113,7 +65,7 @@ fn main() -> anyhow::Result<()> {
11365
11466fn run(opts: Opts) -> anyhow::Result<()> {
11567 match opts.cmd {
116− Command::Migration(MigrationCommand::Start(opts)) | Command::Migrate(opts) => {
68+ Command::Migrate(opts) => {
11769 let mut reshape = reshape_from_connection_options(&opts.connection_options)?;
11870 let migrations = find_migrations(&opts.find_migrations_options)?;
11971 reshape.migrate(migrations)?;
@@ -125,16 +77,20 @@ fn run(opts: Opts) -> anyhow::Result<()> {
12577
12678 Ok(())
12779 }
128− Command::Migration(MigrationCommand::Complete(opts)) | Command::Complete(opts) => {
80+ Command::Complete(opts) => {
12981 let mut reshape = reshape_from_connection_options(&opts)?;
13082 reshape.complete()
13183 }
132− Command::Migration(MigrationCommand::Abort(opts)) | Command::Abort(opts) => {
84+ Command::Remove(opts) => {
85+ let mut reshape = reshape_from_connection_options(&opts)?;
86+ reshape.remove()
87+ }
88+ Command::Abort(opts) => {
13389 let mut reshape = reshape_from_connection_options(&opts)?;
13490 reshape.abort()
13591 }
136− Command::SchemaQuery(opts) | Command::GenerateSchemaQuery(opts) => {
137− let migrations = find_migrations(&opts)?;
92+ Command::GenerateSchemaQuery(find_migrations_options) => {
93+ let migrations = find_migrations(&find_migrations_options)?;
13894 let query = migrations
13995 .last()
14096 .map(|migration| reshape::schema_query_for_migration(&migration.name));
@@ -146,35 +102,13 @@ fn run(opts: Opts) -> anyhow::Result<()> {
146102}
147103
148104fn reshape_from_connection_options(opts: &ConnectionOptions) -> anyhow::Result<Reshape> {
149− // Load environment variables from .env file if it exists
150− dotenv::dotenv().ok();
105+ let env_url = std::env::var("POSTGRES_URL").ok();
106+ let url = env_url.as_ref().or_else(|| opts.url.as_ref());
151107
152− let url_env = std::env::var("DB_URL").ok();
153− let url = url_env.as_ref().or_else(|| opts.url.as_ref());
154−
155− // Use the connection URL if it has been set
156− if let Some(url) = url {
157− return Reshape::new(url);
108+ match url {
109+ Some(url) => Reshape::new(url),
110+ None => Reshape::new_with_options(&opts.host, opts.port, &opts.username, &opts.password),
158111 }
159−
160− let host_env = std::env::var("DB_HOST").ok();
161− let host = host_env.as_ref().unwrap_or_else(|| &opts.host);
162−
163− let port = std::env::var("DB_PORT")
164− .ok()
165− .and_then(|port| port.parse::<u16>().ok())
166− .unwrap_or(opts.port);
167−
168− let username_env = std::env::var("DB_USERNAME").ok();
169− let username = username_env.as_ref().unwrap_or_else(|| &opts.username);
170−
171− let password_env = std::env::var("DB_PASSWORD").ok();
172− let password = password_env.as_ref().unwrap_or_else(|| &opts.password);
173−
174− let database_env = std::env::var("DB_NAME").ok();
175− let database = database_env.as_ref().unwrap_or_else(|| &opts.database);
176−
177− Reshape::new_with_options(host, port, database, username, password)
178112}
179113
180114fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration>> {
@@ -196,13 +130,7 @@ fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration
196130 }
197131
198132 // Sort all files by their file names (without extension)
199− // The files are sorted naturally, e.g. "1_test_migration" < "10_test_migration"
200− file_paths.sort_unstable_by(|path1, path2| {
201− let file1 = path1.as_path().file_stem().unwrap().to_str().unwrap();
202− let file2 = path2.as_path().file_stem().unwrap().to_str().unwrap();
203−
204− lexical_sort::natural_cmp(file1, file2)
205− });
133+ file_paths.sort_unstable_by_key(|path| path.as_path().file_stem().unwrap().to_os_string());
206134
207135 file_paths
208136 .iter()
@@ -218,10 +146,7 @@ fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration
218146 .map(|result| {
219147 result.and_then(|(path, data)| {
220148 let extension = path.extension().and_then(|ext| ext.to_str()).unwrap();
221− let file_migration =
222− decode_migration_file(&data, extension).with_context(|| {
223− format!("failed to parse migration file {}", path.display())
224− })?;
149+ let file_migration = decode_migration_file(&data, extension)?;
225150
226151 let file_name = path.file_stem().and_then(|name| name.to_str()).unwrap();
227152 Ok(Migration {
src/migrations/add_column.rs+60−214
@@ -3,25 +3,14 @@ use crate::{
33 db::{Conn, Transaction},
44 schema::Schema,
55};
6−use anyhow::{bail, Context};
6+use anyhow::Context;
77use serde::{Deserialize, Serialize};
88
99#[derive(Serialize, Deserialize, Debug)]
1010pub struct AddColumn {
1111 pub table: String,
12+ pub up: Option<String>,
1213 pub column: Column,
13− pub up: Option<Transformation>,
14−}
15−
16−#[derive(Serialize, Deserialize, Debug)]
17−#[serde(untagged)]
18−pub enum Transformation {
19− Simple(String),
20− Update {
21− table: String,
22− value: String,
23− r#where: String,
24− },
2514}
2615
2716impl AddColumn {
@@ -43,15 +32,6 @@ impl AddColumn {
4332 )
4433 }
4534
46− fn reverse_trigger_name(&self, ctx: &MigrationContext) -> String {
47− format!(
48− "{}_add_column_{}_{}_rev",
49− ctx.prefix(),
50− self.table,
51− self.column.name
52− )
53− }
54−
5535 fn not_null_constraint_name(&self, ctx: &MigrationContext) -> String {
5636 format!(
5737 "{}_add_column_not_null_{}_{}",
@@ -81,7 +61,7 @@ impl Action for AddColumn {
8161 let temp_column_name = self.temp_column_name(ctx);
8262
8363 let mut definition_parts = vec![
84− format!("\"{}\"", temp_column_name.to_string()),
64+ temp_column_name.to_string(),
8565 self.column.data_type.to_string(),
8666 ];
8767
@@ -106,189 +86,55 @@ impl Action for AddColumn {
10686 );
10787 db.run(&query).context("failed to add column")?;
10888
109− let declarations: Vec<String> = table
110− .columns
111− .iter()
112− .map(|column| {
113− format!(
114− "\"{alias}\" public.{table}.{real_name}%TYPE := NEW.{real_name};",
115− table = table.real_name,
116− alias = column.name,
117− real_name = column.real_name,
118− )
119− })
120− .collect();
121−
12289 if let Some(up) = &self.up {
123− if let Transformation::Simple(up) = up {
124− // Add triggers to fill in values as they are inserted/updated
125− let query = format!(
126− r#"
127− CREATE OR REPLACE FUNCTION {trigger_name}()
128− RETURNS TRIGGER AS $$
129− BEGIN
130− IF NOT reshape.is_new_schema() THEN
131− DECLARE
132− {declarations}
133− BEGIN
134− NEW."{temp_column_name}" = {up};
135− END;
136− END IF;
137− RETURN NEW;
138− END
139− $$ language 'plpgsql';
140−
141− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
142− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
143− "#,
144− temp_column_name = temp_column_name,
145− trigger_name = self.trigger_name(ctx),
146− up = up,
147− table = self.table,
148− declarations = declarations.join("\n"),
149− );
150− db.run(&query).context("failed to create up trigger")?;
151−
152− // Backfill values in batches
153− common::batch_touch_rows(db, &table.real_name, Some(&temp_column_name))
154− .context("failed to batch update existing rows")?;
155− }
156−
157− if let Transformation::Update {
158− table: from_table,
159− value,
160− r#where,
161− } = up
162− {
163− let existing_schema_name = match &ctx.existing_schema_name {
164− Some(name) => name,
165− None => bail!("can't use update without previous migration"),
166− };
167−
168− let from_table = schema.get_table(db, &from_table)?;
169−
170− let from_table_assignments: Vec<String> = from_table
171− .columns
172− .iter()
173− .map(|column| {
174− format!(
175− "{table}.{alias} = NEW.{real_name};",
176− table = from_table.name,
177− alias = column.name,
178− real_name = column.real_name,
179− )
180− })
181− .collect();
182−
183− // Add triggers to fill in values as they are inserted/updated
184− let query = format!(
185− r#"
186− CREATE OR REPLACE FUNCTION {trigger_name}()
187− RETURNS TRIGGER AS $$
188− #variable_conflict use_variable
189− BEGIN
190− IF NOT reshape.is_new_schema() THEN
191− DECLARE
192− {from_table} migration_{existing_schema_name}.{from_table}%ROWTYPE;
193− BEGIN
194− {assignments}
195−
196− -- Don't trigger reverse trigger when making this update
197− perform set_config('reshape.disable_triggers', 'TRUE', TRUE);
198−
199− UPDATE public."{changed_table_real}"
200− SET "{temp_column_name}" = {value}
201− WHERE {where};
202−
203− perform set_config('reshape.disable_triggers', '', TRUE);
204− END;
205− END IF;
206− RETURN NEW;
207− END
208− $$ language 'plpgsql';
209−
210− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{from_table_real}";
211− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{from_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
212− "#,
213− assignments = from_table_assignments.join("\n"),
214− changed_table_real = table.real_name,
215− from_table = from_table.name,
216− from_table_real = from_table.real_name,
217− trigger_name = self.trigger_name(ctx),
218− // declarations = from_table_declarations.join("\n"),
219− temp_column_name = temp_column_name,
220− );
221− db.run(&query).context("failed to create up trigger")?;
222−
223− let from_table_columns = from_table
224− .columns
225− .iter()
226− .map(|column| format!("{} as {}", column.real_name, column.name))
227− .collect::<Vec<String>>()
228− .join(", ");
229−
230− let changed_table_assignments: Vec<String> = table
231− .columns
232− .iter()
233− .map(|column| {
234− format!(
235− "{table}.{alias} := NEW.{real_name};",
236− table = table.name,
237− alias = column.name,
238− real_name = column.real_name,
239− )
240− })
241− .collect();
242−
243− // Add triggers to fill in values as they are inserted/updated
244− let query = format!(
245− r#"
246− CREATE OR REPLACE FUNCTION {trigger_name}()
247− RETURNS TRIGGER AS $$
248− #variable_conflict use_variable
249− BEGIN
250− IF NOT reshape.is_new_schema() AND NOT current_setting('reshape.disable_triggers', TRUE) = 'TRUE' THEN
251− DECLARE
252− {changed_table} migration_{existing_schema_name}.{changed_table}%ROWTYPE;
253− __temp_row migration_{existing_schema_name}.{from_table}%ROWTYPE;
254− BEGIN
255− {changed_table_assignments}
256−
257− SELECT {from_table_columns}
258− INTO __temp_row
259− FROM migration_{existing_schema_name}.{from_table} {from_table}
260− WHERE {where};
261−
262− DECLARE
263− {from_table} migration_{existing_schema_name}.{from_table}%ROWTYPE;
264− BEGIN
265− {from_table} = __temp_row;
266− NEW.{temp_column_name} = {value};
267− END;
268− END;
269− END IF;
270− RETURN NEW;
271− END
272− $$ language 'plpgsql';
273−
274− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{changed_table_real}";
275− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{changed_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
276− "#,
277− changed_table_assignments = changed_table_assignments.join("\n"),
278− changed_table_real = table.real_name,
279− changed_table = table.name,
280− from_table = from_table.name,
281− trigger_name = self.reverse_trigger_name(ctx),
282− temp_column_name = temp_column_name,
283− // declarations = declarations.join("\n"),
284− );
285− db.run(&query)
286− .context("failed to create reverse up trigger")?;
90+ let table = schema.get_table(db, &self.table)?;
91+
92+ let declarations: Vec<String> = table
93+ .columns
94+ .iter()
95+ .map(|column| {
96+ format!(
97+ "{alias} public.{table}.{real_name}%TYPE := NEW.{real_name};",
98+ table = table.real_name,
99+ alias = column.name,
100+ real_name = column.real_name,
101+ )
102+ })
103+ .collect();
104+
105+ // Add triggers to fill in values as they are inserted/updated
106+ let query = format!(
107+ r#"
108+ CREATE OR REPLACE FUNCTION {trigger_name}()
109+ RETURNS TRIGGER AS $$
110+ BEGIN
111+ IF reshape.is_old_schema() THEN
112+ DECLARE
113+ {declarations}
114+ BEGIN
115+ NEW.{temp_column_name} = {up};
116+ END;
117+ END IF;
118+ RETURN NEW;
119+ END
120+ $$ language 'plpgsql';
121+
122+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
123+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
124+ "#,
125+ temp_column_name = temp_column_name,
126+ trigger_name = self.trigger_name(ctx),
127+ up = up,
128+ table = self.table,
129+ declarations = declarations.join("\n"),
130+ );
131+ db.run(&query).context("failed to create up trigger")?;
132+ }
287133
288− // Backfill values in batches by touching the from table
289− common::batch_touch_rows(db, &from_table.real_name, None)
290− .context("failed to batch update existing rows")?;
291− }
134+ // Backfill values in batches
135+ if self.up.is_some() {
136+ common::batch_touch_rows(db, &table.real_name, &temp_column_name)
137+ .context("failed to batch update existing rows")?;
292138 }
293139
294140 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
@@ -298,10 +144,10 @@ impl Action for AddColumn {
298144 if !self.column.nullable {
299145 let query = format!(
300146 r#"
301− ALTER TABLE "{table}"
302− ADD CONSTRAINT "{constraint_name}"
303− CHECK ("{column}" IS NOT NULL) NOT VALID
304− "#,
147+ ALTER TABLE "{table}"
148+ ADD CONSTRAINT "{constraint_name}"
149+ CHECK ("{column}" IS NOT NULL) NOT VALID
150+ "#,
305151 table = self.table,
306152 constraint_name = self.not_null_constraint_name(ctx),
307153 column = temp_column_name,
@@ -323,11 +169,11 @@ impl Action for AddColumn {
323169 // Remove triggers and procedures
324170 let query = format!(
325171 r#"
326− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
327− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
172+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
173+ DROP FUNCTION IF EXISTS "{trigger_name}";
328174 "#,
175+ table = self.table,
329176 trigger_name = self.trigger_name(ctx),
330− reverse_trigger_name = self.reverse_trigger_name(ctx),
331177 );
332178 transaction
333179 .run(&query)
@@ -418,11 +264,11 @@ impl Action for AddColumn {
418264 // Remove triggers and procedures
419265 let query = format!(
420266 r#"
421− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
422− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
267+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
268+ DROP FUNCTION IF EXISTS "{trigger_name}";
423269 "#,
270+ table = self.table,
424271 trigger_name = self.trigger_name(ctx),
425− reverse_trigger_name = self.reverse_trigger_name(ctx),
426272 );
427273 db.run(&query).context("failed to drop up trigger")?;
428274
src/migrations/add_foreign_key.rsdeleted−122
@@ -1,122 +0,0 @@
1−use super::{common::ForeignKey, Action, MigrationContext};
2−use crate::{
3− db::{Conn, Transaction},
4− schema::Schema,
5−};
6−use anyhow::Context;
7−use serde::{Deserialize, Serialize};
8−
9−#[derive(Serialize, Deserialize, Debug)]
10−pub struct AddForeignKey {
11− pub table: String,
12− foreign_key: ForeignKey,
13−}
14−
15−#[typetag::serde(name = "add_foreign_key")]
16−impl Action for AddForeignKey {
17− fn describe(&self) -> String {
18− format!(
19− "Adding foreign key from table \"{}\" to \"{}\"",
20− self.table, self.foreign_key.referenced_table
21− )
22− }
23−
24− fn run(
25− &self,
26− ctx: &MigrationContext,
27− db: &mut dyn Conn,
28− schema: &Schema,
29− ) -> anyhow::Result<()> {
30− let table = schema.get_table(db, &self.table)?;
31− let referenced_table = schema.get_table(db, &self.foreign_key.referenced_table)?;
32−
33− // Add quotes around all column names
34− let columns: Vec<String> = table
35− .real_column_names(&self.foreign_key.columns)
36− .map(|col| format!("\"{}\"", col))
37− .collect();
38− let referenced_columns: Vec<String> = referenced_table
39− .real_column_names(&self.foreign_key.referenced_columns)
40− .map(|col| format!("\"{}\"", col))
41− .collect();
42−
43− // Create foreign key but set is as NOT VALID.
44− // This means the foreign key will be enforced for inserts and updates
45− // but the existing data won't be checked, that would cause a long-lived lock.
46− db.run(&format!(
47− r#"
48− ALTER TABLE "{table}"
49− ADD CONSTRAINT {constraint_name}
50− FOREIGN KEY ({columns})
51− REFERENCES "{referenced_table}" ({referenced_columns})
52− NOT VALID
53− "#,
54− table = table.real_name,
55− constraint_name = self.temp_constraint_name(ctx),
56− columns = columns.join(", "),
57− referenced_table = referenced_table.real_name,
58− referenced_columns = referenced_columns.join(", "),
59− ))
60− .context("failed to create foreign key")?;
61−
62− db.run(&format!(
63− r#"
64− ALTER TABLE "{table}"
65− VALIDATE CONSTRAINT "{constraint_name}"
66− "#,
67− table = table.real_name,
68− constraint_name = self.temp_constraint_name(ctx),
69− ))
70− .context("failed to validate foreign key")?;
71−
72− Ok(())
73− }
74−
75− fn complete<'a>(
76− &self,
77− ctx: &MigrationContext,
78− db: &'a mut dyn Conn,
79− ) -> anyhow::Result<Option<Transaction<'a>>> {
80− db.run(&format!(
81− r#"
82− ALTER TABLE {table}
83− RENAME CONSTRAINT {temp_constraint_name} TO {constraint_name}
84− "#,
85− table = self.table,
86− temp_constraint_name = self.temp_constraint_name(ctx),
87− constraint_name = self.final_constraint_name(),
88− ))
89− .context("failed to rename temporary constraint")?;
90− Ok(None)
91− }
92−
93− fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
94−
95− fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
96− db.run(&format!(
97− r#"
98− ALTER TABLE "{table}"
99− DROP CONSTRAINT IF EXISTS "{constraint_name}"
100− "#,
101− table = self.table,
102− constraint_name = self.temp_constraint_name(ctx),
103− ))
104− .context("failed to validate foreign key")?;
105−
106− Ok(())
107− }
108−}
109−
110−impl AddForeignKey {
111− fn temp_constraint_name(&self, ctx: &MigrationContext) -> String {
112− format!("{}_temp_fkey", ctx.prefix())
113− }
114−
115− fn final_constraint_name(&self) -> String {
116− format!(
117− "{table}_{columns}_fkey",
118− table = self.table,
119− columns = self.foreign_key.columns.join("_")
120− )
121− }
122−}
src/migrations/alter_column.rs+16−17
@@ -48,7 +48,9 @@ impl Action for AlterColumn {
4848 let table = schema.get_table(db, &self.table)?;
4949
5050 let column = table
51− .get_column(&self.column)
51+ .columns
52+ .iter()
53+ .find(|column| column.name == self.column)
5254 .ok_or_else(|| anyhow!("no such column {} exists", self.column))?;
5355
5456 let temporary_column_name = self.temporary_column_name(ctx);
@@ -103,7 +105,7 @@ impl Action for AlterColumn {
103105 CREATE OR REPLACE FUNCTION {up_trigger}()
104106 RETURNS TRIGGER AS $$
105107 BEGIN
106− IF NOT reshape.is_new_schema() THEN
108+ IF reshape.is_old_schema() THEN
107109 DECLARE
108110 {declarations}
109111 {existing_column} public.{table}.{existing_column_real}%TYPE := NEW.{existing_column_real};
@@ -121,7 +123,7 @@ impl Action for AlterColumn {
121123 CREATE OR REPLACE FUNCTION {down_trigger}()
122124 RETURNS TRIGGER AS $$
123125 BEGIN
124− IF reshape.is_new_schema() THEN
126+ IF NOT reshape.is_old_schema() THEN
125127 DECLARE
126128 {declarations}
127129 {existing_column} public.{table}.{temp_column}%TYPE := NEW.{temp_column};
@@ -150,13 +152,13 @@ impl Action for AlterColumn {
150152 .context("failed to create up and down triggers")?;
151153
152154 // Backfill values in batches by touching the previous column
153− common::batch_touch_rows(db, &table.real_name, Some(&column.real_name))
155+ common::batch_touch_rows(db, &table.real_name, &column.real_name)
154156 .context("failed to batch update existing rows")?;
155157
156158 // Duplicate any indices to the temporary column
157159 let indices = common::get_indices_for_column(db, &table.real_name, &column.real_name)?;
158− for index in indices {
159− let index_columns: Vec<String> = common::get_index_columns(db, &index.name)?
160+ for (index_name, index_oid) in indices {
161+ let index_columns: Vec<String> = common::get_index_columns(db, &index_name)?
160162 .into_iter()
161163 .map(|idx_column| {
162164 // Replace column with temporary column for new index
@@ -167,18 +169,15 @@ impl Action for AlterColumn {
167169 }
168170 })
169171 .collect();
170− let temp_index_name = self.temp_index_name(ctx, index.oid);
171−
172− let unique_def = if index.unique { "UNIQUE" } else { "" };
172+ let temp_index_name = self.temp_index_name(ctx, index_oid);
173173
174174 db.query(&format!(
175175 r#"
176− CREATE {unique_def} INDEX CONCURRENTLY IF NOT EXISTS "{new_index_name}" ON "{table}" USING {index_type} ({columns})
176+ CREATE INDEX CONCURRENTLY IF NOT EXISTS "{new_index_name}" ON "{table}" ({columns})
177177 "#,
178178 new_index_name = temp_index_name,
179179 table = table.real_name,
180180 columns = index_columns.join(", "),
181− index_type = index.index_type,
182181 ))
183182 .context("failed to create temporary index")?;
184183 }
@@ -187,7 +186,7 @@ impl Action for AlterColumn {
187186 // This constraint is set as NOT VALID so it doesn't apply to existing rows and
188187 // the existing rows don't need to be scanned under an exclusive lock.
189188 // Thanks to this, we can set the full column as NOT NULL later with minimal locking.
190− if !self.changes.nullable.unwrap_or(column.nullable) {
189+ if !column.nullable {
191190 let query = format!(
192191 r#"
193192 ALTER TABLE "{table}"
@@ -281,7 +280,7 @@ impl Action for AlterColumn {
281280
282281 // Replace old indices with the new temporary ones created for the temporary column
283282 let indices = common::get_indices_for_column(db, &self.table, &self.column)?;
284− for current_index in indices {
283+ for (current_index_name, index_oid) in indices {
285284 // To keep the index handling idempotent, we need to do the following:
286285 // 1. Add a prefix to the existing index
287286 // 2. Rename temporary index to its final name
@@ -289,7 +288,7 @@ impl Action for AlterColumn {
289288
290289 // Add prefix (if not already added) to existing index
291290 let prefix = "__reshape_old";
292− let target_index_name = current_index.name.trim_start_matches(prefix);
291+ let target_index_name = current_index_name.trim_start_matches(prefix);
293292 let old_index_name = format!("{}_{}", prefix, target_index_name);
294293 db.query(&format!(
295294 r#"
@@ -301,7 +300,7 @@ impl Action for AlterColumn {
301300 .context("failed to rename old index")?;
302301
303302 // Rename temporary index to real name
304− let temp_index_name = self.temp_index_name(ctx, current_index.oid);
303+ let temp_index_name = self.temp_index_name(ctx, index_oid);
305304 db.query(&format!(
306305 r#"
307306 ALTER INDEX IF EXISTS "{temp_index_name}" RENAME TO "{target_index_name}"
@@ -389,8 +388,8 @@ impl Action for AlterColumn {
389388 // Safely remove any indices created for the temporary column
390389 let temp_column_name = self.temporary_column_name(ctx);
391390 let indices = common::get_indices_for_column(db, &self.table, &temp_column_name)?;
392− for index in indices {
393− let temp_index_name = self.temp_index_name(ctx, index.oid);
391+ for (_, index_oid) in indices {
392+ let temp_index_name = self.temp_index_name(ctx, index_oid);
394393 db.query(&format!(
395394 r#"
396395 DROP INDEX CONCURRENTLY IF EXISTS "{index_name}"
src/migrations/common.rs+26−42
@@ -1,17 +1,26 @@
11use anyhow::anyhow;
2+use derive_builder::Builder;
23use postgres::types::{FromSql, ToSql};
34use serde::{Deserialize, Serialize};
45
56use crate::db::Conn;
67
7−#[derive(Serialize, Deserialize, Clone, Debug)]
8+#[derive(Serialize, Deserialize, Builder, Clone, Debug)]
9+#[builder(setter(into))]
810pub struct Column {
911 pub name: String,
12+
1013 #[serde(rename = "type")]
1114 pub data_type: String,
15+
1216 #[serde(default = "nullable_default")]
17+ #[builder(default = "true")]
1318 pub nullable: bool,
19+
20+ #[builder(setter(name = "default_value", strip_option), default)]
1421 pub default: Option<String>,
22+
23+ #[builder(setter(strip_option), default)]
1524 pub generated: Option<String>,
1625}
1726
@@ -19,13 +28,6 @@ fn nullable_default() -> bool {
1928 true
2029}
2130
22−#[derive(Serialize, Deserialize, Clone, Debug)]
23−pub struct ForeignKey {
24− pub columns: Vec<String>,
25− pub referenced_table: String,
26− pub referenced_columns: Vec<String>,
27−}
28−
2931#[derive(Debug)]
3032struct PostgresRawValue {
3133 bytes: Vec<u8>,
@@ -69,26 +71,17 @@ impl ToSql for PostgresRawValue {
6971 postgres::types::to_sql_checked!();
7072}
7173
72−pub fn batch_touch_rows(
73− db: &mut dyn Conn,
74− table: &str,
75− column: Option<&str>,
76−) -> anyhow::Result<()> {
74+pub fn batch_touch_rows(db: &mut dyn Conn, table: &str, column: &str) -> anyhow::Result<()> {
7775 const BATCH_SIZE: u16 = 1000;
7876
77+ db.query("SET reshape.is_old_schema = 'YES'")?;
78+
7979 let mut cursor: Option<PostgresRawValue> = None;
8080
8181 loop {
8282 let mut params: Vec<&(dyn ToSql + Sync)> = Vec::new();
8383
8484 let primary_key = get_primary_key_columns_for_table(db, table)?;
85−
86− // If no column to touch is passed, we default to the first primary key column (just to make some "update")
87− let touched_column = match column {
88− Some(column) => column,
89− None => primary_key.first().unwrap(),
90− };
91−
9285 let primary_key_columns = primary_key.join(", ");
9386
9487 let primary_key_where = primary_key
@@ -131,8 +124,8 @@ pub fn batch_touch_rows(
131124 ORDER BY {primary_key_columns}
132125 LIMIT {batch_size}
133126 ), update AS (
134− UPDATE public."{table}" "{table}"
135− SET "{touched_column}" = "{table}"."{touched_column}"
127+ UPDATE public."{table}"
128+ SET "{column}" = "{column}"
136129 FROM rows
137130 WHERE {primary_key_where}
138131 RETURNING {returning_columns}
@@ -141,7 +134,13 @@ pub fn batch_touch_rows(
141134 FROM update
142135 LIMIT 1
143136 "#,
137+ table = table,
138+ primary_key_columns = primary_key_columns,
139+ cursor_where = cursor_where,
144140 batch_size = BATCH_SIZE,
141+ column = column,
142+ primary_key_where = primary_key_where,
143+ returning_columns = returning_columns,
145144 );
146145 let last_value = db
147146 .query_with_params(&query, &params)?
@@ -155,6 +154,8 @@ pub fn batch_touch_rows(
155154 cursor = last_value
156155 }
157156
157+ db.query("SET reshape.is_old_schema = ''")?;
158+
158159 Ok(())
159160}
160161
@@ -181,30 +182,18 @@ fn get_primary_key_columns_for_table(
181182 Ok(primary_key_columns)
182183}
183184
184−pub struct Index {
185− pub name: String,
186− pub oid: u32,
187− pub unique: bool,
188− pub index_type: String,
189−}
190−
191185pub fn get_indices_for_column(
192186 db: &mut dyn Conn,
193187 table: &str,
194188 column: &str,
195−) -> anyhow::Result<Vec<Index>> {
189+) -> anyhow::Result<Vec<(String, u32)>> {
196190 let indices = db
197191 .query(&format!(
198192 "
199− SELECT
200− i.relname AS name,
201− i.oid AS oid,
202− ix.indisunique AS unique,
203− am.amname AS type
193+ SELECT i.relname AS index_name, i.oid AS index_oid
204194 FROM pg_index ix
205195 JOIN pg_class t ON t.oid = ix.indrelid
206196 JOIN pg_class i ON i.oid = ix.indexrelid
207− JOIN pg_am am ON i.relam = am.oid
208197 JOIN pg_attribute a ON
209198 a.attrelid = t.oid AND
210199 a.attnum = ANY(ix.indkey)
@@ -216,12 +205,7 @@ pub fn get_indices_for_column(
216205 column = column,
217206 ))?
218207 .iter()
219− .map(|row| Index {
220− name: row.get("name"),
221− oid: row.get("oid"),
222− unique: row.get("unique"),
223− index_type: row.get("type"),
224− })
208+ .map(|row| (row.get("index_name"), row.get("index_oid")))
225209 .collect();
226210
227211 Ok(indices)
src/migrations/create_enum.rsdeleted−83
@@ -1,83 +0,0 @@
1−use super::{Action, MigrationContext};
2−use crate::{
3− db::{Conn, Transaction},
4− schema::Schema,
5−};
6−use anyhow::Context;
7−use serde::{Deserialize, Serialize};
8−
9−#[derive(Serialize, Deserialize, Debug)]
10−pub struct CreateEnum {
11− pub name: String,
12− pub values: Vec<String>,
13−}
14−
15−#[typetag::serde(name = "create_enum")]
16−impl Action for CreateEnum {
17− fn describe(&self) -> String {
18− format!("Creating enum \"{}\"", self.name)
19− }
20−
21− fn run(
22− &self,
23− _ctx: &MigrationContext,
24− db: &mut dyn Conn,
25− _schema: &Schema,
26− ) -> anyhow::Result<()> {
27− // Check if enum already exists. CREATE TYPE doesn't have
28− // a IF NOT EXISTS option so we have to do it manually.
29− let enum_exists = !db
30− .query(&format!(
31− "
32− SELECT typname
33− FROM pg_catalog.pg_type
34− WHERE typcategory = 'E'
35− AND typname = '{name}'
36− ",
37− name = self.name,
38− ))?
39− .is_empty();
40− if enum_exists {
41− return Ok(());
42− }
43−
44− let values_def: Vec<String> = self
45− .values
46− .iter()
47− .map(|value| format!("'{}'", value))
48− .collect();
49−
50− db.run(&format!(
51− r#"
52− CREATE TYPE "{name}" AS ENUM ({values})
53− "#,
54− name = self.name,
55− values = values_def.join(", "),
56− ))
57− .context("failed to create enum")?;
58−
59− Ok(())
60− }
61−
62− fn complete<'a>(
63− &self,
64− _ctx: &MigrationContext,
65− _db: &'a mut dyn Conn,
66− ) -> anyhow::Result<Option<Transaction<'a>>> {
67− Ok(None)
68− }
69−
70− fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
71−
72− fn abort(&self, _ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
73− db.run(&format!(
74− r#"
75− DROP TYPE IF EXISTS {name}
76− "#,
77− name = self.name,
78− ))
79− .context("failed to drop enum")?;
80−
81− Ok(())
82− }
83−}
src/migrations/create_table.rs+24−128
@@ -1,37 +1,29 @@
1−use std::collections::HashMap;
2−
3−use super::{common::ForeignKey, Action, Column, MigrationContext};
1+use super::{Action, Column, MigrationContext};
42use crate::{
53 db::{Conn, Transaction},
6− migrations::common,
74 schema::Schema,
85};
96use anyhow::Context;
7+use derive_builder::Builder;
108use serde::{Deserialize, Serialize};
119
12−#[derive(Serialize, Deserialize, Debug)]
10+#[derive(Serialize, Deserialize, Builder, Debug)]
11+#[builder(setter(into))]
1312pub struct CreateTable {
1413 pub name: String,
1514 pub columns: Vec<Column>,
1615 pub primary_key: Vec<String>,
1716
1817 #[serde(default)]
18+ #[builder(default)]
1919 pub foreign_keys: Vec<ForeignKey>,
20−
21− pub up: Option<Transformation>,
2220}
2321
24−#[derive(Serialize, Deserialize, Debug)]
25−pub struct Transformation {
26− table: String,
27− values: HashMap<String, String>,
28− upsert_constraint: Option<String>,
29−}
30−
31−impl CreateTable {
32− fn trigger_name(&self, ctx: &MigrationContext) -> String {
33− format!("{}_create_table_{}", ctx.prefix(), self.name)
34− }
22+#[derive(Serialize, Deserialize, Clone, Debug)]
23+pub struct ForeignKey {
24+ pub columns: Vec<String>,
25+ pub referenced_table: String,
26+ pub referenced_columns: Vec<String>,
3527}
3628
3729#[typetag::serde(name = "create_table")]
@@ -42,9 +34,9 @@ impl Action for CreateTable {
4234
4335 fn run(
4436 &self,
45− ctx: &MigrationContext,
37+ _ctx: &MigrationContext,
4638 db: &mut dyn Conn,
47− schema: &Schema,
39+ _schema: &Schema,
4840 ) -> anyhow::Result<()> {
4941 let mut definition_rows: Vec<String> = self
5042 .columns
@@ -86,10 +78,9 @@ impl Action for CreateTable {
8678 .iter()
8779 .map(|col| format!("\"{}\"", col))
8880 .collect();
89−
90− let referenced_table = schema.get_table(db, &foreign_key.referenced_table)?;
91− let referenced_columns: Vec<String> = referenced_table
92− .real_column_names(&foreign_key.referenced_columns)
81+ let referenced_columns: Vec<String> = foreign_key
82+ .referenced_columns
83+ .iter()
9384 .map(|col| format!("\"{}\"", col))
9485 .collect();
9586
@@ -98,12 +89,12 @@ impl Action for CreateTable {
9889 FOREIGN KEY ({columns}) REFERENCES "{table}" ({referenced_columns})
9990 "#,
10091 columns = columns.join(", "),
101− table = referenced_table.real_name,
92+ table = foreign_key.referenced_table,
10293 referenced_columns = referenced_columns.join(", "),
10394 ));
10495 }
10596
106− let query = &format!(
97+ db.run(&format!(
10798 r#"
10899 CREATE TABLE "{name}" (
109100 {definition}
@@ -111,121 +102,26 @@ impl Action for CreateTable {
111102 "#,
112103 name = self.name,
113104 definition = definition_rows.join(",\n"),
114− );
115− db.run(query).context("failed to create table")?;
116−
117− if let Some(Transformation {
118− table: from_table,
119− values,
120− upsert_constraint,
121− }) = &self.up
122− {
123− let from_table = schema.get_table(db, &from_table)?;
124−
125− let declarations: Vec<String> = from_table
126− .columns
127− .iter()
128− .map(|column| {
129− format!(
130− "{alias} public.{table}.{real_name}%TYPE := NEW.{real_name};",
131− table = from_table.real_name,
132− alias = column.name,
133− real_name = column.real_name,
134− )
135− })
136− .collect();
137−
138− let (insert_columns, insert_values): (Vec<&str>, Vec<&str>) = values
139− .iter()
140− .map(|(k, v)| -> (&str, &str) { (k, v) }) // Force &String to &str
141− .unzip();
142−
143− let update_set: Vec<String> = values
144− .iter()
145− .map(|(field, value)| format!("\"{field}\" = {value}"))
146− .collect();
147−
148− // Constraint to check for conflicts. Defaults to the primary key constraint.
149− let conflict_constraint_name = match upsert_constraint {
150− Some(custom_constraint) => custom_constraint.clone(),
151− _ => format!("{table}_pkey", table = self.name),
152− };
153−
154− // Add triggers to fill in values as they are inserted/updated
155− let query = format!(
156− r#"
157− CREATE OR REPLACE FUNCTION {trigger_name}()
158− RETURNS TRIGGER AS $$
159− #variable_conflict use_variable
160− BEGIN
161− IF NOT reshape.is_new_schema() THEN
162− DECLARE
163− {declarations}
164− BEGIN
165− INSERT INTO public."{changed_table_real}" ({columns})
166− VALUES ({values})
167− ON CONFLICT ON CONSTRAINT "{conflict_constraint_name}"
168− DO UPDATE SET
169− {updates};
170− END;
171− END IF;
172− RETURN NEW;
173− END
174− $$ language 'plpgsql';
175−
176− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{from_table_real}";
177− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{from_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
178− "#,
179− changed_table_real = self.name,
180− from_table_real = from_table.real_name,
181− trigger_name = self.trigger_name(ctx),
182− declarations = declarations.join("\n"),
183− columns = insert_columns.join(", "),
184− values = insert_values.join(", "),
185− updates = update_set.join(",\n"),
186− );
187− db.run(&query).context("failed to create up trigger")?;
188−
189− // Backfill values in batches by touching the from table
190− common::batch_touch_rows(db, &from_table.real_name, None)
191− .context("failed to batch update existing rows")?;
192− }
193−
105+ ))
106+ .context("failed to create table")?;
194107 Ok(())
195108 }
196109
197110 fn complete<'a>(
198111 &self,
199− ctx: &MigrationContext,
200− db: &'a mut dyn Conn,
112+ _ctx: &MigrationContext,
113+ _db: &'a mut dyn Conn,
201114 ) -> anyhow::Result<Option<Transaction<'a>>> {
202− // Remove triggers and procedures
203− let query = format!(
204− r#"
205− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
206− "#,
207− trigger_name = self.trigger_name(ctx),
208− );
209− db.run(&query).context("failed to drop up trigger")?;
210−
115+ // Do nothing
211116 Ok(None)
212117 }
213118
214119 fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
215120
216− fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
217− // Remove triggers and procedures
218− let query = format!(
219− r#"
220− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
221− "#,
222− trigger_name = self.trigger_name(ctx),
223− );
224− db.run(&query).context("failed to drop up trigger")?;
225−
121+ fn abort(&self, _ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
226122 db.run(&format!(
227123 r#"
228− DROP TABLE IF EXISTS "{name}"
124+ DROP TABLE IF EXISTS {name}
229125 "#,
230126 name = self.name,
231127 ))
src/migrations/custom.rsdeleted−61
@@ -1,61 +0,0 @@
1−use super::{Action, MigrationContext};
2−use crate::{
3− db::{Conn, Transaction},
4− schema::Schema,
5−};
6−use serde::{Deserialize, Serialize};
7−
8−#[derive(Serialize, Deserialize, Debug)]
9−pub struct Custom {
10− #[serde(default)]
11− pub start: Option<String>,
12−
13− #[serde(default)]
14− pub complete: Option<String>,
15−
16− #[serde(default)]
17− pub abort: Option<String>,
18−}
19−
20−#[typetag::serde(name = "custom")]
21−impl Action for Custom {
22− fn describe(&self) -> String {
23− "Running custom migration".to_string()
24− }
25−
26− fn run(
27− &self,
28− _ctx: &MigrationContext,
29− db: &mut dyn Conn,
30− _schema: &Schema,
31− ) -> anyhow::Result<()> {
32− if let Some(start_query) = &self.start {
33− println!("Running query: {}", start_query);
34− db.run(start_query)?;
35− }
36−
37− Ok(())
38− }
39−
40− fn complete<'a>(
41− &self,
42− _ctx: &MigrationContext,
43− db: &'a mut dyn Conn,
44− ) -> anyhow::Result<Option<Transaction<'a>>> {
45− if let Some(complete_query) = &self.complete {
46− db.run(complete_query)?;
47− }
48−
49− Ok(None)
50− }
51−
52− fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
53−
54− fn abort(&self, _ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
55− if let Some(abort_query) = &self.abort {
56− db.run(abort_query)?;
57− }
58−
59− Ok(())
60− }
61−}
src/migrations/mod.rs+3−24
@@ -7,10 +7,10 @@ use serde::{Deserialize, Serialize};
77
88// Re-export migration types
99mod common;
10−pub use common::Column;
10+pub use common::{Column, ColumnBuilder};
1111
1212mod create_table;
13−pub use create_table::CreateTable;
13+pub use create_table::{CreateTable, CreateTableBuilder, ForeignKey};
1414
1515mod alter_column;
1616pub use alter_column::{AlterColumn, ColumnChanges};
@@ -33,21 +33,6 @@ pub use remove_table::RemoveTable;
3333mod rename_table;
3434pub use rename_table::RenameTable;
3535
36−mod create_enum;
37−pub use create_enum::CreateEnum;
38−
39−mod remove_enum;
40−pub use remove_enum::RemoveEnum;
41−
42−mod custom;
43−pub use custom::Custom;
44−
45−mod add_foreign_key;
46−pub use add_foreign_key::AddForeignKey;
47−
48−mod remove_foreign_key;
49−pub use remove_foreign_key::RemoveForeignKey;
50−
5136#[derive(Serialize, Deserialize, Debug)]
5237pub struct Migration {
5338 pub name: String,
@@ -88,19 +73,13 @@ impl Clone for Migration {
8873pub struct MigrationContext {
8974 migration_index: usize,
9075 action_index: usize,
91− existing_schema_name: Option<String>,
9276}
9377
9478impl MigrationContext {
95− pub fn new(
96− migration_index: usize,
97− action_index: usize,
98− existing_schema_name: Option<String>,
99− ) -> Self {
79+ pub fn new(migration_index: usize, action_index: usize) -> Self {
10080 MigrationContext {
10181 migration_index,
10282 action_index,
103− existing_schema_name,
10483 }
10584 }
10685
src/migrations/remove_column.rs+35−353
@@ -1,27 +1,16 @@
1−use super::{common, Action, MigrationContext};
1+use super::{Action, MigrationContext};
22use crate::{
33 db::{Conn, Transaction},
44 schema::Schema,
55};
6−use anyhow::{anyhow, bail, Context};
6+use anyhow::Context;
77use serde::{Deserialize, Serialize};
88
99#[derive(Serialize, Deserialize, Debug)]
1010pub struct RemoveColumn {
1111 pub table: String,
1212 pub column: String,
13− pub down: Option<Transformation>,
14−}
15−
16−#[derive(Serialize, Deserialize, Debug)]
17−#[serde(untagged)]
18−pub enum Transformation {
19− Simple(String),
20− Update {
21− table: String,
22− value: String,
23− r#where: String,
24− },
13+ pub down: Option<String>,
2514}
2615
2716impl RemoveColumn {
@@ -33,33 +22,6 @@ impl RemoveColumn {
3322 self.column
3423 )
3524 }
36−
37− fn reverse_trigger_name(&self, ctx: &MigrationContext) -> String {
38− format!(
39− "{}_remove_column_{}_{}_rev",
40− ctx.prefix(),
41− self.table,
42− self.column
43− )
44− }
45−
46− fn not_null_constraint_trigger_name(&self, ctx: &MigrationContext) -> String {
47− format!(
48− "{}_remove_column_{}_{}_nn",
49− ctx.prefix(),
50− self.table,
51− self.column
52− )
53− }
54−
55− fn not_null_constraint_name(&self, ctx: &MigrationContext) -> String {
56− format!(
57− "{}_add_column_not_null_{}_{}",
58− ctx.prefix(),
59− self.table,
60− self.column
61− )
62− }
6325}
6426
6527#[typetag::serde(name = "remove_column")]
@@ -77,13 +39,10 @@ impl Action for RemoveColumn {
7739 db: &mut dyn Conn,
7840 schema: &Schema,
7941 ) -> anyhow::Result<()> {
80− let table = schema.get_table(db, &self.table)?;
81− let column = table
82− .get_column(&self.column)
83− .ok_or_else(|| anyhow!("no such column {} exists", self.column))?;
84−
8542 // Add down trigger
8643 if let Some(down) = &self.down {
44+ let table = schema.get_table(db, &self.table)?;
45+
8746 let declarations: Vec<String> = table
8847 .columns
8948 .iter()
@@ -97,226 +56,32 @@ impl Action for RemoveColumn {
9756 })
9857 .collect();
9958
100− if let Transformation::Simple(down) = down {
101− let query = format!(
102− r#"
103− CREATE OR REPLACE FUNCTION {trigger_name}()
104− RETURNS TRIGGER AS $$
105− BEGIN
106− IF reshape.is_new_schema() THEN
107− DECLARE
108− {declarations}
109− BEGIN
110− NEW.{column_name} = {down};
111− END;
112− END IF;
113− RETURN NEW;
114− END
115− $$ language 'plpgsql';
116−
117− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
118− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
119− "#,
120− column_name = self.column,
121− trigger_name = self.trigger_name(ctx),
122− down = down,
123− table = self.table,
124− declarations = declarations.join("\n"),
125− );
126− db.run(&query).context("failed to create down trigger")?;
127− }
128−
129− if let Transformation::Update {
130− table: from_table,
131− value,
132− r#where,
133− } = down
134− {
135− let existing_schema_name = match &ctx.existing_schema_name {
136− Some(name) => name,
137− None => bail!("can't use update without previous migration"),
138− };
139−
140− let from_table = schema.get_table(db, &from_table)?;
141−
142− let maybe_null_check = if !column.nullable {
143− // Replace NOT NULL constraint with a constraint trigger that only triggers on the old schema.
144− // We will add a null check to the down function on the new schema below as well to cover both cases.
145− // As we are using a complex down function, we must remove the NOT NULL check for the new schema.
146− // NOT NULL is not checked at the end of a transaction, but immediately upon update.
147− let query = format!(
148− r#"
149− CREATE OR REPLACE FUNCTION {trigger_name}()
150− RETURNS TRIGGER AS $$
59+ let query = format!(
60+ r#"
61+ CREATE OR REPLACE FUNCTION {trigger_name}()
62+ RETURNS TRIGGER AS $$
63+ BEGIN
64+ IF NOT reshape.is_old_schema() IS NULL THEN
65+ DECLARE
66+ {declarations}
15167 BEGIN
152− IF NOT reshape.is_new_schema() THEN
153− IF NEW.{column} IS NULL THEN
154− RAISE EXCEPTION '{column} can not be null';
155− END IF;
156− END IF;
157− RETURN NEW;
158− END
159− $$ language 'plpgsql';
160−
161− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
162−
163− CREATE CONSTRAINT TRIGGER "{trigger_name}"
164− AFTER INSERT OR UPDATE
165− ON "{table}"
166− FOR EACH ROW
167− EXECUTE PROCEDURE {trigger_name}();
168− "#,
169− table = self.table,
170− trigger_name = self.not_null_constraint_trigger_name(ctx),
171− column = self.column,
172− );
173− db.run(&query)
174− .context("failed to create null constraint trigger")?;
175−
176− db.run(&format!(
177− r#"
178− ALTER TABLE {table}
179− ALTER COLUMN {column}
180− DROP NOT NULL
181− "#,
182− table = self.table,
183− column = self.column
184− ))
185− .context("failed to remove column not null constraint")?;
186−
187− format!(
188− r#"
189− IF {value} IS NULL THEN
190− RAISE EXCEPTION '{column_name} can not be null';
191− END IF;
192− "#,
193− column_name = self.column,
194− )
195− } else {
196− "".to_string()
197− };
198−
199− let into_variables = from_table
200− .columns
201− .iter()
202− .map(|column| {
203− format!(
204− "NEW.{real_name} AS {alias}",
205− alias = column.name,
206− real_name = column.real_name,
207− )
208− })
209− .collect::<Vec<String>>()
210− .join(", ");
211−
212− let query = format!(
213− r#"
214− CREATE OR REPLACE FUNCTION {trigger_name}()
215− RETURNS TRIGGER AS $$
216− #variable_conflict use_variable
217− BEGIN
218− IF reshape.is_new_schema() THEN
219− DECLARE
220− {from_table} record;
221− BEGIN
222− SELECT {into_variables}
223− INTO {from_table};
224−
225− {maybe_null_check}
226−
227− -- Don't trigger reverse trigger when making this update
228− perform set_config('reshape.disable_triggers', 'TRUE', TRUE);
229−
230− UPDATE "migration_{existing_schema_name}"."{changed_table}" "{changed_table}"
231− SET "{column_name}" = {value}
232− WHERE {where};
233−
234− perform set_config('reshape.disable_triggers', '', TRUE);
235− END;
236− END IF;
237− RETURN NEW;
238− END
239− $$ language 'plpgsql';
240−
241− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{from_table_real}";
242− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{from_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
243− "#,
244− changed_table = self.table,
245− from_table = from_table.name,
246− from_table_real = from_table.real_name,
247− column_name = self.column,
248− trigger_name = self.trigger_name(ctx),
249− );
250− db.run(&query).context("failed to create down trigger")?;
251−
252− let changed_into_variables = table
253− .columns
254− .iter()
255− .map(|column| {
256− format!(
257− "NEW.{real_name} AS {alias}",
258− alias = column.name,
259− real_name = column.real_name,
260− )
261− })
262− .collect::<Vec<String>>()
263− .join(", ");
264−
265− let from_table_columns = from_table
266− .columns
267− .iter()
268− .map(|column| format!("{} as {}", column.real_name, column.name))
269− .collect::<Vec<String>>()
270− .join(", ");
271−
272− let query = format!(
273− r#"
274− CREATE OR REPLACE FUNCTION {trigger_name}()
275− RETURNS TRIGGER AS $$
276− #variable_conflict use_variable
277− BEGIN
278− IF reshape.is_new_schema() AND NOT current_setting('reshape.disable_triggers', TRUE) = 'TRUE' THEN
279− DECLARE
280− {changed_table} record;
281− __temp_row record;
282− BEGIN
283− SELECT {changed_into_variables}
284− INTO {changed_table};
285−
286− SELECT *
287− INTO __temp_row
288− FROM (
289− SELECT {from_table_columns}
290− FROM public.{from_table_real}
291− ) {from_table}
292− WHERE {where};
293−
294− DECLARE
295− {from_table} record;
296− BEGIN
297− {from_table} := __temp_row;
298− NEW.{column_name_real} = {value};
299− END;
300− END;
301− END IF;
302− RETURN NEW;
303− END
304− $$ language 'plpgsql';
305−
306− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{changed_table_real}";
307− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{changed_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
308− "#,
309− changed_table = table.name,
310− changed_table_real = table.real_name,
311− from_table = from_table.name,
312− from_table_real = from_table.real_name,
313− column_name_real = column.real_name,
314− trigger_name = self.reverse_trigger_name(ctx),
315− // declarations = declarations.join("\n"),
316− );
317− db.run(&query)
318− .context("failed to create reverse down trigger")?;
319− }
68+ NEW.{column_name} = {down};
69+ END;
70+ END IF;
71+ RETURN NEW;
72+ END
73+ $$ language 'plpgsql';
74+
75+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
76+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
77+ "#,
78+ column_name = self.column,
79+ trigger_name = self.trigger_name(ctx),
80+ down = down,
81+ table = self.table,
82+ declarations = declarations.join("\n"),
83+ );
84+ db.run(&query).context("failed to create down trigger")?;
32085 }
32186
32287 Ok(())
@@ -327,34 +92,18 @@ impl Action for RemoveColumn {
32792 ctx: &MigrationContext,
32893 db: &'a mut dyn Conn,
32994 ) -> anyhow::Result<Option<Transaction<'a>>> {
330− let indices = common::get_indices_for_column(db, &self.table, &self.column)
331− .context("failed getting column indices")?;
332−
333− for index in indices {
334− db.run(&format!(
335− "
336− DROP INDEX CONCURRENTLY IF EXISTS {name}
337− ",
338− name = index.name,
339− ))
340− .context("failed to drop index")?;
341− }
342−
34395 // Remove column, function and trigger
34496 let query = format!(
34597 r#"
34698 ALTER TABLE "{table}"
34799 DROP COLUMN IF EXISTS "{column}";
348100
349− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
350− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
351− DROP FUNCTION IF EXISTS "{null_trigger_name}" CASCADE;
101+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
102+ DROP FUNCTION IF EXISTS "{trigger_name}";
352103 "#,
353104 table = self.table,
354105 column = self.column,
355106 trigger_name = self.trigger_name(ctx),
356− reverse_trigger_name = self.reverse_trigger_name(ctx),
357− null_trigger_name = self.not_null_constraint_trigger_name(ctx),
358107 );
359108 db.run(&query)
360109 .context("failed to drop column and down trigger")?;
@@ -371,81 +120,14 @@ impl Action for RemoveColumn {
371120 }
372121
373122 fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
374− // We might have temporaily removed the NOT NULL check and have to reinstate it
375− let has_not_null_function = !db
376− .query_with_params(
377− "
378− SELECT routine_name
379− FROM information_schema.routines
380− WHERE routine_schema = 'public'
381− AND routine_name = $1
382− ",
383− &[&self.not_null_constraint_trigger_name(ctx)],
384− )
385− .context("failed to get any NOT NULL function")?
386− .is_empty();
387−
388− if has_not_null_function {
389− // Make column NOT NULL again without taking any long lived locks with a temporary constraint
390− let query = format!(
391− r#"
392− ALTER TABLE "{table}"
393− ADD CONSTRAINT "{constraint_name}"
394− CHECK ("{column}" IS NOT NULL) NOT VALID
395− "#,
396− table = self.table,
397− constraint_name = self.not_null_constraint_name(ctx),
398− column = self.column,
399− );
400− db.run(&query)
401− .context("failed to add NOT NULL constraint")?;
402−
403− let query = format!(
404− r#"
405− ALTER TABLE "{table}"
406− VALIDATE CONSTRAINT "{constraint_name}"
407− "#,
408− table = self.table,
409− constraint_name = self.not_null_constraint_name(ctx),
410− );
411− db.run(&query)
412− .context("failed to validate NOT NULL constraint")?;
413−
414− // This ALTER TABLE call will not require any exclusive locks as it can use the validated constraint from above
415− db.run(&format!(
416− r#"
417− ALTER TABLE {table}
418− ALTER COLUMN {column}
419− SET NOT NULL
420− "#,
421− table = self.table,
422− column = self.column
423− ))
424− .context("failed to reinstate column NOT NULL")?;
425−
426− // Drop the temporary constraint
427− let query = format!(
428− r#"
429− ALTER TABLE "{table}"
430− DROP CONSTRAINT "{constraint_name}"
431− "#,
432− table = self.table,
433− constraint_name = self.not_null_constraint_name(ctx),
434− );
435− db.run(&query)
436− .context("failed to drop NOT NULL constraint")?;
437− }
438−
439123 // Remove function and trigger
440124 db.run(&format!(
441125 r#"
442− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
443− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
444− DROP FUNCTION IF EXISTS "{null_trigger_name}" CASCADE;
126+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
127+ DROP FUNCTION IF EXISTS "{trigger_name}";
445128 "#,
129+ table = self.table,
446130 trigger_name = self.trigger_name(ctx),
447− reverse_trigger_name = self.reverse_trigger_name(ctx),
448− null_trigger_name = self.not_null_constraint_trigger_name(ctx),
449131 ))
450132 .context("failed to drop down trigger")?;
451133
src/migrations/remove_enum.rsdeleted−51
@@ -1,51 +0,0 @@
1−use super::{Action, MigrationContext};
2−use crate::{
3− db::{Conn, Transaction},
4− schema::Schema,
5−};
6−use anyhow::Context;
7−use serde::{Deserialize, Serialize};
8−
9−#[derive(Serialize, Deserialize, Debug)]
10−pub struct RemoveEnum {
11− #[serde(rename = "enum")]
12− pub enum_name: String,
13−}
14−
15−#[typetag::serde(name = "remove_enum")]
16−impl Action for RemoveEnum {
17− fn describe(&self) -> String {
18− format!("Removing enum \"{}\"", self.enum_name)
19− }
20−
21− fn run(
22− &self,
23− _ctx: &MigrationContext,
24− _db: &mut dyn Conn,
25− _schema: &Schema,
26− ) -> anyhow::Result<()> {
27− Ok(())
28− }
29−
30− fn complete<'a>(
31− &self,
32− _ctx: &MigrationContext,
33− db: &'a mut dyn Conn,
34− ) -> anyhow::Result<Option<Transaction<'a>>> {
35− db.run(&format!(
36− r#"
37− DROP TYPE IF EXISTS {name}
38− "#,
39− name = self.enum_name,
40− ))
41− .context("failed to drop enum")?;
42−
43− Ok(None)
44− }
45−
46− fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
47−
48− fn abort(&self, _ctx: &MigrationContext, _db: &mut dyn Conn) -> anyhow::Result<()> {
49− Ok(())
50− }
51−}
src/migrations/remove_foreign_key.rsdeleted−91
@@ -1,91 +0,0 @@
1−use super::{Action, MigrationContext};
2−use crate::{
3− db::{Conn, Transaction},
4− schema::Schema,
5−};
6−use anyhow::{anyhow, Context};
7−use serde::{Deserialize, Serialize};
8−
9−#[derive(Serialize, Deserialize, Debug)]
10−pub struct RemoveForeignKey {
11− table: String,
12− foreign_key: String,
13−}
14−
15−#[typetag::serde(name = "remove_foreign_key")]
16−impl Action for RemoveForeignKey {
17− fn describe(&self) -> String {
18− format!(
19− "Removing foreign key \"{}\" from table \"{}\"",
20− self.foreign_key, self.table
21− )
22− }
23−
24− fn run(
25− &self,
26− _ctx: &MigrationContext,
27− db: &mut dyn Conn,
28− schema: &Schema,
29− ) -> anyhow::Result<()> {
30− // The foreign key is only removed once the migration is completed.
31− // Removing it earlier would be hard/undesirable for several reasons:
32− // - Postgres doesn't have an easy way to temporarily disable a foreign key check.
33− // If it did, we could disable the FK for the new schema.
34− // - Even if we could, it probably wouldn't be a good idea as it would cause temporary
35− // inconsistencies for the old schema which still expects the FK to hold.
36− // - For the same reason, we can't remove the FK when the migration is first applied.
37− // If the migration was to be aborted, then the FK would have to be recreated with
38− // the risk that it would no longer be valid.
39−
40− // Ensure foreign key exists
41− let table = schema.get_table(db, &self.table)?;
42− let fk_exists = !db
43− .query(&format!(
44− r#"
45− SELECT constraint_name
46− FROM information_schema.table_constraints
47− WHERE
48− constraint_type = 'FOREIGN KEY' AND
49− table_name = '{table_name}' AND
50− constraint_name = '{foreign_key}'
51− "#,
52− table_name = table.real_name,
53− foreign_key = self.foreign_key,
54− ))
55− .context("failed to check for foreign key")?
56− .is_empty();
57−
58− if !fk_exists {
59− return Err(anyhow!(
60− "no foreign key \"{}\" exists on table \"{}\"",
61− self.foreign_key,
62− self.table
63− ));
64− }
65−
66− Ok(())
67− }
68−
69− fn complete<'a>(
70− &self,
71− _ctx: &MigrationContext,
72− db: &'a mut dyn Conn,
73− ) -> anyhow::Result<Option<Transaction<'a>>> {
74− db.run(&format!(
75− r#"
76− ALTER TABLE {table}
77− DROP CONSTRAINT IF EXISTS {foreign_key}
78− "#,
79− table = self.table,
80− foreign_key = self.foreign_key,
81− ))
82− .context("failed to remove foreign key")?;
83− Ok(None)
84− }
85−
86− fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
87−
88− fn abort(&self, _ctx: &MigrationContext, _db: &mut dyn Conn) -> anyhow::Result<()> {
89− Ok(())
90− }
91−}
src/schema.rs+1−18
@@ -209,7 +209,7 @@ impl Schema {
209209 let real_columns: Vec<(String, String, bool, Option<String>)> = db
210210 .query(&format!(
211211 "
212− SELECT column_name, CASE WHEN data_type = 'USER-DEFINED' THEN udt_name ELSE data_type END, is_nullable, column_default
212+ SELECT column_name, data_type, is_nullable, column_default
213213 FROM information_schema.columns
214214 WHERE table_name = '{table}' AND table_schema = 'public'
215215 ORDER BY ordinal_position
@@ -286,20 +286,3 @@ impl Schema {
286286 Ok(table)
287287 }
288288}
289−
290−impl Table {
291− pub fn real_column_names<'a>(
292− &'a self,
293− columns: &'a [String],
294− ) -> impl Iterator<Item = &'a String> {
295− columns.iter().map(|name| {
296− self.get_column(name)
297− .map(|col| &col.real_name)
298− .unwrap_or(name)
299− })
300− }
301−
302− pub fn get_column(&self, name: &str) -> Option<&Column> {
303− self.columns.iter().find(|column| column.name == name)
304− }
305−}
tests/add_column.rs+153−225
@@ -1,9 +1,10 @@
1+use reshape::migrations::{AddColumn, Column, ColumnBuilder, CreateTableBuilder, Migration};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn add_column() {
6− let mut test = Test::new("Add column");
7+ let mut test = common::Test::new("Add column");
78
89 test.first_migration(
910 r#"
@@ -113,249 +114,176 @@ fn add_column() {
113114
114115#[test]
115116fn add_column_nullable() {
116− let mut test = Test::new("Add nullable column");
117−
118− test.first_migration(
119− r#"
120− name = "create_users_table"
121−
122− [[actions]]
123− type = "create_table"
124− name = "users"
125− primary_key = ["id"]
126−
127− [[actions.columns]]
128− name = "id"
129− type = "INTEGER"
130− "#,
117+ let (mut reshape, mut old_db, mut new_db) = common::setup();
118+
119+ let create_users_table = Migration::new("create_user_table", None).with_action(
120+ CreateTableBuilder::default()
121+ .name("users")
122+ .primary_key(vec!["id".to_string()])
123+ .columns(vec![ColumnBuilder::default()
124+ .name("id")
125+ .data_type("INTEGER")
126+ .build()
127+ .unwrap()])
128+ .build()
129+ .unwrap(),
131130 );
131+ let add_name_column = Migration::new("add_nullable_name_column", None).with_action(AddColumn {
132+ table: "users".to_string(),
133+ column: Column {
134+ name: "name".to_string(),
135+ data_type: "TEXT".to_string(),
136+ nullable: true,
137+ default: None,
138+ generated: None,
139+ },
140+ up: None,
141+ });
132142
133− test.second_migration(
134− r#"
135− name = "add_nullable_name_column"
143+ let first_migrations = vec![create_users_table.clone()];
144+ let second_migrations = vec![create_users_table.clone(), add_name_column.clone()];
136145
137− [[actions]]
138− type = "add_column"
139− table = "users"
146+ // Run first migration, should automatically finish
147+ reshape.migrate(first_migrations.clone()).unwrap();
140148
141− [actions.column]
142− name = "name"
143− type = "TEXT"
144− "#,
145− );
149+ // Update search paths
150+ old_db
151+ .simple_query(&reshape::schema_query_for_migration(
152+ &first_migrations.last().unwrap().name,
153+ ))
154+ .unwrap();
155+ new_db
156+ .simple_query(&reshape::schema_query_for_migration(
157+ &first_migrations.last().unwrap().name,
158+ ))
159+ .unwrap();
146160
147− test.after_first(|db| {
148− // Insert some test values
149− db.simple_query(
161+ // Insert some test values
162+ new_db
163+ .simple_query(
150164 "
151− INSERT INTO users (id) VALUES (1), (2);
165+ INSERT INTO users (id) VALUES
166+ (1),
167+ (2);
152168 ",
153169 )
154170 .unwrap();
155− });
156−
157− test.intermediate(|old_db, new_db| {
158− // Ensure existing data got updated
159− let expected: Vec<Option<String>> = vec![None, None];
160− assert!(new_db
161− .query("SELECT name FROM users ORDER BY id", &[],)
162− .unwrap()
163− .iter()
164− .map(|row| row.get::<_, Option<String>>("name"))
165− .eq(expected));
166−
167− // Insert data using old schema and ensure new column is NULL
168− old_db
169− .simple_query("INSERT INTO users (id) VALUES (3)")
170− .unwrap();
171− let name: Option<String> = new_db
172− .query_one("SELECT name from users WHERE id = 3", &[])
173− .map(|row| (row.get("name")))
174− .unwrap();
175− assert_eq!(None, name);
176171
177− // Ensure data can be inserted against new schema
178− new_db
179− .simple_query("INSERT INTO users (id, name) VALUES (4, 'Test Testsson'), (5, NULL)")
180− .unwrap();
181− });
172+ // Run second migration
173+ reshape.migrate(second_migrations.clone()).unwrap();
174+ new_db
175+ .simple_query(&reshape::schema_query_for_migration(
176+ &second_migrations.last().unwrap().name,
177+ ))
178+ .unwrap();
182179
183− test.after_completion(|db| {
184− let expected: Vec<Option<String>> =
185− vec![None, None, None, Some("Test Testsson".to_string()), None];
186− let result: Vec<Option<String>> = db
187− .query("SELECT id, name FROM users ORDER BY id", &[])
188− .unwrap()
189− .iter()
190− .map(|row| row.get("name"))
191− .collect();
180+ // Ensure existing data got updated
181+ let expected: Vec<Option<String>> = vec![None, None];
182+ assert!(new_db
183+ .query("SELECT name FROM users ORDER BY id", &[],)
184+ .unwrap()
185+ .iter()
186+ .map(|row| row.get::<_, Option<String>>("name"))
187+ .eq(expected));
188+
189+ // Insert data using old schema and ensure new column is NULL
190+ old_db
191+ .simple_query("INSERT INTO users (id) VALUES (3)")
192+ .unwrap();
193+ let name: Option<String> = new_db
194+ .query_one("SELECT name from users WHERE id = 3", &[])
195+ .map(|row| (row.get("name")))
196+ .unwrap();
197+ assert_eq!(None, name);
192198
193− assert_eq!(result, expected);
194− });
199+ // Ensure data can be inserted against new schema
200+ new_db
201+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'Test Testsson'), (5, NULL)")
202+ .unwrap();
195203
196− test.run();
204+ reshape.complete().unwrap();
205+ common::assert_cleaned_up(&mut new_db);
197206}
198207
199208#[test]
200209fn add_column_with_default() {
201− let mut test = Test::new("Add column with default value");
202−
203− test.first_migration(
204− r#"
205− name = "create_users_table"
206−
207− [[actions]]
208− type = "create_table"
209− name = "users"
210− primary_key = ["id"]
211−
212− [[actions.columns]]
213− name = "id"
214− type = "INTEGER"
215− "#,
216− );
217−
218− test.second_migration(
219− r#"
220− name = "add_name_column_with_default"
221−
222− [[actions]]
223− type = "add_column"
224− table = "users"
225−
226− [actions.column]
227− name = "name"
228− type = "TEXT"
229− nullable = false
230− default = "'DEFAULT'"
231− "#,
232− );
233−
234− test.after_first(|db| {
235− // Insert some test values
236− db.simple_query("INSERT INTO users (id) VALUES (1), (2)")
237− .unwrap();
238− });
239−
240− test.intermediate(|old_db, new_db| {
241− // Ensure existing data got updated with defaults
242− let expected = vec!["DEFAULT".to_string(), "DEFAULT".to_string()];
243− assert!(new_db
244− .query("SELECT name FROM users ORDER BY id", &[],)
245− .unwrap()
246− .iter()
247− .map(|row| row.get::<_, String>("name"))
248− .eq(expected));
249−
250− // Insert data using old schema and ensure new column gets the default value
251− old_db
252− .simple_query("INSERT INTO users (id) VALUES (3)")
253− .unwrap();
254− let name: String = new_db
255− .query_one("SELECT name from users WHERE id = 3", &[])
256− .map(|row| row.get("name"))
257− .unwrap();
258− assert_eq!("DEFAULT", name);
259− });
260−
261− test.run();
262−}
263−
264−#[test]
265−fn add_column_with_complex_up() {
266− let mut test = Test::new("Add column complex");
267−
268− test.first_migration(
269− r#"
270− name = "create_tables"
271−
272− [[actions]]
273− type = "create_table"
274− name = "users"
275− primary_key = ["id"]
276−
277− [[actions.columns]]
278− name = "id"
279− type = "INTEGER"
280−
281− [[actions.columns]]
282− name = "email"
283− type = "TEXT"
284−
285− [[actions]]
286− type = "create_table"
287− name = "profiles"
288− primary_key = ["user_id"]
289−
290− [[actions.columns]]
291− name = "user_id"
292− type = "INTEGER"
293− "#,
294− );
295−
296− test.second_migration(
297− r#"
298− name = "add_profiles_email_column"
299−
300− [[actions]]
301− type = "add_column"
302− table = "profiles"
303−
304− [actions.column]
305− name = "email"
306− type = "TEXT"
307− nullable = false
308−
309− [actions.up]
310− table = "users"
311− value = "users.email"
312− where = "profiles.user_id = users.id"
313− "#,
210+ let (mut reshape, mut old_db, mut new_db) = common::setup();
211+
212+ let create_users_table = Migration::new("create_user_table", None).with_action(
213+ CreateTableBuilder::default()
214+ .name("users")
215+ .primary_key(vec!["id".to_string()])
216+ .columns(vec![ColumnBuilder::default()
217+ .name("id")
218+ .data_type("INTEGER")
219+ .build()
220+ .unwrap()])
221+ .build()
222+ .unwrap(),
314223 );
224+ let add_name_column =
225+ Migration::new("add_name_column_with_default", None).with_action(AddColumn {
226+ table: "users".to_string(),
227+ column: Column {
228+ name: "name".to_string(),
229+ data_type: "TEXT".to_string(),
230+ nullable: false,
231+ default: Some("'DEFAULT'".to_string()),
232+ generated: None,
233+ },
234+ up: None,
235+ });
236+
237+ let first_migrations = vec![create_users_table.clone()];
238+ let second_migrations = vec![create_users_table.clone(), add_name_column.clone()];
239+
240+ // Run first migration, should automatically finish
241+ reshape.migrate(first_migrations.clone()).unwrap();
242+
243+ // Update search paths
244+ old_db
245+ .simple_query(&reshape::schema_query_for_migration(
246+ &first_migrations.last().unwrap().name,
247+ ))
248+ .unwrap();
249+ new_db
250+ .simple_query(&reshape::schema_query_for_migration(
251+ &first_migrations.last().unwrap().name,
252+ ))
253+ .unwrap();
315254
316− test.after_first(|db| {
317− db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test@example.com')")
318− .unwrap();
319− db.simple_query("INSERT INTO profiles (user_id) VALUES (1)")
320− .unwrap();
321− });
255+ // Insert some test values
256+ new_db
257+ .simple_query("INSERT INTO users (id) VALUES (1), (2)")
258+ .unwrap();
322259
323− test.intermediate(|old_db, new_db| {
324− // Ensure email was backfilled on profiles
325− let email: String = new_db
326− .query(
327− "
328− SELECT email
329− FROM profiles
330− WHERE user_id = 1
331− ",
332− &[],
333− )
334− .unwrap()
335− .first()
336− .map(|row| row.get("email"))
337− .unwrap();
338− assert_eq!("test@example.com", email);
260+ // Run second migration
261+ reshape.migrate(second_migrations.clone()).unwrap();
262+ new_db
263+ .simple_query(&reshape::schema_query_for_migration(
264+ &second_migrations.last().unwrap().name,
265+ ))
266+ .unwrap();
339267
340− // Ensure email change in old schema is propagated to profiles table in new schema
341− old_db
342− .simple_query("UPDATE users SET email = 'test2@example.com' WHERE id = 1")
343− .unwrap();
344− let email: String = new_db
345− .query(
346− "
347− SELECT email
348− FROM profiles
349− WHERE user_id = 1
350− ",
351− &[],
352− )
353− .unwrap()
354− .first()
355− .map(|row| row.get("email"))
356− .unwrap();
357− assert_eq!("test2@example.com", email);
358− });
268+ // Ensure existing data got updated with defaults
269+ let expected = vec!["DEFAULT".to_string(), "DEFAULT".to_string()];
270+ assert!(new_db
271+ .query("SELECT name FROM users ORDER BY id", &[],)
272+ .unwrap()
273+ .iter()
274+ .map(|row| row.get::<_, String>("name"))
275+ .eq(expected));
276+
277+ // Insert data using old schema and ensure new column gets the default value
278+ old_db
279+ .simple_query("INSERT INTO users (id) VALUES (3)")
280+ .unwrap();
281+ let name: String = new_db
282+ .query_one("SELECT name from users WHERE id = 3", &[])
283+ .map(|row| row.get("name"))
284+ .unwrap();
285+ assert_eq!("DEFAULT", name);
359286
360− test.run();
287+ reshape.complete().unwrap();
288+ common::assert_cleaned_up(&mut new_db);
361289}
tests/add_foreign_key.rsdeleted−166
@@ -1,166 +0,0 @@
1−mod common;
2−use common::Test;
3−
4−#[test]
5−fn add_foreign_key() {
6− let mut test = Test::new("Add foreign key");
7−
8− test.first_migration(
9− r#"
10− name = "create_user_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
16−
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20−
21− [[actions]]
22− type = "create_table"
23− name = "items"
24− primary_key = ["id"]
25−
26− [[actions.columns]]
27− name = "id"
28− type = "INTEGER"
29−
30− [[actions.columns]]
31− name = "user_id"
32− type = "INTEGER"
33− "#,
34− );
35−
36− test.second_migration(
37− r#"
38− name = "add_foreign_key"
39−
40− [[actions]]
41− type = "add_foreign_key"
42− table = "items"
43−
44− [actions.foreign_key]
45− columns = ["user_id"]
46− referenced_table = "users"
47− referenced_columns = ["id"]
48− "#,
49− );
50−
51− test.after_first(|db| {
52− // Insert some test users
53− db.simple_query("INSERT INTO users (id) VALUES (1), (2)")
54− .unwrap();
55− });
56−
57− test.intermediate(|db, _| {
58− // Ensure items can be inserted if they reference valid users
59− db.simple_query("INSERT INTO items (id, user_id) VALUES (1, 1), (2, 2)")
60− .unwrap();
61−
62− // Ensure items can't be inserted if they don't reference valid users
63− let result = db.simple_query("INSERT INTO items (id, user_id) VALUES (3, 3)");
64− assert!(result.is_err(), "expected insert to fail");
65− });
66−
67− test.after_completion(|db| {
68− // Ensure items can be inserted if they reference valid users
69− db.simple_query("INSERT INTO items (id, user_id) VALUES (3, 1), (4, 2)")
70− .unwrap();
71−
72− // Ensure items can't be inserted if they don't reference valid users
73− let result = db.simple_query("INSERT INTO items (id, user_id) VALUES (5, 3)");
74− assert!(result.is_err(), "expected insert to fail");
75−
76− // Ensure foreign key exists with the right name
77− let foreign_key_name: Option<String> = db
78− .query(
79− "
80− SELECT tc.constraint_name
81− FROM information_schema.table_constraints AS tc
82− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
83− ",
84− &[],
85− )
86− .unwrap()
87− .first()
88− .map(|row| row.get(0));
89− assert_eq!(Some("items_user_id_fkey".to_string()), foreign_key_name);
90− });
91−
92− test.after_abort(|db| {
93− // Ensure foreign key doesn't exist
94− let fk_does_not_exist = db
95− .query(
96− "
97− SELECT tc.constraint_name
98− FROM information_schema.table_constraints AS tc
99− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
100− ",
101− &[],
102− )
103− .unwrap()
104− .is_empty();
105− assert!(fk_does_not_exist);
106− });
107−
108− test.run()
109−}
110−
111−#[test]
112−fn add_invalid_foreign_key() {
113− let mut test = Test::new("Add invalid foreign key");
114−
115− test.first_migration(
116− r#"
117− name = "create_user_table"
118−
119− [[actions]]
120− type = "create_table"
121− name = "users"
122− primary_key = ["id"]
123−
124− [[actions.columns]]
125− name = "id"
126− type = "INTEGER"
127−
128− [[actions]]
129− type = "create_table"
130− name = "items"
131− primary_key = ["id"]
132−
133− [[actions.columns]]
134− name = "id"
135− type = "INTEGER"
136−
137− [[actions.columns]]
138− name = "user_id"
139− type = "INTEGER"
140− "#,
141− );
142−
143− test.second_migration(
144− r#"
145− name = "add_foreign_key"
146−
147− [[actions]]
148− type = "add_foreign_key"
149− table = "items"
150−
151− [actions.foreign_key]
152− columns = ["user_id"]
153− referenced_table = "users"
154− referenced_columns = ["id"]
155− "#,
156− );
157−
158− test.after_first(|db| {
159− // Insert some items which don't reference a valid user
160− db.simple_query("INSERT INTO items (id, user_id) VALUES (1, 1), (2, 2)")
161− .unwrap();
162− });
163−
164− test.expect_failure();
165− test.run()
166−}
tests/add_index.rs+207−199
@@ -1,223 +1,231 @@
1+use reshape::migrations::{AddIndex, ColumnBuilder, CreateTableBuilder, Index, Migration};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn add_index() {
6− let mut test = Test::new("Add index");
7−
8− test.first_migration(
9− r#"
10− name = "create_users_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
16−
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20−
21− [[actions.columns]]
22− name = "name"
23− type = "TEXT"
24− "#,
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
8+
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
10+ CreateTableBuilder::default()
11+ .name("users")
12+ .primary_key(vec!["id".to_string()])
13+ .columns(vec![
14+ ColumnBuilder::default()
15+ .name("id")
16+ .data_type("INTEGER")
17+ .build()
18+ .unwrap(),
19+ ColumnBuilder::default()
20+ .name("name")
21+ .data_type("TEXT")
22+ .build()
23+ .unwrap(),
24+ ])
25+ .build()
26+ .unwrap(),
2527 );
26−
27− test.second_migration(
28− r#"
29− name = "add_users_name_index"
30−
31− [[actions]]
32− type = "add_index"
33− table = "users"
34−
35− [actions.index]
36− name = "name_idx"
37− columns = ["name"]
38− "#,
39− );
40−
41− test.intermediate(|db, _| {
42− // Ensure index is valid and ready
43− let (is_ready, is_valid): (bool, bool) = db
44− .query(
45− "
46− SELECT pg_index.indisready, pg_index.indisvalid
47− FROM pg_catalog.pg_index
48− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
49− WHERE pg_class.relname = 'name_idx'
50− ",
51− &[],
52− )
53− .unwrap()
54− .first()
55− .map(|row| (row.get("indisready"), row.get("indisvalid")))
56− .unwrap();
57−
58− assert!(is_ready, "expected index to be ready");
59− assert!(is_valid, "expected index to be valid");
28+ let add_index_migration = Migration::new("add_name_index", None).with_action(AddIndex {
29+ table: "users".to_string(),
30+ index: Index {
31+ name: "name_idx".to_string(),
32+ columns: vec!["name".to_string()],
33+ unique: true,
34+ index_type: None,
35+ },
6036 });
6137
62− test.after_completion(|db| {
63− // Ensure index is valid and ready
64− let (is_ready, is_valid): (bool, bool) = db
65− .query(
66− "
67− SELECT pg_index.indisready, pg_index.indisvalid
68− FROM pg_catalog.pg_index
69− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
70− WHERE pg_class.relname = 'name_idx'
71− ",
72− &[],
73− )
74− .unwrap()
75− .first()
76− .map(|row| (row.get("indisready"), row.get("indisvalid")))
77− .unwrap();
78−
79− assert!(is_ready, "expected index to be ready");
80− assert!(is_valid, "expected index to be valid");
81− });
82−
83− test.run();
38+ let first_migrations = vec![create_table_migration.clone()];
39+ let second_migrations = vec![create_table_migration.clone(), add_index_migration.clone()];
40+
41+ // Run migrations
42+ reshape.migrate(first_migrations.clone()).unwrap();
43+ reshape.migrate(second_migrations.clone()).unwrap();
44+
45+ // Update schemas of Postgres connections
46+ let old_schema_query =
47+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
48+ let new_schema_query =
49+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
50+ old_db.simple_query(&old_schema_query).unwrap();
51+ new_db.simple_query(&new_schema_query).unwrap();
52+
53+ // Ensure index is valid and ready
54+ let (is_ready, is_valid): (bool, bool) = new_db
55+ .query(
56+ "
57+ SELECT pg_index.indisready, pg_index.indisvalid
58+ FROM pg_catalog.pg_index
59+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
60+ WHERE pg_class.relname = 'name_idx'
61+ ",
62+ &[],
63+ )
64+ .unwrap()
65+ .first()
66+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
67+ .unwrap();
68+
69+ assert!(is_ready, "expected index to be ready");
70+ assert!(is_valid, "expected index to be valid");
71+
72+ reshape.complete().unwrap();
73+ common::assert_cleaned_up(&mut new_db);
8474}
8575
8676#[test]
8777fn add_index_unique() {
88− let mut test = Test::new("Add unique index");
89−
90− test.first_migration(
91− r#"
92− name = "create_users_table"
93−
94− [[actions]]
95− type = "create_table"
96− name = "users"
97− primary_key = ["id"]
98−
99− [[actions.columns]]
100− name = "id"
101− type = "INTEGER"
102−
103− [[actions.columns]]
104− name = "name"
105− type = "TEXT"
106− "#,
107− );
108−
109− test.second_migration(
110− r#"
111− name = "add_name_index"
112−
113− [[actions]]
114− type = "add_index"
115− table = "users"
116−
117− [actions.index]
118− name = "name_idx"
119− columns = ["name"]
120− unique = true
121− "#,
78+ let (mut reshape, mut old_db, mut new_db) = common::setup();
79+
80+ let create_table_migration = Migration::new("create_user_table", None).with_action(
81+ CreateTableBuilder::default()
82+ .name("users")
83+ .primary_key(vec!["id".to_string()])
84+ .columns(vec![
85+ ColumnBuilder::default()
86+ .name("id")
87+ .data_type("INTEGER")
88+ .build()
89+ .unwrap(),
90+ ColumnBuilder::default()
91+ .name("name")
92+ .data_type("TEXT")
93+ .build()
94+ .unwrap(),
95+ ])
96+ .build()
97+ .unwrap(),
12298 );
99+ let add_index_migration = Migration::new("add_name_index", None).with_action(AddIndex {
100+ table: "users".to_string(),
101+ index: Index {
102+ name: "name_idx".to_string(),
103+ columns: vec!["name".to_string()],
104+ unique: true,
105+ index_type: None,
106+ },
107+ });
123108
124− test.intermediate(|db, _| {
125− // Ensure index is valid, ready and unique
126− let (is_ready, is_valid, is_unique): (bool, bool, bool) = db
127− .query(
128− "
129− SELECT pg_index.indisready, pg_index.indisvalid, pg_index.indisunique
130− FROM pg_catalog.pg_index
131− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
132− WHERE pg_class.relname = 'name_idx'
133− ",
134− &[],
109+ let first_migrations = vec![create_table_migration.clone()];
110+ let second_migrations = vec![create_table_migration.clone(), add_index_migration.clone()];
111+
112+ // Run migrations
113+ reshape.migrate(first_migrations.clone()).unwrap();
114+ reshape.migrate(second_migrations.clone()).unwrap();
115+
116+ // Update schemas of Postgres connections
117+ let old_schema_query =
118+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
119+ let new_schema_query =
120+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
121+ old_db.simple_query(&old_schema_query).unwrap();
122+ new_db.simple_query(&new_schema_query).unwrap();
123+
124+ // Ensure index is valid, ready and unique
125+ let (is_ready, is_valid, is_unique): (bool, bool, bool) = new_db
126+ .query(
127+ "
128+ SELECT pg_index.indisready, pg_index.indisvalid, pg_index.indisunique
129+ FROM pg_catalog.pg_index
130+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
131+ WHERE pg_class.relname = 'name_idx'
132+ ",
133+ &[],
134+ )
135+ .unwrap()
136+ .first()
137+ .map(|row| {
138+ (
139+ row.get("indisready"),
140+ row.get("indisvalid"),
141+ row.get("indisunique"),
135142 )
136− .unwrap()
137− .first()
138− .map(|row| {
139− (
140− row.get("indisready"),
141− row.get("indisvalid"),
142− row.get("indisunique"),
143− )
144− })
145− .unwrap();
146−
147− assert!(is_ready, "expected index to be ready");
148− assert!(is_valid, "expected index to be valid");
149− assert!(is_unique, "expected index to be unique");
150− });
143+ })
144+ .unwrap();
145+
146+ assert!(is_ready, "expected index to be ready");
147+ assert!(is_valid, "expected index to be valid");
148+ assert!(is_unique, "expected index to be unique");
151149
152− test.run();
150+ reshape.complete().unwrap();
151+ common::assert_cleaned_up(&mut new_db);
153152}
154153
155154#[test]
156155fn add_index_with_type() {
157− let mut test = Test::new("Add GIN index");
158−
159− test.first_migration(
160− r#"
161− name = "create_users_table"
162−
163− [[actions]]
164− type = "create_table"
165− name = "users"
166− primary_key = ["id"]
167−
168− [[actions.columns]]
169− name = "id"
170− type = "INTEGER"
171−
172− [[actions.columns]]
173− name = "data"
174− type = "JSONB"
175− "#,
176− );
177−
178− test.second_migration(
179− r#"
180− name = "add_data_index"
181−
182− [[actions]]
183− type = "add_index"
184− table = "users"
185−
186− [actions.index]
187− name = "data_idx"
188− columns = ["data"]
189− type = "gin"
190− "#,
156+ let (mut reshape, mut old_db, mut new_db) = common::setup();
157+
158+ let create_table_migration = Migration::new("create_user_table", None).with_action(
159+ CreateTableBuilder::default()
160+ .name("users")
161+ .primary_key(vec!["id".to_string()])
162+ .columns(vec![
163+ ColumnBuilder::default()
164+ .name("id")
165+ .data_type("INTEGER")
166+ .build()
167+ .unwrap(),
168+ ColumnBuilder::default()
169+ .name("data")
170+ .data_type("JSONB")
171+ .build()
172+ .unwrap(),
173+ ])
174+ .build()
175+ .unwrap(),
191176 );
177+ let add_index_migration = Migration::new("add_name_index", None).with_action(AddIndex {
178+ table: "users".to_string(),
179+ index: Index {
180+ name: "name_idx".to_string(),
181+ columns: vec!["data".to_string()],
182+ unique: false,
183+ index_type: Some("gin".to_string()),
184+ },
185+ });
192186
193− test.intermediate(|db, _| {
194− // Ensure index is valid, ready and has the right type
195− let (is_ready, is_valid, index_type): (bool, bool, String) = db
196− .query(
197− "
198− SELECT pg_index.indisready, pg_index.indisvalid, pg_am.amname
199− FROM pg_catalog.pg_index
200− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
201− JOIN pg_catalog.pg_am ON pg_class.relam = pg_am.oid
202− WHERE pg_class.relname = 'data_idx'
203− ",
204− &[],
187+ let first_migrations = vec![create_table_migration.clone()];
188+ let second_migrations = vec![create_table_migration.clone(), add_index_migration.clone()];
189+
190+ // Run migrations
191+ reshape.migrate(first_migrations.clone()).unwrap();
192+ reshape.migrate(second_migrations.clone()).unwrap();
193+
194+ // Update schemas of Postgres connections
195+ let old_schema_query =
196+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
197+ let new_schema_query =
198+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
199+ old_db.simple_query(&old_schema_query).unwrap();
200+ new_db.simple_query(&new_schema_query).unwrap();
201+
202+ // Ensure index is valid, ready and unique
203+ let (is_ready, is_valid, index_type): (bool, bool, String) = new_db
204+ .query(
205+ "
206+ SELECT pg_index.indisready, pg_index.indisvalid, pg_am.amname
207+ FROM pg_catalog.pg_index
208+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
209+ JOIN pg_catalog.pg_am ON pg_class.relam = pg_am.oid
210+ WHERE pg_class.relname = 'name_idx'
211+ ",
212+ &[],
213+ )
214+ .unwrap()
215+ .first()
216+ .map(|row| {
217+ (
218+ row.get("indisready"),
219+ row.get("indisvalid"),
220+ row.get("amname"),
205221 )
206− .unwrap()
207− .first()
208− .map(|row| {
209− (
210− row.get("indisready"),
211− row.get("indisvalid"),
212− row.get("amname"),
213− )
214− })
215− .unwrap();
216−
217− assert!(is_ready, "expected index to be ready");
218− assert!(is_valid, "expected index to be valid");
219− assert_eq!("gin", index_type, "expected index type to be GIN");
220− });
222+ })
223+ .unwrap();
224+
225+ assert!(is_ready, "expected index to be ready");
226+ assert!(is_valid, "expected index to be valid");
227+ assert_eq!("gin", index_type, "expected index type to be GIN");
221228
222− test.run();
229+ reshape.complete().unwrap();
230+ common::assert_cleaned_up(&mut new_db);
223231}
tests/alter_column.rs+498−637
@@ -1,45 +1,61 @@
1+use reshape::migrations::{
2+ AddIndex, AlterColumn, ColumnBuilder, ColumnChanges, CreateTableBuilder, Index, Migration,
3+};
4+
15mod common;
2−use common::Test;
36
47#[test]
58fn alter_column_data() {
6− let mut test = Test::new("Alter column");
7−
8− test.first_migration(
9− r#"
10− name = "create_user_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
9+ let (mut reshape, mut old_db, mut new_db) = common::setup();
10+
11+ let create_users_table = Migration::new("create_user_table", None).with_action(
12+ CreateTableBuilder::default()
13+ .name("users")
14+ .primary_key(vec!["id".to_string()])
15+ .columns(vec![
16+ ColumnBuilder::default()
17+ .name("id")
18+ .data_type("INTEGER")
19+ .build()
20+ .unwrap(),
21+ ColumnBuilder::default()
22+ .name("name")
23+ .data_type("TEXT")
24+ .build()
25+ .unwrap(),
26+ ])
27+ .build()
28+ .unwrap(),
29+ );
30+ let uppercase_name = Migration::new("uppercase_name", None).with_action(AlterColumn {
31+ table: "users".to_string(),
32+ column: "name".to_string(),
33+ up: Some("UPPER(name)".to_string()),
34+ down: Some("LOWER(name)".to_string()),
35+ changes: ColumnChanges {
36+ data_type: None,
37+ nullable: None,
38+ name: None,
39+ default: None,
40+ },
41+ });
1642
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
43+ let first_migrations = vec![create_users_table.clone()];
44+ let second_migrations = vec![create_users_table.clone(), uppercase_name.clone()];
2045
21− [[actions.columns]]
22− name = "name"
23− type = "TEXT"
24− "#,
25− );
46+ // Run first migration, should automatically finish
47+ reshape.migrate(first_migrations.clone()).unwrap();
2648
27− test.second_migration(
28− r#"
29− name = "uppercase_name"
30−
31− [[actions]]
32− type = "alter_column"
33− table = "users"
34− column = "name"
35− up = "UPPER(name)"
36− down = "LOWER(name)"
37− "#,
38− );
49+ // Update search paths
50+ old_db
51+ .simple_query(&reshape::schema_query_for_migration(
52+ &first_migrations.last().unwrap().name,
53+ ))
54+ .unwrap();
3955
40− test.after_first(|db| {
41− // Insert some test users
42− db.simple_query(
56+ // Insert some test users
57+ old_db
58+ .simple_query(
4359 "
4460 INSERT INTO users (id, name) VALUES
4561 (1, 'john Doe'),
@@ -47,81 +63,98 @@ fn alter_column_data() {
4763 ",
4864 )
4965 .unwrap();
50− });
5166
52− test.intermediate(|old_db, new_db| {
53− // Check that the existing users has the altered data
54− let expected = vec!["JOHN DOE", "JANE DOE"];
55− assert!(new_db
56− .query("SELECT name FROM users ORDER BY id", &[],)
57− .unwrap()
58− .iter()
59− .map(|row| row.get::<_, String>("name"))
60− .eq(expected));
61−
62− // Insert data using old schema and make sure the new schema gets correct values
63− old_db
64− .simple_query("INSERT INTO users (id, name) VALUES (3, 'test testsson')")
65− .unwrap();
66− let result = new_db
67− .query_one("SELECT name from users WHERE id = 3", &[])
68− .unwrap();
69− assert_eq!("TEST TESTSSON", result.get::<_, &str>("name"));
70−
71− // Insert data using new schema and make sure the old schema gets correct values
72− new_db
73− .simple_query("INSERT INTO users (id, name) VALUES (4, 'TEST TESTSSON')")
74− .unwrap();
75− let result = old_db
76− .query_one("SELECT name from users WHERE id = 4", &[])
77− .unwrap();
78− assert_eq!("test testsson", result.get::<_, &str>("name"));
79− });
67+ // Run second migration
68+ reshape.migrate(second_migrations.clone()).unwrap();
69+ new_db
70+ .simple_query(&reshape::schema_query_for_migration(
71+ &second_migrations.last().unwrap().name,
72+ ))
73+ .unwrap();
74+
75+ // Check that the existing users has the altered data
76+ let expected = vec!["JOHN DOE", "JANE DOE"];
77+ assert!(new_db
78+ .query("SELECT name FROM users ORDER BY id", &[],)
79+ .unwrap()
80+ .iter()
81+ .map(|row| row.get::<_, String>("name"))
82+ .eq(expected));
83+
84+ // Insert data using old schema and make sure the new schema gets correct values
85+ old_db
86+ .simple_query("INSERT INTO users (id, name) VALUES (3, 'test testsson')")
87+ .unwrap();
88+ let result = new_db
89+ .query_one("SELECT name from users WHERE id = 3", &[])
90+ .unwrap();
91+ assert_eq!("TEST TESTSSON", result.get::<_, &str>("name"));
92+
93+ // Insert data using new schema and make sure the old schema gets correct values
94+ new_db
95+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'TEST TESTSSON')")
96+ .unwrap();
97+ let result = old_db
98+ .query_one("SELECT name from users WHERE id = 4", &[])
99+ .unwrap();
100+ assert_eq!("test testsson", result.get::<_, &str>("name"));
80101
81− test.run();
102+ reshape.complete().unwrap();
103+ common::assert_cleaned_up(&mut new_db);
82104}
83105
84106#[test]
85107fn alter_column_set_not_null() {
86− let mut test = Test::new("Set column not null");
87−
88− test.first_migration(
89− r#"
90− name = "create_user_table"
91−
92− [[actions]]
93− type = "create_table"
94− name = "users"
95− primary_key = ["id"]
96−
97− [[actions.columns]]
98− name = "id"
99− type = "INTEGER"
100−
101− [[actions.columns]]
102− name = "name"
103− type = "TEXT"
104− "#,
108+ let (mut reshape, mut old_db, mut new_db) = common::setup();
109+
110+ let create_users_table = Migration::new("create_user_table", None).with_action(
111+ CreateTableBuilder::default()
112+ .name("users")
113+ .primary_key(vec!["id".to_string()])
114+ .columns(vec![
115+ ColumnBuilder::default()
116+ .name("id")
117+ .data_type("INTEGER")
118+ .build()
119+ .unwrap(),
120+ ColumnBuilder::default()
121+ .name("name")
122+ .data_type("TEXT")
123+ .build()
124+ .unwrap(),
125+ ])
126+ .build()
127+ .unwrap(),
105128 );
129+ let set_name_not_null = Migration::new("set_name_not_null", None).with_action(AlterColumn {
130+ table: "users".to_string(),
131+ column: "name".to_string(),
132+ up: Some("COALESCE(name, 'TEST_DEFAULT_VALUE')".to_string()),
133+ down: Some("name".to_string()),
134+ changes: ColumnChanges {
135+ data_type: None,
136+ nullable: Some(false),
137+ name: None,
138+ default: None,
139+ },
140+ });
106141
107− test.second_migration(
108− r#"
109− name = "set_name_not_null"
142+ let first_migrations = vec![create_users_table.clone()];
143+ let second_migrations = vec![create_users_table.clone(), set_name_not_null.clone()];
110144
111− [[actions]]
112− type = "alter_column"
113− table = "users"
114− column = "name"
115− up = "COALESCE(name, 'TEST_DEFAULT_VALUE')"
145+ // Run first migration, should automatically finish
146+ reshape.migrate(first_migrations.clone()).unwrap();
116147
117− [actions.changes]
118− nullable = false
119− "#,
120− );
148+ // Update search paths
149+ old_db
150+ .simple_query(&reshape::schema_query_for_migration(
151+ &first_migrations.last().unwrap().name,
152+ ))
153+ .unwrap();
121154
122− test.after_first(|db| {
123− // Insert some test users
124− db.simple_query(
155+ // Insert some test users
156+ old_db
157+ .simple_query(
125158 "
126159 INSERT INTO users (id, name) VALUES
127160 (1, 'John Doe'),
@@ -129,180 +162,99 @@ fn alter_column_set_not_null() {
129162 ",
130163 )
131164 .unwrap();
132− });
133−
134− test.intermediate(|old_db, new_db| {
135− // Check that existing users got the correct values
136− let expected = vec!["John Doe", "TEST_DEFAULT_VALUE"];
137− assert!(new_db
138− .query("SELECT name FROM users ORDER BY id", &[],)
139− .unwrap()
140− .iter()
141− .map(|row| row.get::<_, String>("name"))
142− .eq(expected));
143−
144− // Insert data using old schema and make sure the new schema gets correct values
145− old_db
146− .simple_query("INSERT INTO users (id, name) VALUES (3, NULL)")
147− .unwrap();
148− let result = new_db
149− .query_one("SELECT name from users WHERE id = 3", &[])
150− .unwrap();
151− assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
152−
153− // Insert data using new schema and make sure the old schema gets correct values
154− new_db
155− .simple_query("INSERT INTO users (id, name) VALUES (4, 'Jane Doe')")
156− .unwrap();
157− let result = old_db
158− .query_one("SELECT name from users WHERE id = 4", &[])
159− .unwrap();
160− assert_eq!("Jane Doe", result.get::<_, &str>("name"));
161−
162− // Ensure NULL can't be inserted using the new schema
163− let result = new_db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
164− assert!(result.is_err(), "expected insert to fail");
165− });
166−
167− test.after_completion(|db| {
168− // Ensure NULL can't be inserted
169− let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
170− assert!(result.is_err(), "expected insert to fail");
171− });
172−
173− test.after_abort(|db| {
174− // Ensure NULL can be inserted
175− let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
176− assert!(result.is_ok(), "expected insert to succeed");
177− });
178165
179− test.run();
180−}
181−
182−#[test]
183−fn alter_column_set_nullable() {
184− let mut test = Test::new("Set column nullable");
185−
186− test.first_migration(
187− r#"
188− name = "create_user_table"
189−
190− [[actions]]
191− type = "create_table"
192− name = "users"
193− primary_key = ["id"]
194−
195− [[actions.columns]]
196− name = "id"
197− type = "INTEGER"
198−
199− [[actions.columns]]
200− name = "name"
201− type = "TEXT"
202− nullable = false
203− "#,
204− );
205−
206− test.second_migration(
207− r#"
208− name = "set_name_nullable"
209−
210− [[actions]]
211− type = "alter_column"
212− table = "users"
213− column = "name"
214− down = "COALESCE(name, 'TEST_DEFAULT_VALUE')"
215−
216− [actions.changes]
217− nullable = true
218− "#,
219− );
220−
221− test.after_first(|db| {
222− // Insert a test user
223− db.simple_query(
224− "
225− INSERT INTO users (id, name) VALUES
226− (1, 'John Doe')
227− ",
228− )
166+ // Run second migration
167+ reshape.migrate(second_migrations.clone()).unwrap();
168+ new_db
169+ .simple_query(&reshape::schema_query_for_migration(
170+ &second_migrations.last().unwrap().name,
171+ ))
229172 .unwrap();
230− });
231−
232− test.intermediate(|old_db, new_db| {
233− // Insert data using new schema and make sure the old schema gets correct values
234− new_db
235− .simple_query("INSERT INTO users (id, name) VALUES (2, NULL)")
236− .unwrap();
237− let result = old_db
238− .query_one("SELECT name from users WHERE id = 2", &[])
239− .unwrap();
240− assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
241−
242− // Ensure NULL can't be inserted using the old schema
243− let result = old_db.simple_query("INSERT INTO users (id, name) VALUES (3, NULL)");
244− assert!(result.is_err(), "expected insert to fail");
245−
246− // Ensure NULL can be inserted using the new schema
247− let result = new_db.simple_query("INSERT INTO users (id, name) VALUES (4, NULL)");
248− assert!(result.is_ok(), "expected insert to succeed");
249− });
250173
251− test.after_completion(|db| {
252− // Ensure NULL can be inserted
253− let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
254− assert!(result.is_ok(), "expected insert to succeed");
255− });
174+ // Check that existing users got the correct values
175+ let expected = vec!["John Doe", "TEST_DEFAULT_VALUE"];
176+ assert!(new_db
177+ .query("SELECT name FROM users ORDER BY id", &[],)
178+ .unwrap()
179+ .iter()
180+ .map(|row| row.get::<_, String>("name"))
181+ .eq(expected));
182+
183+ // Insert data using old schema and make sure the new schema gets correct values
184+ old_db
185+ .simple_query("INSERT INTO users (id, name) VALUES (3, NULL)")
186+ .unwrap();
187+ let result = new_db
188+ .query_one("SELECT name from users WHERE id = 3", &[])
189+ .unwrap();
190+ assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
256191
257− test.after_abort(|db| {
258− // Ensure NULL can't be inserted
259− let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
260− assert!(result.is_err(), "expected insert to fail");
261− });
192+ // Insert data using new schema and make sure the old schema gets correct values
193+ new_db
194+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'Jane Doe')")
195+ .unwrap();
196+ let result = old_db
197+ .query_one("SELECT name from users WHERE id = 4", &[])
198+ .unwrap();
199+ assert_eq!("Jane Doe", result.get::<_, &str>("name"));
262200
263− test.run();
201+ reshape.complete().unwrap();
202+ common::assert_cleaned_up(&mut new_db);
264203}
265204
266205#[test]
267206fn alter_column_rename() {
268− let mut test = Test::new("Rename column");
269−
270− test.first_migration(
271− r#"
272− name = "create_user_table"
273−
274− [[actions]]
275− type = "create_table"
276− name = "users"
277− primary_key = ["id"]
278−
279− [[actions.columns]]
280− name = "id"
281− type = "INTEGER"
282−
283− [[actions.columns]]
284− name = "name"
285− type = "TEXT"
286− "#,
287− );
288−
289− test.second_migration(
290− r#"
291− name = "set_name_not_null"
292−
293− [[actions]]
294− type = "alter_column"
295− table = "users"
296− column = "name"
297−
298− [actions.changes]
299− name = "full_name"
300− "#,
207+ let (mut reshape, mut old_db, mut new_db) = common::setup();
208+
209+ let create_users_table = Migration::new("create_user_table", None).with_action(
210+ CreateTableBuilder::default()
211+ .name("users")
212+ .primary_key(vec!["id".to_string()])
213+ .columns(vec![
214+ ColumnBuilder::default()
215+ .name("id")
216+ .data_type("INTEGER")
217+ .build()
218+ .unwrap(),
219+ ColumnBuilder::default()
220+ .name("name")
221+ .data_type("TEXT")
222+ .build()
223+ .unwrap(),
224+ ])
225+ .build()
226+ .unwrap(),
301227 );
228+ let rename_to_full_name =
229+ Migration::new("rename_to_full_name", None).with_action(AlterColumn {
230+ table: "users".to_string(),
231+ column: "name".to_string(),
232+ up: None, // up and down are not required when only renaming a column
233+ down: None,
234+ changes: ColumnChanges {
235+ data_type: None,
236+ nullable: None,
237+ name: Some("full_name".to_string()),
238+ default: None,
239+ },
240+ });
241+
242+ let first_migrations = vec![create_users_table.clone()];
243+ let second_migrations = vec![create_users_table.clone(), rename_to_full_name.clone()];
244+
245+ // Run first migration, should automatically finish
246+ reshape.migrate(first_migrations.clone()).unwrap();
247+
248+ // Update search paths
249+ old_db
250+ .simple_query(&reshape::schema_query_for_migration(
251+ &first_migrations.last().unwrap().name,
252+ ))
253+ .unwrap();
302254
303− test.after_first(|db| {
304− // Insert some test data
305− db.simple_query(
255+ // Insert some test data
256+ old_db
257+ .simple_query(
306258 "
307259 INSERT INTO users (id, name) VALUES
308260 (1, 'John Doe'),
@@ -310,69 +262,94 @@ fn alter_column_rename() {
310262 ",
311263 )
312264 .unwrap();
313− });
314265
315− test.intermediate(|_, new_db| {
316− // Check that existing values can be queried using new column name
317− let expected = vec!["John Doe", "Jane Doe"];
318− assert!(new_db
319− .query("SELECT full_name FROM users ORDER BY id", &[],)
320− .unwrap()
321− .iter()
322− .map(|row| row.get::<_, String>("full_name"))
323− .eq(expected));
324− });
266+ // Run second migration
267+ reshape.migrate(second_migrations.clone()).unwrap();
268+ new_db
269+ .simple_query(&reshape::schema_query_for_migration(
270+ &second_migrations.last().unwrap().name,
271+ ))
272+ .unwrap();
325273
326− test.run();
274+ // Check that existing values can be queried using new column name
275+ let expected = vec!["John Doe", "Jane Doe"];
276+ assert!(new_db
277+ .query("SELECT full_name FROM users ORDER BY id", &[],)
278+ .unwrap()
279+ .iter()
280+ .map(|row| row.get::<_, String>("full_name"))
281+ .eq(expected));
282+
283+ reshape.complete().unwrap();
284+ common::assert_cleaned_up(&mut new_db);
327285}
328286
329287#[test]
330288fn alter_column_multiple() {
331− let mut test = Test::new("Alter column value multiple times");
332−
333− test.first_migration(
334− r#"
335− name = "create_user_table"
336−
337− [[actions]]
338− type = "create_table"
339− name = "users"
340− primary_key = ["id"]
341−
342− [[actions.columns]]
343− name = "id"
344− type = "INTEGER"
345−
346− [[actions.columns]]
347− name = "counter"
348− type = "INTEGER"
349− nullable = false
350− "#,
351− );
352−
353− test.second_migration(
354− r#"
355− name = "increment_counter_twice"
356−
357− [[actions]]
358− type = "alter_column"
359− table = "users"
360− column = "counter"
361− up = "counter + 1"
362− down = "counter - 1"
363−
364− [[actions]]
365− type = "alter_column"
366− table = "users"
367− column = "counter"
368− up = "counter + 1"
369− down = "counter - 1"
370− "#,
289+ let (mut reshape, mut old_db, mut new_db) = common::setup();
290+
291+ let create_users_table = Migration::new("create_user_table", None).with_action(
292+ CreateTableBuilder::default()
293+ .name("users")
294+ .primary_key(vec!["id".to_string()])
295+ .columns(vec![
296+ ColumnBuilder::default()
297+ .name("id")
298+ .data_type("INTEGER")
299+ .build()
300+ .unwrap(),
301+ ColumnBuilder::default()
302+ .name("counter")
303+ .data_type("INTEGER")
304+ .nullable(false)
305+ .build()
306+ .unwrap(),
307+ ])
308+ .build()
309+ .unwrap(),
371310 );
311+ let increment_counter_twice = Migration::new("increment_counter_twice", None)
312+ .with_action(AlterColumn {
313+ table: "users".to_string(),
314+ column: "counter".to_string(),
315+ up: Some("counter + 1".to_string()),
316+ down: Some("counter - 1".to_string()),
317+ changes: ColumnChanges {
318+ data_type: None,
319+ nullable: None,
320+ name: None,
321+ default: None,
322+ },
323+ })
324+ .with_action(AlterColumn {
325+ table: "users".to_string(),
326+ column: "counter".to_string(),
327+ up: Some("counter + 1".to_string()),
328+ down: Some("counter - 1".to_string()),
329+ changes: ColumnChanges {
330+ data_type: None,
331+ nullable: None,
332+ name: None,
333+ default: None,
334+ },
335+ });
336+
337+ let first_migrations = vec![create_users_table.clone()];
338+ let second_migrations = vec![create_users_table.clone(), increment_counter_twice.clone()];
339+
340+ // Run first migration, should automatically finish
341+ reshape.migrate(first_migrations.clone()).unwrap();
342+
343+ // Update search paths
344+ old_db
345+ .simple_query(&reshape::schema_query_for_migration(
346+ &first_migrations.last().unwrap().name,
347+ ))
348+ .unwrap();
372349
373− test.after_first(|db| {
374− // Insert some test data
375− db.simple_query(
350+ // Insert some test data
351+ old_db
352+ .simple_query(
376353 "
377354 INSERT INTO users (id, counter) VALUES
378355 (1, 0),
@@ -380,355 +357,239 @@ fn alter_column_multiple() {
380357 ",
381358 )
382359 .unwrap();
383− });
384360
385− test.intermediate(|old_db, new_db| {
386− // Check that the existing data has been updated
387− let expected = vec![2, 102];
388− let results: Vec<i32> = new_db
389− .query("SELECT counter FROM users ORDER BY id", &[])
390− .unwrap()
391− .iter()
392− .map(|row| row.get::<_, i32>("counter"))
393− .collect();
394− assert_eq!(expected, results);
395−
396− // Update data using old schema and make sure it was updated for the new schema
397− old_db
398− .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
399− .unwrap();
400− let result: i32 = new_db
401− .query("SELECT counter FROM users WHERE id = 1", &[])
402− .unwrap()
403− .iter()
404− .map(|row| row.get("counter"))
405− .nth(0)
406− .unwrap();
407− assert_eq!(52, result);
408−
409− // Update data using new schema and make sure it was updated for the old schema
410− new_db
411− .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
412− .unwrap();
413− let result: i32 = old_db
414− .query("SELECT counter FROM users WHERE id = 1", &[])
415− .unwrap()
416− .iter()
417− .map(|row| row.get("counter"))
418− .nth(0)
419− .unwrap();
420− assert_eq!(48, result);
421− });
361+ // Run second migration
362+ reshape.migrate(second_migrations.clone()).unwrap();
363+ new_db
364+ .simple_query(&reshape::schema_query_for_migration(
365+ &second_migrations.last().unwrap().name,
366+ ))
367+ .unwrap();
422368
423− test.run();
369+ // Check that the existing data has been updated
370+ let expected = vec![2, 102];
371+ let results: Vec<i32> = new_db
372+ .query("SELECT counter FROM users ORDER BY id", &[])
373+ .unwrap()
374+ .iter()
375+ .map(|row| row.get::<_, i32>("counter"))
376+ .collect();
377+ assert_eq!(expected, results);
378+
379+ // Update data using old schema and make sure it was updated for the new schema
380+ old_db
381+ .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
382+ .unwrap();
383+ let result: i32 = new_db
384+ .query("SELECT counter FROM users WHERE id = 1", &[])
385+ .unwrap()
386+ .iter()
387+ .map(|row| row.get("counter"))
388+ .nth(0)
389+ .unwrap();
390+ assert_eq!(52, result);
391+
392+ // Update data using new schema and make sure it was updated for the old schema
393+ new_db
394+ .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
395+ .unwrap();
396+ let result: i32 = old_db
397+ .query("SELECT counter FROM users WHERE id = 1", &[])
398+ .unwrap()
399+ .iter()
400+ .map(|row| row.get("counter"))
401+ .nth(0)
402+ .unwrap();
403+ assert_eq!(48, result);
404+
405+ reshape.complete().unwrap();
406+ common::assert_cleaned_up(&mut new_db);
424407}
425408
426409#[test]
427410fn alter_column_default() {
428− let mut test = Test::new("Change default value for column");
429−
430− test.first_migration(
431− r#"
432− name = "create_user_table"
433−
434− [[actions]]
435− type = "create_table"
436− name = "users"
437− primary_key = ["id"]
438−
439− [[actions.columns]]
440− name = "id"
441− type = "INTEGER"
442−
443− [[actions.columns]]
444− name = "name"
445− type = "TEXT"
446− nullable = false
447− default = "'DEFAULT'"
448− "#,
449− );
450−
451− test.second_migration(
452− r#"
453− name = "change_name_default"
454−
455− [[actions]]
456− type = "alter_column"
457− table = "users"
458− column = "name"
459−
460− [actions.changes]
461− default = "'NEW DEFAULT'"
462− "#,
411+ let (mut reshape, mut old_db, mut new_db) = common::setup();
412+
413+ let create_users_table = Migration::new("create_user_table", None).with_action(
414+ CreateTableBuilder::default()
415+ .name("users")
416+ .primary_key(vec!["id".to_string()])
417+ .columns(vec![
418+ ColumnBuilder::default()
419+ .name("id")
420+ .data_type("INTEGER")
421+ .build()
422+ .unwrap(),
423+ ColumnBuilder::default()
424+ .name("name")
425+ .data_type("TEXT")
426+ .nullable(false)
427+ .default_value("'DEFAULT'")
428+ .build()
429+ .unwrap(),
430+ ])
431+ .build()
432+ .unwrap(),
463433 );
434+ let change_name_default =
435+ Migration::new("change_name_default", None).with_action(AlterColumn {
436+ table: "users".to_string(),
437+ column: "name".to_string(),
438+ up: None,
439+ down: None,
440+ changes: ColumnChanges {
441+ data_type: None,
442+ nullable: None,
443+ name: None,
444+ default: Some("'NEW DEFAULT'".to_string()),
445+ },
446+ });
447+
448+ let first_migrations = vec![create_users_table.clone()];
449+ let second_migrations = vec![create_users_table.clone(), change_name_default.clone()];
450+
451+ // Run first migration, should automatically finish
452+ reshape.migrate(first_migrations.clone()).unwrap();
453+
454+ // Update search paths
455+ old_db
456+ .simple_query(&reshape::schema_query_for_migration(
457+ &first_migrations.last().unwrap().name,
458+ ))
459+ .unwrap();
464460
465− test.after_first(|db| {
466− // Insert a test user
467− db.simple_query(
461+ // Insert a test user
462+ old_db
463+ .simple_query(
468464 "
469465 INSERT INTO users (id) VALUES (1)
470466 ",
471467 )
472468 .unwrap();
473− });
474469
475− test.intermediate(|old_db, new_db| {
476− // Check that the existing users has the old default value
477− let expected = vec!["DEFAULT"];
478− assert!(new_db
479− .query("SELECT name FROM users", &[],)
480− .unwrap()
481− .iter()
482− .map(|row| row.get::<_, String>("name"))
483− .eq(expected));
484−
485− // Insert data using old schema and make those get the old default value
486− old_db
487− .simple_query("INSERT INTO users (id) VALUES (2)")
488− .unwrap();
489− let result = new_db
490− .query_one("SELECT name from users WHERE id = 2", &[])
491− .unwrap();
492− assert_eq!("DEFAULT", result.get::<_, &str>("name"));
493−
494− // Insert data using new schema and make sure it gets the new default value
495− new_db
496− .simple_query("INSERT INTO users (id) VALUES (3)")
497− .unwrap();
498− let result = old_db
499− .query_one("SELECT name from users WHERE id = 3", &[])
500− .unwrap();
501− assert_eq!("NEW DEFAULT", result.get::<_, &str>("name"));
502− });
470+ // Run second migration
471+ reshape.migrate(second_migrations.clone()).unwrap();
472+ new_db
473+ .simple_query(&reshape::schema_query_for_migration(
474+ &second_migrations.last().unwrap().name,
475+ ))
476+ .unwrap();
503477
504− test.run();
478+ // Check that the existing users has the old default value
479+ let expected = vec!["DEFAULT"];
480+ assert!(new_db
481+ .query("SELECT name FROM users", &[],)
482+ .unwrap()
483+ .iter()
484+ .map(|row| row.get::<_, String>("name"))
485+ .eq(expected));
486+
487+ // Insert data using old schema and make those get the old default value
488+ old_db
489+ .simple_query("INSERT INTO users (id) VALUES (2)")
490+ .unwrap();
491+ let result = new_db
492+ .query_one("SELECT name from users WHERE id = 2", &[])
493+ .unwrap();
494+ assert_eq!("DEFAULT", result.get::<_, &str>("name"));
495+
496+ // Insert data using new schema and make sure it gets the new default value
497+ new_db
498+ .simple_query("INSERT INTO users (id) VALUES (3)")
499+ .unwrap();
500+ let result = old_db
501+ .query_one("SELECT name from users WHERE id = 3", &[])
502+ .unwrap();
503+ assert_eq!("NEW DEFAULT", result.get::<_, &str>("name"));
504+
505+ reshape.complete().unwrap();
506+ common::assert_cleaned_up(&mut new_db);
505507}
506508
507509#[test]
508510fn alter_column_with_index() {
509− let mut test = Test::new("Alter column with index");
510−
511− test.first_migration(
512− r#"
513− name = "create_user_table"
514−
515− [[actions]]
516− type = "create_table"
517− name = "users"
518− primary_key = ["id"]
519−
520− [[actions.columns]]
521− name = "id"
522− type = "INTEGER"
523−
524− [[actions.columns]]
525− name = "first_name"
526− type = "TEXT"
511+ let (mut reshape, mut db, _) = common::setup();
512+
513+ let create_users_table = Migration::new("create_user_table", None)
514+ .with_action(
515+ CreateTableBuilder::default()
516+ .name("users")
517+ .primary_key(vec!["id".to_string()])
518+ .columns(vec![
519+ ColumnBuilder::default()
520+ .name("id")
521+ .data_type("INTEGER")
522+ .build()
523+ .unwrap(),
524+ ColumnBuilder::default()
525+ .name("first_name")
526+ .data_type("TEXT")
527+ .build()
528+ .unwrap(),
529+ ColumnBuilder::default()
530+ .name("last_name")
531+ .data_type("TEXT")
532+ .build()
533+ .unwrap(),
534+ ])
535+ .build()
536+ .unwrap(),
537+ )
538+ .with_action(AddIndex {
539+ table: "users".to_string(),
540+ index: Index {
541+ name: "users_name_idx".to_string(),
542+ columns: vec!["first_name".to_string(), "last_name".to_string()],
543+ unique: false,
544+ index_type: None,
545+ },
546+ });
547+ let uppercase_name = Migration::new("uppercase_name", None).with_action(AlterColumn {
548+ table: "users".to_string(),
549+ column: "last_name".to_string(),
550+ up: Some("UPPER(last_name)".to_string()),
551+ down: Some("LOWER(last_name)".to_string()),
552+ changes: ColumnChanges {
553+ data_type: None,
554+ nullable: None,
555+ name: None,
556+ default: None,
557+ },
558+ });
527559
528− [[actions.columns]]
529− name = "last_name"
530− type = "TEXT"
560+ let first_migrations = vec![create_users_table.clone()];
561+ let second_migrations = vec![create_users_table.clone(), uppercase_name.clone()];
531562
532− [[actions]]
533− type = "add_index"
534− table = "users"
563+ // Run first migration, should automatically finish
564+ reshape.migrate(first_migrations.clone()).unwrap();
535565
536− [actions.index]
537− name = "users_name_idx"
538− columns = ["first_name", "last_name"]
539− "#,
540− );
566+ // Run second migration
567+ reshape.migrate(second_migrations.clone()).unwrap();
568+ db.simple_query(&reshape::schema_query_for_migration(
569+ &second_migrations.last().unwrap().name,
570+ ))
571+ .unwrap();
541572
542− test.second_migration(
543− r#"
544− name = "uppercase_last_name"
545−
546− [[actions]]
547− type = "alter_column"
548− table = "users"
549− column = "last_name"
550− up = "UPPER(last_name)"
551− down = "LOWER(last_name)"
552− "#,
553− );
573+ // Complete the second migration which should replace the existing column
574+ // with the temporary one
575+ reshape.complete().unwrap();
554576
555− test.after_completion(|db| {
556− // Make sure index still exists
557− let result: i64 = db
558− .query(
559− "
577+ // Make sure index still exists
578+ let result: i64 = db
579+ .query(
580+ "
560581 SELECT COUNT(*)
561582 FROM pg_catalog.pg_index
562583 JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
563584 WHERE pg_class.relname = 'users_name_idx'
564585 ",
565− &[],
566− )
567− .unwrap()
568− .first()
569− .map(|row| row.get(0))
570− .unwrap();
571− assert_eq!(1, result, "expected index to still exist");
572− });
573−
574− test.run();
575−}
576−
577−#[test]
578−fn alter_column_with_unique_index() {
579− let mut test = Test::new("Alter column with unique index");
580−
581− test.first_migration(
582− r#"
583− name = "create_user_table"
584−
585− [[actions]]
586− type = "create_table"
587− name = "users"
588− primary_key = ["id"]
589−
590− [[actions.columns]]
591− name = "id"
592− type = "INTEGER"
593−
594− [[actions.columns]]
595− name = "name"
596− type = "TEXT"
597−
598− [[actions]]
599− type = "add_index"
600− table = "users"
601−
602− [actions.index]
603− name = "name_idx"
604− columns = ["name"]
605− unique = true
606− "#,
607− );
608−
609− test.second_migration(
610− r#"
611− name = "uppercase_name"
612−
613− [[actions]]
614− type = "alter_column"
615− table = "users"
616− column = "name"
617− up = "UPPER(name)"
618− down = "LOWER(name)"
619− "#,
620− );
621−
622− test.after_first(|db| {
623− db.simple_query("INSERT INTO users (id, name) VALUES (1, 'Test')")
624− .unwrap();
625− });
626−
627− test.intermediate(|old_db, new_db| {
628− // Try inserting a value which duplicates the uppercase value of an existing row
629− let result = new_db.simple_query("INSERT INTO users (id, name) VALUES (2, 'TEST')");
630− assert!(
631− result.is_err(),
632− "expected duplicate insert to new schema to fail"
633− );
634−
635− // Try inserting a value which duplicates the lowercase value of an existing row
636− new_db
637− .simple_query("INSERT INTO users (id, name) VALUES (2, 'JOHN')")
638− .unwrap();
639− let result = old_db.simple_query("INSERT INTO users (id, name) VALUES (3, 'john')");
640− assert!(
641− result.is_err(),
642− "expected duplicate insert to old schema to fail"
643− );
644− });
645−
646− test.after_completion(|db| {
647− // Make sure index still exists
648− let is_unique: bool = db
649− .query(
650− "
651− SELECT pg_index.indisunique
652− FROM pg_catalog.pg_index
653− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
654− WHERE pg_class.relname = 'name_idx'
655− ",
656− &[],
657− )
658− .unwrap()
659− .first()
660− .map(|row| row.get("indisunique"))
661− .unwrap();
662− assert!(is_unique, "expected index to still be unique");
663− });
664−
665− test.run();
666−}
667−
668−#[test]
669−fn alter_column_with_hash_index() {
670− let mut test = Test::new("Alter column with custom index type");
671−
672− test.first_migration(
673− r#"
674− name = "create_user_table"
675−
676− [[actions]]
677− type = "create_table"
678− name = "users"
679− primary_key = ["id"]
680−
681− [[actions.columns]]
682− name = "id"
683− type = "INTEGER"
684−
685− [[actions.columns]]
686− name = "name"
687− type = "TEXT"
688−
689− [[actions]]
690− type = "add_index"
691− table = "users"
692−
693− [actions.index]
694− name = "name_idx"
695− columns = ["name"]
696− type = "hash"
697− "#,
698− );
699−
700− test.second_migration(
701− r#"
702− name = "uppercase_name"
703−
704− [[actions]]
705− type = "alter_column"
706− table = "users"
707− column = "name"
708− up = "UPPER(name)"
709− down = "LOWER(name)"
710− "#,
711− );
712−
713− test.after_completion(|db| {
714− // Make sure index still has type GIN
715− let index_type: String = db
716− .query(
717− "
718− SELECT pg_am.amname
719− FROM pg_catalog.pg_index
720− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
721− JOIN pg_catalog.pg_am ON pg_class.relam = pg_am.oid
722− WHERE pg_class.relname = 'name_idx'
723− ",
724− &[],
725− )
726− .unwrap()
727− .first()
728− .map(|row| row.get("amname"))
729− .unwrap();
730− assert_eq!("hash", index_type);
731− });
586+ &[],
587+ )
588+ .unwrap()
589+ .first()
590+ .map(|row| row.get(0))
591+ .unwrap();
592+ assert_eq!(1, result, "expected index to still exist");
732593
733− test.run();
594+ common::assert_cleaned_up(&mut db);
734595}
tests/common.rs+19−45
@@ -10,9 +10,7 @@ pub struct Test<'a> {
1010
1111 first_migration: Option<Migration>,
1212 second_migration: Option<Migration>,
13− expect_failure: bool,
1413
15− clear_fn: Option<fn(&mut Client) -> ()>,
1614 after_first_fn: Option<fn(&mut Client) -> ()>,
1715 intermediate_fn: Option<fn(&mut Client, &mut Client) -> ()>,
1816 after_completion_fn: Option<fn(&mut Client) -> ()>,
@@ -36,8 +34,6 @@ impl Test<'_> {
3634 new_db,
3735 first_migration: None,
3836 second_migration: None,
39− expect_failure: false,
40− clear_fn: None,
4137 after_first_fn: None,
4238 intermediate_fn: None,
4339 after_completion_fn: None,
@@ -50,47 +46,31 @@ impl Test<'_> {
5046 self
5147 }
5248
53− #[allow(dead_code)]
5449 pub fn second_migration(&mut self, migration: &str) -> &mut Self {
5550 self.second_migration = Some(Self::parse_migration(migration));
5651 self
5752 }
5853
59− #[allow(dead_code)]
60− pub fn clear(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
61− self.clear_fn = Some(f);
62− self
63− }
64−
65− #[allow(dead_code)]
6654 pub fn after_first(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
6755 self.after_first_fn = Some(f);
6856 self
6957 }
7058
71− #[allow(dead_code)]
7259 pub fn intermediate(&mut self, f: fn(&mut Client, &mut Client) -> ()) -> &mut Self {
7360 self.intermediate_fn = Some(f);
7461 self
7562 }
7663
77− #[allow(dead_code)]
7864 pub fn after_completion(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
7965 self.after_completion_fn = Some(f);
8066 self
8167 }
8268
83− #[allow(dead_code)]
8469 pub fn after_abort(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
8570 self.after_abort_fn = Some(f);
8671 self
8772 }
8873
89− #[allow(dead_code)]
90− pub fn expect_failure(&mut self) {
91− self.expect_failure = true;
92− }
93−
9474 fn parse_migration(encoded: &str) -> Migration {
9575 toml::from_str(encoded).unwrap()
9676 }
@@ -103,7 +83,6 @@ enum RunType {
10383}
10484
10585impl Test<'_> {
106− #[allow(dead_code)]
10786 pub fn run(&mut self) {
10887 if self.second_migration.is_some() {
10988 // Run to completion
@@ -123,10 +102,6 @@ impl Test<'_> {
123102 print_subheading("Clearing database");
124103 self.reshape.remove().unwrap();
125104
126− if let Some(clear_fn) = self.clear_fn {
127− clear_fn(&mut self.old_db);
128− }
129−
130105 // Apply first migration, will automatically complete
131106 print_subheading("Applying first migration");
132107 let first_migration = self
@@ -140,9 +115,6 @@ impl Test<'_> {
140115 .simple_query(&reshape::schema_query_for_migration(&first_migration.name))
141116 .unwrap();
142117
143− // Automatically complete first migration
144− self.reshape.complete().unwrap();
145−
146118 // Run setup function
147119 if let Some(after_first_fn) = self.after_first_fn {
148120 print_subheading("Running setup and first checks");
@@ -152,21 +124,10 @@ impl Test<'_> {
152124
153125 // Apply second migration
154126 if let Some(second_migration) = &self.second_migration {
155− if self.expect_failure {
156− print_subheading("Applying second migration (expecting failure)");
157− let result = self
158− .reshape
159− .migrate(vec![first_migration.clone(), second_migration.clone()]);
160−
161− if result.is_ok() {
162− panic!("expected second migration to fail");
163− }
164− } else {
165− print_subheading("Applying second migration");
166− self.reshape
167− .migrate(vec![first_migration.clone(), second_migration.clone()])
168− .unwrap();
169− }
127+ print_subheading("Applying second migration");
128+ self.reshape
129+ .migrate(vec![first_migration.clone(), second_migration.clone()])
130+ .unwrap();
170131
171132 // Update search path
172133 self.new_db
@@ -211,7 +172,7 @@ impl Test<'_> {
211172}
212173
213174fn print_heading(text: &str) {
214− let delimiter = std::iter::repeat("=").take(80).collect::<String>();
175+ let delimiter = std::iter::repeat("=").take(50).collect::<String>();
215176
216177 println!();
217178 println!();
@@ -230,7 +191,7 @@ fn print_success() {
230191}
231192
232193fn add_spacer(text: &str, char: &str) -> String {
233− const TARGET_WIDTH: usize = 80;
194+ const TARGET_WIDTH: usize = 50;
234195 let num_of_chars = (TARGET_WIDTH - text.len() - 2) / 2;
235196 let spacer = std::iter::repeat(char)
236197 .take(num_of_chars)
@@ -241,6 +202,19 @@ fn add_spacer(text: &str, char: &str) -> String {
241202 format!("{spacer} {text} {spacer}{extra}", spacer = spacer)
242203}
243204
205+pub fn setup() -> (Reshape, Client, Client) {
206+ let connection_string = std::env::var("POSTGRES_CONNECTION_STRING")
207+ .unwrap_or("postgres://postgres:postgres@localhost/reshape_test".to_string());
208+
209+ let old_db = Client::connect(&connection_string, NoTls).unwrap();
210+ let new_db = Client::connect(&connection_string, NoTls).unwrap();
211+
212+ let mut reshape = Reshape::new(&connection_string).unwrap();
213+ reshape.remove().unwrap();
214+
215+ (reshape, old_db, new_db)
216+}
217+
244218pub fn assert_cleaned_up(db: &mut Client) {
245219 // Make sure no temporary columns remain
246220 let temp_columns: Vec<String> = db
tests/complex.rsdeleted−379
@@ -1,379 +0,0 @@
1−mod common;
2−use common::Test;
3−
4−#[test]
5−fn move_column_between_tables() {
6− let mut test = Test::new("Move column between tables");
7−
8− test.first_migration(
9− r#"
10− name = "create_tables"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
16−
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20−
21− [[actions.columns]]
22− name = "email"
23− type = "TEXT"
24−
25− [[actions]]
26− type = "create_table"
27− name = "profiles"
28− primary_key = ["id"]
29−
30− [[actions.columns]]
31− name = "id"
32− type = "INTEGER"
33−
34− [[actions.columns]]
35− name = "user_id"
36− type = "INTEGER"
37− nullable = false
38− "#,
39− );
40−
41− test.second_migration(
42− r#"
43− name = "move_email_column"
44−
45− [[actions]]
46− type = "add_column"
47− table = "profiles"
48−
49− [actions.column]
50− name = "email"
51− type = "TEXT"
52− nullable = false
53−
54− # When `users` is updated in the old schema, we write the email value to `profiles`
55− # When `profiles` is updated in the old schema, the equivalent `users.email` will also be updated
56− [actions.up]
57− table = "users"
58− value = "users.email"
59− where = "profiles.user_id = users.id"
60−
61− [[actions]]
62− type = "remove_column"
63− table = "users"
64− column = "email"
65−
66− # When `profiles` is changed in the new schema, we write the email address back to the removed column
67− [actions.down]
68− table = "profiles"
69− value = "profiles.email"
70− where = "users.id = profiles.user_id"
71− "#,
72− );
73−
74− test.after_first(|db| {
75− db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test1@test.com')")
76− .unwrap();
77− db.simple_query("INSERT INTO users (id, email) VALUES (2, 'test2@test.com')")
78− .unwrap();
79−
80− db.simple_query("INSERT INTO profiles (id, user_id) VALUES (1, 1)")
81− .unwrap();
82− db.simple_query("INSERT INTO profiles (id, user_id) VALUES (2, 2)")
83− .unwrap();
84− });
85−
86− test.intermediate(|old_db, new_db| {
87− // Ensure emails were backfilled into profiles
88− let profiles_emails: Vec<String> = new_db
89− .query(
90− r#"
91− SELECT email
92− FROM profiles
93− ORDER BY id
94− "#,
95− &[],
96− )
97− .unwrap()
98− .iter()
99− .map(|row| row.get("email"))
100− .collect();
101− assert_eq!(vec!("test1@test.com", "test2@test.com"), profiles_emails);
102−
103− // Ensure insert in old schema updates new
104− old_db
105− .simple_query("INSERT INTO users (id, email) VALUES (3, 'test3@test.com')")
106− .unwrap();
107− old_db
108− .simple_query("INSERT INTO profiles (id, user_id) VALUES (3, 3)")
109− .unwrap();
110− let new_email: String = new_db
111− .query("SELECT email FROM profiles WHERE id = 3", &[])
112− .unwrap()
113− .first()
114− .map(|row| row.get("email"))
115− .unwrap();
116− assert_eq!("test3@test.com", new_email);
117−
118− // Ensure updates in old schema updates new
119− old_db
120− .simple_query("UPDATE users SET email = 'test3+updated@test.com' WHERE id = 3")
121− .unwrap();
122− let new_email: String = new_db
123− .query("SELECT email FROM profiles WHERE id = 3", &[])
124− .unwrap()
125− .first()
126− .map(|row| row.get("email"))
127− .unwrap();
128− assert_eq!("test3+updated@test.com", new_email);
129−
130− // Ensure insert in new schema updates old
131− new_db
132− .simple_query(
133− "INSERT INTO profiles (id, user_id, email) VALUES (4, 4, 'test4@test.com')",
134− )
135− .unwrap();
136− new_db
137− .simple_query("INSERT INTO users (id) VALUES (4)")
138− .unwrap();
139− let old_email: String = old_db
140− .query("SELECT email FROM users WHERE id = 4", &[])
141− .unwrap()
142− .first()
143− .map(|row| row.get("email"))
144− .unwrap();
145− assert_eq!("test4@test.com", old_email);
146−
147− // Ensure update in new schema updates old
148− new_db
149− .simple_query("UPDATE profiles SET email = 'test4+updated@test.com' WHERE id = 4")
150− .unwrap();
151− let old_email: String = old_db
152− .query("SELECT email FROM users WHERE id = 4", &[])
153− .unwrap()
154− .first()
155− .map(|row| row.get("email"))
156− .unwrap();
157− assert_eq!("test4+updated@test.com", old_email);
158− });
159−
160− test.run();
161−}
162−
163−#[test]
164−fn extract_relation_into_new_table() {
165− let mut test = Test::new("Extract relation into new table");
166−
167− test.first_migration(
168− r#"
169− name = "create_tables"
170−
171− [[actions]]
172− type = "create_table"
173− name = "accounts"
174− primary_key = ["id"]
175−
176− [[actions.columns]]
177− name = "id"
178− type = "INTEGER"
179−
180− [[actions]]
181− type = "create_table"
182− name = "users"
183− primary_key = ["id"]
184−
185− [[actions.columns]]
186− name = "id"
187− type = "INTEGER"
188−
189− [[actions.columns]]
190− name = "account_id"
191− type = "INTEGER"
192− nullable = false
193−
194− [[actions.columns]]
195− name = "account_role"
196− type = "TEXT"
197− nullable = false
198− "#,
199− );
200−
201− test.second_migration(
202− r#"
203− name = "add_account_user_connection"
204−
205− [[actions]]
206− type = "create_table"
207− name = "user_account_connections"
208− primary_key = ["account_id", "user_id"]
209−
210− [[actions.columns]]
211− name = "account_id"
212− type = "INTEGER"
213−
214− [[actions.columns]]
215− name = "user_id"
216− type = "INTEGER"
217−
218− [[actions.columns]]
219− name = "role"
220− type = "TEXT"
221− nullable = false
222−
223− [actions.up]
224− table = "users"
225− values = { user_id = "id", account_id = "account_id", role = "UPPER(account_role)" }
226− where = "user_account_connections.user_id = users.id"
227−
228− [[actions]]
229− type = "remove_column"
230− table = "users"
231− column = "account_id"
232−
233− [actions.down]
234− table = "user_account_connections"
235− value = "user_account_connections.account_id"
236− where = "users.id = user_account_connections.user_id"
237−
238− [[actions]]
239− type = "remove_column"
240− table = "users"
241− column = "account_role"
242−
243− [actions.down]
244− table = "user_account_connections"
245− value = "LOWER(user_account_connections.role)"
246− where = "users.id = user_account_connections.user_id"
247− "#,
248− );
249−
250− test.after_first(|db| {
251− db.simple_query("INSERT INTO accounts (id) VALUES (1)")
252− .unwrap();
253− db.simple_query("INSERT INTO users (id, account_id, account_role) VALUES (1, 1, 'admin')")
254− .unwrap();
255− });
256−
257− test.intermediate(|old_db, new_db| {
258− // Ensure connections was backfilled
259− let rows: Vec<(i32, i32, String)> = new_db
260− .query(
261− "
262− SELECT account_id, user_id, role
263− FROM user_account_connections
264− ",
265− &[],
266− )
267− .unwrap()
268− .iter()
269− .map(|row| (row.get("account_id"), row.get("user_id"), row.get("role")))
270− .collect();
271− assert_eq!(1, rows.len());
272−
273− let row = rows.first().unwrap();
274− assert_eq!(1, row.0);
275− assert_eq!(1, row.1);
276− assert_eq!("ADMIN", row.2);
277−
278− // Ensure inserted user in old schema creates a new connection
279− old_db
280− .simple_query(
281− "INSERT INTO users (id, account_id, account_role) VALUES (2, 1, 'developer')",
282− )
283− .unwrap();
284− assert!(
285− new_db
286− .query(
287− "
288− SELECT account_id, user_id, role
289− FROM user_account_connections
290− WHERE account_id = 1 AND user_id = 2 AND role = 'DEVELOPER'
291− ",
292− &[],
293− )
294− .unwrap()
295− .len()
296− == 1
297− );
298−
299− // Ensure NOT NULL constraint still applies to old schema
300− let result = old_db
301− .simple_query(
302− "INSERT INTO users (id, account_id, account_role) VALUES (2, NULL, 'developer')",
303− );
304− assert!(result.is_err());
305−
306− // Ensure updated user role in old schema updates connection in new schema
307− old_db
308− .simple_query("UPDATE users SET account_role = 'admin' WHERE id = 2")
309− .unwrap();
310− assert!(
311− new_db
312− .query(
313− "
314− SELECT account_id, user_id, role
315− FROM user_account_connections
316− WHERE account_id = 1 AND user_id = 2 AND role = 'ADMIN'
317− ",
318− &[],
319− )
320− .unwrap()
321− .len()
322− == 1
323− );
324−
325− // Ensure updated connection in new schema updates old schema user
326− new_db
327− .simple_query(
328− "UPDATE user_account_connections SET role = 'DEVELOPER' WHERE account_id = 1 AND user_id = 2",
329− )
330− .unwrap();
331− assert!(
332− old_db
333− .query(
334− "
335− SELECT id
336− FROM users
337− WHERE id = 2 AND account_id = 1 AND account_role = 'developer'
338− ",
339− &[],
340− )
341− .unwrap()
342− .len()
343− == 1
344− );
345−
346− // Ensure insert of user with connection through new schema updates user in old schema
347− new_db
348− .simple_query(
349− r#"
350− BEGIN;
351− INSERT INTO users (id) VALUES (3);
352− INSERT INTO user_account_connections (user_id, account_id, role) VALUES (3, 1, 'DEVELOPER');
353− COMMIT;
354− "#,
355− )
356− .unwrap();
357− new_db
358− .simple_query(
359− "",
360− )
361− .unwrap();
362− assert!(
363− old_db
364− .query(
365− "
366− SELECT id
367− FROM users
368− WHERE id = 3 AND account_id = 1 AND account_role = 'developer'
369− ",
370− &[],
371− )
372− .unwrap()
373− .len()
374− == 1
375− );
376− });
377−
378− test.run();
379−}
tests/create_enum.rsdeleted−41
@@ -1,41 +0,0 @@
1−mod common;
2−use common::Test;
3−
4−#[test]
5−fn create_enum() {
6− let mut test = Test::new("Create enum");
7−
8− test.first_migration(
9− r#"
10− name = "create_enum_and_table"
11−
12− [[actions]]
13− type = "create_enum"
14− name = "mood"
15− values = ["happy", "ok", "sad"]
16−
17− [[actions]]
18− type = "create_table"
19− name = "updates"
20− primary_key = ["id"]
21−
22− [[actions.columns]]
23− name = "id"
24− type = "INTEGER"
25−
26− [[actions.columns]]
27− name = "status"
28− type = "mood"
29− "#,
30− );
31−
32− test.after_first(|db| {
33− // Valid enum values should succeed
34− db.simple_query(
35− "INSERT INTO updates (id, status) VALUES (1, 'happy'), (2, 'ok'), (3, 'sad')",
36− )
37− .unwrap();
38− });
39−
40− test.run();
41−}
tests/create_table.rs+83−81
@@ -1,9 +1,10 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, ForeignKey, Migration};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn create_table() {
6− let mut test = Test::new("Create table");
7+ let mut test = common::Test::new("Create table");
78
89 test.first_migration(
910 r#"
@@ -112,89 +113,90 @@ fn create_table() {
112113
113114#[test]
114115fn create_table_with_foreign_keys() {
115− let mut test = Test::new("Create table");
116−
117− test.first_migration(
118− r#"
119− name = "create_users_table"
120−
121− [[actions]]
122− type = "create_table"
123− name = "users"
124− primary_key = ["id"]
125−
126− [[actions.columns]]
127− name = "id"
128− type = "INTEGER"
129− generated = "ALWAYS AS IDENTITY"
130−
131− [[actions.columns]]
132− name = "name"
133− type = "TEXT"
134−
135− [[actions.columns]]
136− name = "created_at"
137− type = "TIMESTAMP"
138− nullable = false
139− default = "NOW()"
140−
141− [[actions]]
142− type = "create_table"
143− name = "items"
144− primary_key = ["id"]
145−
146− [[actions.columns]]
147− name = "id"
148− type = "INTEGER"
149−
150− [[actions.columns]]
151− name = "user_id"
152− type = "INTEGER"
153− nullable = false
116+ let (mut reshape, mut db, _) = common::setup();
117+
118+ let create_table_migration = Migration::new("create_users_table", None).with_action(
119+ CreateTableBuilder::default()
120+ .name("users")
121+ .primary_key(vec!["id".to_string()])
122+ .columns(vec![ColumnBuilder::default()
123+ .name("id")
124+ .data_type("INTEGER")
125+ .generated("ALWAYS AS IDENTITY")
126+ .build()
127+ .unwrap()])
128+ .build()
129+ .unwrap(),
130+ );
154131
155− [[actions.foreign_keys]]
156− columns = ["user_id"]
157− referenced_table = "users"
158− referenced_columns = ["id"]
159− "#,
132+ let create_second_table_migration = Migration::new("create_items_table", None).with_action(
133+ CreateTableBuilder::default()
134+ .name("items")
135+ .primary_key(vec!["id".to_string()])
136+ .foreign_keys(vec![ForeignKey {
137+ columns: vec!["user_id".to_string()],
138+ referenced_table: "users".to_string(),
139+ referenced_columns: vec!["id".to_string()],
140+ }])
141+ .columns(vec![
142+ ColumnBuilder::default()
143+ .name("id")
144+ .data_type("INTEGER")
145+ .generated("ALWAYS AS IDENTITY")
146+ .build()
147+ .unwrap(),
148+ ColumnBuilder::default()
149+ .name("user_id")
150+ .data_type("INTEGER")
151+ .nullable(false)
152+ .build()
153+ .unwrap(),
154+ ])
155+ .build()
156+ .unwrap(),
160157 );
161158
162− test.after_first(|db| {
163− let foreign_key_columns: Vec<(String, String, String)> = db
164− .query(
165− "
166− SELECT
167− kcu.column_name,
168− ccu.table_name AS foreign_table_name,
169− ccu.column_name AS foreign_column_name
170− FROM
171− information_schema.table_constraints AS tc
172− JOIN information_schema.key_column_usage AS kcu
173− ON tc.constraint_name = kcu.constraint_name
174− AND tc.table_schema = kcu.table_schema
175− JOIN information_schema.constraint_column_usage AS ccu
176− ON ccu.constraint_name = tc.constraint_name
177− AND ccu.table_schema = tc.table_schema
178− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
179− ",
180− &[],
159+ reshape
160+ .migrate(vec![
161+ create_table_migration.clone(),
162+ create_second_table_migration.clone(),
163+ ])
164+ .unwrap();
165+
166+ let foreign_key_columns: Vec<(String, String, String)> = db
167+ .query(
168+ "
169+ SELECT
170+ kcu.column_name,
171+ ccu.table_name AS foreign_table_name,
172+ ccu.column_name AS foreign_column_name
173+ FROM
174+ information_schema.table_constraints AS tc
175+ JOIN information_schema.key_column_usage AS kcu
176+ ON tc.constraint_name = kcu.constraint_name
177+ AND tc.table_schema = kcu.table_schema
178+ JOIN information_schema.constraint_column_usage AS ccu
179+ ON ccu.constraint_name = tc.constraint_name
180+ AND ccu.table_schema = tc.table_schema
181+ WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
182+ ",
183+ &[],
184+ )
185+ .unwrap()
186+ .iter()
187+ .map(|row| {
188+ (
189+ row.get("column_name"),
190+ row.get("foreign_table_name"),
191+ row.get("foreign_column_name"),
181192 )
182− .unwrap()
183− .iter()
184− .map(|row| {
185− (
186− row.get("column_name"),
187− row.get("foreign_table_name"),
188− row.get("foreign_column_name"),
189− )
190− })
191− .collect();
193+ })
194+ .collect();
192195
193− assert_eq!(
194− vec![("user_id".to_string(), "users".to_string(), "id".to_string())],
195− foreign_key_columns
196− );
197− });
196+ assert_eq!(
197+ vec![("user_id".to_string(), "users".to_string(), "id".to_string())],
198+ foreign_key_columns
199+ );
198200
199− test.run();
201+ common::assert_cleaned_up(&mut db);
200202}
tests/custom.rsdeleted−128
@@ -1,128 +0,0 @@
1−mod common;
2−use common::Test;
3−
4−#[test]
5−fn custom_enable_extension() {
6− let mut test = Test::new("Custom migration");
7−
8− test.clear(|db| {
9− db.simple_query(
10− "
11− DROP EXTENSION IF EXISTS bloom;
12− DROP EXTENSION IF EXISTS btree_gin;
13− DROP EXTENSION IF EXISTS btree_gist;
14− ",
15− )
16− .unwrap();
17− });
18−
19− test.first_migration(
20− r#"
21− name = "empty_migration"
22−
23− [[actions]]
24− type = "custom"
25− "#,
26− );
27−
28− test.second_migration(
29− r#"
30− name = "enable_extensions"
31−
32− [[actions]]
33− type = "custom"
34−
35− start = """
36− CREATE EXTENSION IF NOT EXISTS bloom;
37− CREATE EXTENSION IF NOT EXISTS btree_gin;
38− """
39−
40− complete = "CREATE EXTENSION IF NOT EXISTS btree_gist"
41−
42− abort = """
43− DROP EXTENSION IF EXISTS bloom;
44− DROP EXTENSION IF EXISTS btree_gin;
45− """
46− "#,
47− );
48−
49− test.intermediate(|db, _| {
50− let bloom_activated = !db
51− .query("SELECT * FROM pg_extension WHERE extname = 'bloom'", &[])
52− .unwrap()
53− .is_empty();
54− assert!(bloom_activated);
55−
56− let btree_gin_activated = !db
57− .query(
58− "SELECT * FROM pg_extension WHERE extname = 'btree_gin'",
59− &[],
60− )
61− .unwrap()
62− .is_empty();
63− assert!(btree_gin_activated);
64−
65− let btree_gist_activated = !db
66− .query(
67− "SELECT * FROM pg_extension WHERE extname = 'btree_gist'",
68− &[],
69− )
70− .unwrap()
71− .is_empty();
72− assert!(!btree_gist_activated);
73− });
74−
75− test.after_completion(|db| {
76− let bloom_activated = !db
77− .query("SELECT * FROM pg_extension WHERE extname = 'bloom'", &[])
78− .unwrap()
79− .is_empty();
80− assert!(bloom_activated);
81−
82− let btree_gin_activated = !db
83− .query(
84− "SELECT * FROM pg_extension WHERE extname = 'btree_gin'",
85− &[],
86− )
87− .unwrap()
88− .is_empty();
89− assert!(btree_gin_activated);
90−
91− let btree_gist_activated = !db
92− .query(
93− "SELECT * FROM pg_extension WHERE extname = 'btree_gist'",
94− &[],
95− )
96− .unwrap()
97− .is_empty();
98− assert!(btree_gist_activated);
99− });
100−
101− test.after_abort(|db| {
102− let bloom_activated = !db
103− .query("SELECT * FROM pg_extension WHERE extname = 'bloom'", &[])
104− .unwrap()
105− .is_empty();
106− assert!(!bloom_activated);
107−
108− let btree_gin_activated = !db
109− .query(
110− "SELECT * FROM pg_extension WHERE extname = 'btree_gin'",
111− &[],
112− )
113− .unwrap()
114− .is_empty();
115− assert!(!btree_gin_activated);
116−
117− let btree_gist_activated = !db
118− .query(
119− "SELECT * FROM pg_extension WHERE extname = 'btree_gist'",
120− &[],
121− )
122− .unwrap()
123− .is_empty();
124− assert!(!btree_gist_activated);
125− });
126−
127− test.run();
128−}
tests/failure.rs+58−34
@@ -1,51 +1,75 @@
1+use reshape::migrations::{AddColumn, Column, ColumnBuilder, CreateTableBuilder, Migration};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn invalid_migration() {
6− let mut test = Test::new("Invalid migration");
7−
8− test.first_migration(
9− r#"
10− name = "invalid_migration"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
168
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20− "#,
9+ let create_users_table = Migration::new("create_users_table", None).with_action(
10+ CreateTableBuilder::default()
11+ .name("users")
12+ .primary_key(vec!["id".to_string()])
13+ .columns(vec![
14+ ColumnBuilder::default()
15+ .name("id")
16+ .data_type("INTEGER")
17+ .build()
18+ .unwrap(),
19+ ColumnBuilder::default()
20+ .name("name")
21+ .data_type("TEXT")
22+ .build()
23+ .unwrap(),
24+ ])
25+ .build()
26+ .unwrap(),
2127 );
28+ let add_first_column = Migration::new("add_first_column", None).with_action(AddColumn {
29+ table: "users".to_string(),
30+ column: Column {
31+ name: "first".to_string(),
32+ data_type: "TEXT".to_string(),
33+ nullable: false,
34+ default: None,
35+ generated: None,
36+ },
37+ up: Some("INVALID SQL".to_string()),
38+ });
2239
23− test.second_migration(
24− r#"
25− name = "add_invalid_column"
26−
27− [[actions]]
28− type = "add_column"
29− table = "users"
40+ let first_migrations = vec![create_users_table.clone()];
41+ let second_migrations = vec![create_users_table.clone(), add_first_column.clone()];
3042
31− up = "INVALID SQL"
43+ // Run first migration, should automatically finish
44+ reshape.migrate(first_migrations.clone()).unwrap();
3245
33− [actions.column]
34− name = "first"
35− type = "TEXT"
36− "#,
37− );
46+ // Update search paths
47+ old_db
48+ .simple_query(&reshape::schema_query_for_migration(
49+ &first_migrations.last().unwrap().name,
50+ ))
51+ .unwrap();
52+ new_db
53+ .simple_query(&reshape::schema_query_for_migration(
54+ &first_migrations.last().unwrap().name,
55+ ))
56+ .unwrap();
3857
3958 // Insert a test user
40− test.after_first(|db| {
41− db.simple_query(
59+ new_db
60+ .simple_query(
4261 "
43− INSERT INTO users (id) VALUES (1)
62+ INSERT INTO users (id, name) VALUES
63+ (1, 'John Doe')
4464 ",
4565 )
4666 .unwrap();
47− });
4867
49− test.expect_failure();
50− test.run();
68+ // Run second migration and ensure it fails
69+ assert!(
70+ reshape.migrate(second_migrations.clone()).is_err(),
71+ "invalid migration succeeded"
72+ );
73+
74+ common::assert_cleaned_up(&mut new_db);
5175}
tests/remove_column.rs+73−209
@@ -1,217 +1,81 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, Migration, RemoveColumn};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn remove_column() {
6− let mut test = Test::new("Remove column");
7−
8− test.first_migration(
9− r#"
10− name = "create_user_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
16−
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20−
21− [[actions.columns]]
22− name = "name"
23− type = "TEXT"
24− "#,
25− );
26−
27− test.second_migration(
28− r#"
29− name = "remove_name_column"
30−
31− [[actions]]
32− type = "remove_column"
33− table = "users"
34− column = "name"
35− down = "'TEST_DOWN_VALUE'"
36− "#,
37− );
38−
39− test.intermediate(|old_db, new_db| {
40− // Insert using old schema and ensure it can be retrieved through new schema
41− old_db
42− .simple_query("INSERT INTO users(id, name) VALUES (1, 'John Doe')")
43− .unwrap();
44− let results = new_db
45− .query("SELECT id FROM users WHERE id = 1", &[])
46− .unwrap();
47− assert_eq!(1, results.len());
48− assert_eq!(1, results[0].get::<_, i32>("id"));
49−
50− // Ensure the name column is not accesible through the new schema
51− assert!(new_db.query("SELECT id, name FROM users", &[]).is_err());
52−
53− // Insert using new schema and ensure the down function is correctly applied
54− new_db
55− .simple_query("INSERT INTO users(id) VALUES (2)")
56− .unwrap();
57− let result = old_db
58− .query_opt("SELECT name FROM users WHERE id = 2", &[])
59− .unwrap();
60− assert_eq!(
61− Some("TEST_DOWN_VALUE"),
62− result.as_ref().map(|row| row.get("name"))
63− );
64− });
65−
66− test.run();
67−}
68−
69−#[test]
70−fn remove_column_with_index() {
71− let mut test = Test::new("Remove column");
72−
73− test.first_migration(
74− r#"
75− name = "create_user_table"
76−
77− [[actions]]
78− type = "create_table"
79− name = "users"
80− primary_key = ["id"]
81−
82− [[actions.columns]]
83− name = "id"
84− type = "INTEGER"
85−
86− [[actions.columns]]
87− name = "name"
88− type = "TEXT"
89−
90− [[actions]]
91− type = "add_index"
92− table = "users"
93−
94− [actions.index]
95− name = "name_idx"
96− columns = ["name"]
97− "#,
98− );
99−
100− test.second_migration(
101− r#"
102− name = "remove_name_column"
103−
104− [[actions]]
105− type = "remove_column"
106− table = "users"
107− column = "name"
108− down = "'TEST_DOWN_VALUE'"
109− "#,
110− );
111−
112− test.after_completion(|db| {
113− // Ensure index has been removed after the migration is complete
114− let count: i64 = db
115− .query(
116− "
117− SELECT COUNT(*)
118− FROM pg_catalog.pg_index
119− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
120− WHERE pg_class.relname = 'name_idx'
121− ",
122− &[],
123− )
124− .unwrap()
125− .first()
126− .map(|row| row.get(0))
127− .unwrap();
128−
129− assert_eq!(0, count, "expected index to not exist");
130− });
131−
132− test.run();
133−}
134−
135−#[test]
136−fn remove_column_with_complex_down() {
137− let mut test = Test::new("Remove column complex");
138−
139− test.first_migration(
140− r#"
141− name = "create_tables"
142−
143− [[actions]]
144− type = "create_table"
145− name = "users"
146− primary_key = ["id"]
147−
148− [[actions.columns]]
149− name = "id"
150− type = "INTEGER"
151−
152− [[actions.columns]]
153− name = "email"
154− type = "TEXT"
155−
156− [[actions]]
157− type = "create_table"
158− name = "profiles"
159− primary_key = ["user_id"]
160−
161− [[actions.columns]]
162− name = "user_id"
163− type = "INTEGER"
164−
165− [[actions.columns]]
166− name = "email"
167− type = "TEXT"
168− "#,
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
8+
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
10+ CreateTableBuilder::default()
11+ .name("users")
12+ .primary_key(vec!["id".to_string()])
13+ .columns(vec![
14+ ColumnBuilder::default()
15+ .name("id")
16+ .data_type("INTEGER")
17+ .build()
18+ .unwrap(),
19+ ColumnBuilder::default()
20+ .name("name")
21+ .data_type("TEXT")
22+ .nullable(false)
23+ .build()
24+ .unwrap(),
25+ ])
26+ .build()
27+ .unwrap(),
16928 );
170−
171− test.second_migration(
172− r#"
173− name = "remove_users_email_column"
174−
175− [[actions]]
176− type = "remove_column"
177− table = "users"
178− column = "email"
179−
180− [actions.down]
181− table = "profiles"
182− value = "profiles.email"
183− where = "users.id = profiles.user_id"
184− "#,
29+ let remove_column_migration =
30+ Migration::new("remove_name_column", None).with_action(RemoveColumn {
31+ table: "users".to_string(),
32+ column: "name".to_string(),
33+ down: Some("'TEST_DOWN_VALUE'".to_string()),
34+ });
35+
36+ let first_migrations = vec![create_table_migration.clone()];
37+ let second_migrations = vec![
38+ create_table_migration.clone(),
39+ remove_column_migration.clone(),
40+ ];
41+
42+ // Run migrations
43+ reshape.migrate(first_migrations.clone()).unwrap();
44+ reshape.migrate(second_migrations.clone()).unwrap();
45+
46+ // Update schemas of Postgres connections
47+ let old_schema_query =
48+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
49+ let new_schema_query =
50+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
51+ old_db.simple_query(&old_schema_query).unwrap();
52+ new_db.simple_query(&new_schema_query).unwrap();
53+
54+ // Insert using old schema and ensure it can be retrieved through new schema
55+ old_db
56+ .simple_query("INSERT INTO users(id, name) VALUES (1, 'John Doe')")
57+ .unwrap();
58+ let results = new_db
59+ .query("SELECT id FROM users WHERE id = 1", &[])
60+ .unwrap();
61+ assert_eq!(1, results.len());
62+ assert_eq!(1, results[0].get::<_, i32>("id"));
63+
64+ // Ensure the name column is not accesible through the new schema
65+ assert!(new_db.query("SELECT id, name FROM users", &[]).is_err());
66+
67+ // Insert using new schema and ensure the down function is correctly applied
68+ new_db
69+ .simple_query("INSERT INTO users(id) VALUES (2)")
70+ .unwrap();
71+ let result = old_db
72+ .query_opt("SELECT name FROM users WHERE id = 2", &[])
73+ .unwrap();
74+ assert_eq!(
75+ Some("TEST_DOWN_VALUE"),
76+ result.as_ref().map(|row| row.get("name"))
18577 );
18678
187− test.after_first(|db| {
188− db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test@example.com')")
189− .unwrap();
190− db.simple_query("INSERT INTO profiles (user_id, email) VALUES (1, 'test@example.com')")
191− .unwrap();
192− });
193−
194− test.intermediate(|old_db, new_db| {
195− new_db
196− .simple_query("UPDATE profiles SET email = 'test2@example.com' WHERE user_id = 1")
197− .unwrap();
198−
199− // Ensure new email was propagated to users table in old schema
200− let email: String = old_db
201− .query(
202− "
203− SELECT email
204− FROM users
205− WHERE id = 1
206− ",
207− &[],
208− )
209− .unwrap()
210− .first()
211− .map(|row| row.get("email"))
212− .unwrap();
213− assert_eq!("test2@example.com", email);
214− });
215−
216− test.run();
79+ reshape.complete().unwrap();
80+ common::assert_cleaned_up(&mut new_db);
21781}
tests/remove_enum.rsdeleted−69
@@ -1,69 +0,0 @@
1−mod common;
2−use common::Test;
3−
4−#[test]
5−fn remove_enum() {
6− let mut test = Test::new("Remove enum");
7−
8− test.first_migration(
9− r#"
10− name = "create_enum"
11−
12− [[actions]]
13− type = "create_enum"
14− name = "mood"
15− values = ["happy", "ok", "sad"]
16− "#,
17− );
18−
19− test.second_migration(
20− r#"
21− name = "remove_enum"
22−
23− [[actions]]
24− type = "remove_enum"
25− enum = "mood"
26− "#,
27− );
28−
29− test.after_first(|db| {
30− // Ensure enum was created
31− let enum_exists = !db
32− .query(
33− "
34− SELECT typname
35− FROM pg_catalog.pg_type
36− WHERE typcategory = 'E'
37− AND typname = 'mood'
38− ",
39− &[],
40− )
41− .unwrap()
42− .is_empty();
43−
44− assert!(enum_exists, "expected mood enum to have been created");
45− });
46−
47− test.after_completion(|db| {
48− // Ensure enum was removed after completion
49− let enum_does_not_exist = db
50− .query(
51− "
52− SELECT typname
53− FROM pg_catalog.pg_type
54− WHERE typcategory = 'E'
55− AND typname = 'mood'
56− ",
57− &[],
58− )
59− .unwrap()
60− .is_empty();
61−
62− assert!(
63− enum_does_not_exist,
64− "expected mood enum to have been removed"
65− );
66− });
67−
68− test.run();
69−}
tests/remove_foreign_key.rsdeleted−124
@@ -1,124 +0,0 @@
1−mod common;
2−use common::Test;
3−
4−#[test]
5−fn remove_foreign_key() {
6− let mut test = Test::new("Remove foreign key");
7−
8− test.first_migration(
9− r#"
10− name = "create_tables"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
16−
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20−
21− [[actions]]
22− type = "create_table"
23− name = "items"
24− primary_key = ["id"]
25−
26− [[actions.columns]]
27− name = "id"
28− type = "INTEGER"
29−
30− [[actions.columns]]
31− name = "user_id"
32− type = "INTEGER"
33−
34− [[actions.foreign_keys]]
35− columns = ["user_id"]
36− referenced_table = "users"
37− referenced_columns = ["id"]
38− "#,
39− );
40−
41− test.second_migration(
42− r#"
43− name = "remove_foreign_key"
44−
45− [[actions]]
46− type = "remove_foreign_key"
47− table = "items"
48− foreign_key = "items_user_id_fkey"
49− "#,
50− );
51−
52− test.after_first(|db| {
53− // Insert some test users
54− db.simple_query("INSERT INTO users (id) VALUES (1), (2)")
55− .unwrap();
56− });
57−
58− test.intermediate(|old_db, new_db| {
59− // Ensure items can't be inserted if they don't reference valid users
60− // The foreign key is only removed when the migration is completed so
61− // it should still be enforced for the new and old schema.
62− let result = old_db.simple_query("INSERT INTO items (id, user_id) VALUES (3, 3)");
63− assert!(
64− result.is_err(),
65− "expected insert against old schema to fail"
66− );
67−
68− let result = new_db.simple_query("INSERT INTO items (id, user_id) VALUES (3, 3)");
69− assert!(
70− result.is_err(),
71− "expected insert against new schema to fail"
72− );
73− });
74−
75− test.after_completion(|db| {
76− // Ensure items can be inserted even if they don't reference valid users
77− let result = db
78− .simple_query("INSERT INTO items (id, user_id) VALUES (5, 3)")
79− .map(|_| ());
80− assert!(
81− result.is_ok(),
82− "expected insert to not fail, got {:?}",
83− result
84− );
85−
86− // Ensure foreign key doesn't exist
87− let foreign_keys = db
88− .query(
89− "
90− SELECT tc.constraint_name
91− FROM information_schema.table_constraints AS tc
92− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
93− ",
94− &[],
95− )
96− .unwrap();
97− assert!(
98− foreign_keys.is_empty(),
99− "expected no foreign keys to exist on items table"
100− );
101− });
102−
103− test.after_abort(|db| {
104− // Ensure items can't be inserted if they don't reference valid users
105− let result = db.simple_query("INSERT INTO items (id, user_id) VALUES (3, 3)");
106− assert!(result.is_err(), "expected insert to fail");
107−
108− // Ensure foreign key still exists
109− let fk_exists = !db
110− .query(
111− "
112− SELECT tc.constraint_name
113− FROM information_schema.table_constraints AS tc
114− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
115− ",
116− &[],
117− )
118− .unwrap()
119− .is_empty();
120− assert!(fk_exists);
121− });
122−
123− test.run()
124−}
tests/remove_index.rs+97−68
@@ -1,86 +1,115 @@
1+use reshape::migrations::{
2+ AddIndex, ColumnBuilder, CreateTableBuilder, Index, Migration, RemoveIndex,
3+};
4+
15mod common;
2−use common::Test;
36
47#[test]
58fn remove_index() {
6− let mut test = Test::new("Remove index");
9+ let (mut reshape, _, mut db) = common::setup();
710
8− test.first_migration(
9− r#"
10− name = "create_users_table"
11+ let create_table_migration = Migration::new("create_user_table", None)
12+ .with_action(
13+ CreateTableBuilder::default()
14+ .name("users")
15+ .primary_key(vec!["id".to_string()])
16+ .columns(vec![
17+ ColumnBuilder::default()
18+ .name("id")
19+ .data_type("INTEGER")
20+ .build()
21+ .unwrap(),
22+ ColumnBuilder::default()
23+ .name("name")
24+ .data_type("TEXT")
25+ .build()
26+ .unwrap(),
27+ ])
28+ .build()
29+ .unwrap(),
30+ )
31+ .with_action(AddIndex {
32+ table: "users".to_string(),
33+ index: Index {
34+ name: "name_idx".to_string(),
35+ columns: vec!["name".to_string()],
36+ unique: false,
37+ index_type: None,
38+ },
39+ });
1140
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
41+ let remove_index_migration =
42+ Migration::new("remove_name_index", None).with_action(RemoveIndex {
43+ index: "name_idx".to_string(),
44+ });
1645
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
46+ let first_migrations = vec![create_table_migration.clone()];
47+ let second_migrations = vec![
48+ create_table_migration.clone(),
49+ remove_index_migration.clone(),
50+ ];
2051
21− [[actions.columns]]
22− name = "name"
23− type = "TEXT"
52+ // Run migrations
53+ reshape.migrate(first_migrations.clone()).unwrap();
2454
25− [[actions]]
26− type = "add_index"
27− table = "users"
55+ // Ensure index is valid and ready
56+ let result: Vec<(bool, bool)> = db
57+ .query(
58+ "
59+ SELECT pg_index.indisready, pg_index.indisvalid
60+ FROM pg_catalog.pg_index
61+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
62+ WHERE pg_class.relname = 'name_idx'
63+ ",
64+ &[],
65+ )
66+ .unwrap()
67+ .iter()
68+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
69+ .collect();
2870
29− [actions.index]
30− name = "name_idx"
31− columns = ["name"]
32− "#,
33− );
71+ assert_eq!(vec![(true, true)], result);
3472
35− test.second_migration(
36− r#"
37− name = "remove_name_index"
73+ // Run migration to remove index
74+ reshape.migrate(second_migrations.clone()).unwrap();
3875
39− [[actions]]
40− type = "remove_index"
41− index = "name_idx"
42− "#,
43− );
76+ // Ensure index is still valid and ready during the migration
77+ let result: Vec<(bool, bool)> = db
78+ .query(
79+ "
80+ SELECT pg_index.indisready, pg_index.indisvalid
81+ FROM pg_catalog.pg_index
82+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
83+ WHERE pg_class.relname = 'name_idx'
84+ ",
85+ &[],
86+ )
87+ .unwrap()
88+ .iter()
89+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
90+ .collect();
4491
45− test.intermediate(|db, _| {
46− // Ensure index is still valid and ready during the migration
47− let result: Vec<(bool, bool)> = db
48− .query(
49− "
50− SELECT pg_index.indisready, pg_index.indisvalid
51− FROM pg_catalog.pg_index
52− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
53− WHERE pg_class.relname = 'name_idx'
54− ",
55− &[],
56− )
57− .unwrap()
58− .iter()
59− .map(|row| (row.get("indisready"), row.get("indisvalid")))
60− .collect();
92+ assert_eq!(vec![(true, true)], result);
6193
62− assert_eq!(vec![(true, true)], result);
63− });
94+ reshape.complete().unwrap();
6495
65− test.after_completion(|db| {
66− // Ensure index has been removed after the migration is complete
67− let count: i64 = db
68− .query(
69− "
70− SELECT COUNT(*)
71− FROM pg_catalog.pg_index
72− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
73− WHERE pg_class.relname = 'name_idx'
74− ",
75− &[],
76− )
77− .unwrap()
78− .first()
79− .map(|row| row.get(0))
80− .unwrap();
96+ // Ensure index has been removed after the migration is complete
97+ let count: i64 = db
98+ .query(
99+ "
100+ SELECT COUNT(*)
101+ FROM pg_catalog.pg_index
102+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
103+ WHERE pg_class.relname = 'name_idx'
104+ ",
105+ &[],
106+ )
107+ .unwrap()
108+ .first()
109+ .map(|row| row.get(0))
110+ .unwrap();
81111
82− assert_eq!(0, count, "expected index to not exist");
83− });
112+ assert_eq!(0, count, "expected index to not exist");
84113
85− test.run();
114+ common::assert_cleaned_up(&mut db);
86115}
tests/remove_table.rs+48−38
@@ -1,44 +1,54 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, Migration, RemoveTable};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn remove_table() {
6− let mut test = Test::new("Remove table");
7−
8− test.first_migration(
9− r#"
10− name = "create_users_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
16−
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20− "#,
21− );
22−
23− test.second_migration(
24− r#"
25− name = "remove_users_table"
26−
27− [[actions]]
28− type = "remove_table"
29− table = "users"
30− "#,
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
8+
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
10+ CreateTableBuilder::default()
11+ .name("users")
12+ .primary_key(vec!["id".to_string()])
13+ .columns(vec![ColumnBuilder::default()
14+ .name("id")
15+ .data_type("INTEGER")
16+ .build()
17+ .unwrap()])
18+ .build()
19+ .unwrap(),
3120 );
32−
33− test.intermediate(|old_db, new_db| {
34− // Make sure inserts work against the old schema
35− old_db
36− .simple_query("INSERT INTO users(id) VALUES (1)")
37− .unwrap();
38−
39− // Ensure the table is not accessible through the new schema
40− assert!(new_db.query("SELECT id FROM users", &[]).is_err());
41− });
42−
43− test.run();
21+ let remove_table_migration =
22+ Migration::new("remove_users_table", None).with_action(RemoveTable {
23+ table: "users".to_string(),
24+ });
25+
26+ let first_migrations = vec![create_table_migration.clone()];
27+ let second_migrations = vec![
28+ create_table_migration.clone(),
29+ remove_table_migration.clone(),
30+ ];
31+
32+ // Run migrations
33+ reshape.migrate(first_migrations.clone()).unwrap();
34+ reshape.migrate(second_migrations.clone()).unwrap();
35+
36+ // Update schemas of Postgres connections
37+ let old_schema_query =
38+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
39+ let new_schema_query =
40+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
41+ old_db.simple_query(&old_schema_query).unwrap();
42+ new_db.simple_query(&new_schema_query).unwrap();
43+
44+ // Make sure inserts work against the old schema
45+ old_db
46+ .simple_query("INSERT INTO users(id) VALUES (1)")
47+ .unwrap();
48+
49+ // Ensure the table is not accessible through the new schema
50+ assert!(new_db.query("SELECT id FROM users", &[]).is_err());
51+
52+ reshape.complete().unwrap();
53+ common::assert_cleaned_up(&mut new_db);
4454}
tests/rename_table.rs+66−56
@@ -1,70 +1,80 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, Migration, RenameTable};
2+
13mod common;
2−use common::Test;
34
45#[test]
56fn rename_table() {
6− let mut test = Test::new("Rename table");
7−
8− test.first_migration(
9− r#"
10− name = "create_users_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
15− primary_key = ["id"]
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
168
17− [[actions.columns]]
18− name = "id"
19− type = "INTEGER"
20− "#,
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
10+ CreateTableBuilder::default()
11+ .name("users")
12+ .primary_key(vec!["id".to_string()])
13+ .columns(vec![ColumnBuilder::default()
14+ .name("id")
15+ .data_type("INTEGER")
16+ .build()
17+ .unwrap()])
18+ .build()
19+ .unwrap(),
2120 );
21+ let rename_table_migration = Migration::new("rename_users_table_to_customers", None)
22+ .with_action(RenameTable {
23+ table: "users".to_string(),
24+ new_name: "customers".to_string(),
25+ });
2226
23− test.second_migration(
24− r#"
25− name = "rename_users_table_to_customers"
27+ let first_migrations = vec![create_table_migration.clone()];
28+ let second_migrations = vec![
29+ create_table_migration.clone(),
30+ rename_table_migration.clone(),
31+ ];
2632
27− [[actions]]
28− type = "rename_table"
29− table = "users"
30− new_name = "customers"
31− "#,
32− );
33+ // Run migrations
34+ reshape.migrate(first_migrations.clone()).unwrap();
35+ reshape.migrate(second_migrations.clone()).unwrap();
36+
37+ // Update schemas of Postgres connections
38+ let old_schema_query =
39+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
40+ let new_schema_query =
41+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
42+ old_db.simple_query(&old_schema_query).unwrap();
43+ new_db.simple_query(&new_schema_query).unwrap();
3344
34− test.intermediate(|old_db, new_db| {
35− // Make sure inserts work using both the old and new name
45+ // Make sure inserts work using both the old and new name
46+ old_db
47+ .simple_query("INSERT INTO users(id) VALUES (1)")
48+ .unwrap();
49+ new_db
50+ .simple_query("INSERT INTO customers(id) VALUES (2)")
51+ .unwrap();
52+
53+ // Ensure the table can be queried using both the old and new name
54+ let expected: Vec<i32> = vec![1, 2];
55+ assert_eq!(
56+ expected,
3657 old_db
37− .simple_query("INSERT INTO users(id) VALUES (1)")
38− .unwrap();
58+ .query("SELECT id FROM users ORDER BY id", &[])
59+ .unwrap()
60+ .iter()
61+ .map(|row| row.get::<_, i32>("id"))
62+ .collect::<Vec<i32>>()
63+ );
64+ assert_eq!(
65+ expected,
3966 new_db
40− .simple_query("INSERT INTO customers(id) VALUES (2)")
41− .unwrap();
42−
43− // Ensure the table can be queried using both the old and new name
44− let expected: Vec<i32> = vec![1, 2];
45− assert_eq!(
46− expected,
47− old_db
48− .query("SELECT id FROM users ORDER BY id", &[])
49− .unwrap()
50− .iter()
51− .map(|row| row.get::<_, i32>("id"))
52− .collect::<Vec<i32>>()
53− );
54− assert_eq!(
55− expected,
56− new_db
57− .query("SELECT id FROM customers ORDER BY id", &[])
58− .unwrap()
59− .iter()
60− .map(|row| row.get::<_, i32>("id"))
61− .collect::<Vec<i32>>()
62− );
67+ .query("SELECT id FROM customers ORDER BY id", &[])
68+ .unwrap()
69+ .iter()
70+ .map(|row| row.get::<_, i32>("id"))
71+ .collect::<Vec<i32>>()
72+ );
6373
64− // Ensure the table can't be queried using the wrong name for the schema
65− assert!(old_db.simple_query("SELECT id FROM customers").is_err());
66− assert!(new_db.simple_query("SELECT id FROM users").is_err());
67− });
74+ // Ensure the table can't be queried using the wrong name for the schema
75+ assert!(old_db.simple_query("SELECT id FROM customers").is_err());
76+ assert!(new_db.simple_query("SELECT id FROM users").is_err());
6877
69− test.run();
78+ reshape.complete().unwrap();
79+ common::assert_cleaned_up(&mut new_db);
7080}