on b3ead8b help sign in
.github/workflows/lint.yaml+3−6
since splitsnapshots
unifiedsplit
@@ -3,9 +3,6 @@ name: Lint
3on:
3on:
4 push:
4 push:
5 branches: [ main ]
5 branches: [ main ]
6− pull_request:
7− branches:
8− - main
9
6
10env:
7env:
11 CARGO_TERM_COLOR: always
8 CARGO_TERM_COLOR: always
@@ -15,7 +12,7 @@ jobs:
15 runs-on: ubuntu-latest
12 runs-on: ubuntu-latest
16 steps:
13 steps:
17 - name: Checkout
14 - name: Checkout
18− uses: actions/checkout@v4
15+ uses: actions/checkout@v2
19 - name: Select Rust toolchain with Clippy
16 - name: Select Rust toolchain with Clippy
20 uses: actions-rs/toolchain@v1
17 uses: actions-rs/toolchain@v1
21 with:
18 with:
@@ -23,6 +20,6 @@ jobs:
23 components: clippy
20 components: clippy
24 override: true
21 override: true
25 - name: Use cache for Rust dependencies
22 - name: Use cache for Rust dependencies
26− uses: Swatinem/rust-cache@v2
23+ uses: Swatinem/rust-cache@v1
27 - name: Lint using Clippy
24 - name: Lint using Clippy
28− run: cargo clippy
25+ 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
.github/workflows/test.yaml−3
@@ -3,9 +3,6 @@ name: Tests
3on:
3on:
4 push:
4 push:
5 branches: [ main ]
5 branches: [ main ]
6− pull_request:
7− branches:
8− - main
9
6
10env:
7env:
11 CARGO_TERM_COLOR: always
8 CARGO_TERM_COLOR: always
Cargo.toml+3−6
@@ -1,6 +1,6 @@
1[package]
1[package]
2name = "reshape"
2name = "reshape"
3−version = "0.7.0"
3+version = "0.2.0"
4description = "An easy-to-use, zero-downtime schema migration tool for Postgres"
4description = "An easy-to-use, zero-downtime schema migration tool for Postgres"
5homepage = "https://github.com/fabianlindfors/reshape"
5homepage = "https://github.com/fabianlindfors/reshape"
6documentation = "https://github.com/fabianlindfors/reshape"
6documentation = "https://github.com/fabianlindfors/reshape"
@@ -9,7 +9,6 @@ license = "MIT"
9keywords = ["postgres", "migrations"]
9keywords = ["postgres", "migrations"]
10edition = "2021"
10edition = "2021"
11authors = ["Fabian Lindfors"]
11authors = ["Fabian Lindfors"]
12−rust-version = "1.70"
13
12
14[dependencies]
13[dependencies]
15postgres = { version = "0.19.2", features = ["with-serde_json-1"] }
14postgres = { version = "0.19.2", features = ["with-serde_json-1"] }
@@ -17,10 +16,8 @@ serde = { version = "1.0", features = ["derive"] }
17serde_json = "1.0"
16serde_json = "1.0"
18typetag = "0.1.7"
17typetag = "0.1.7"
19anyhow = { version = "1.0.44", features = ["backtrace"] }
18anyhow = { version = "1.0.44", features = ["backtrace"] }
20−clap = { version = "3.1.9", features = ["derive"] }
19+clap = { version = "3.0.0", features = ["derive"] }
21toml = "0.5"
20toml = "0.5"
22version = "3.0.0"
21version = "3.0.0"
23colored = "2"
22colored = "2"
24−rand = "0.8"
23+"derive_builder" = "0.10.2"
25−dotenv = "0.15.0"
26−lexical-sort = "0.3.1"
Dockerfile+1−1
@@ -1,4 +1,4 @@
1−FROM rust:1.70.0 AS builder
1+FROM rust:1.57.0 AS builder
2WORKDIR /usr/src/reshape
2WORKDIR /usr/src/reshape
3COPY . .
3COPY . .
4RUN cargo build --release
4RUN cargo build --release
README.md+82−377
@@ -2,56 +2,50 @@
2
2
3[![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)
3[![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)
4
4
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.
6
6
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.
8
8
9−Designed for Postgres 12 and later.
9+*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) destroy your data and break your application.*
10
10
11- [How it works](#how-it-works)
11- [How it works](#how-it-works)
12- [Getting started](#getting-started)
12- [Getting started](#getting-started)
13− - [Installation](#installation)
13+ - [Installation](#installation)
14− - [Creating your first migration](#creating-your-first-migration)
14+ - [Creating your first migration](#creating-your-first-migration)
15− - [Preparing your application](#preparing-your-application)
15+ - [Preparing your application](#preparing-your-application)
16− - [Running your migration](#running-your-migration)
16+ - [Running your migration](#running-your-migration)
17− - [Using during development](#using-during-development)
17+ - [Using during development](#using-during-development)
18- [Writing migrations](#writing-migrations)
18- [Writing migrations](#writing-migrations)
19− - [Basics](#basics)
19+ - [Basics](#basics)
20− - [Tables](#tables)
20+ - [Tables](#tables)
21− - [Create table](#create-table)
21+ - [Create table](#create-table)
22− - [Rename table](#rename-table)
22+ - [Rename table](#rename-table)
23− - [Remove table](#remove-table)
23+ - [Remove table](#remove-table)
24− - [Add foreign key](#add-foreign-key)
25− - [Remove foreign key](#remove-foreign-key)
26− - [Columns](#columns)
24+ - [Columns](#columns)
27− - [Add column](#add-column)
25+ - [Add column](#add-column)
28− - [Alter column](#alter-column)
26+ - [Alter column](#alter-column)
29− - [Remove column](#remove-column)
27+ - [Remove column](#remove-column)
30− - [Indices](#indices)
28+ - [Indices](#indices)
31− - [Add index](#add-index)
29+ - [Add index](#add-index)
32− - [Remove index](#remove-index)
30+ - [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)
38- [Commands and options](#commands-and-options)
31- [Commands and options](#commands-and-options)
39− - [`reshape migration start`](#reshape-migration-start)
32+ - [`reshape migrate`](#reshape-migrate)
40− - [`reshape migration complete`](#reshape-migration-complete)
33+ - [`reshape complete`](#reshape-complete)
41− - [`reshape migration abort`](#reshape-migration-abort)
34+ - [`reshape abort`](#reshape-abort)
42− - [`reshape schema-query`](#reshape-schema-query)
35+ - [`reshape generate-schema-query`](#reshape-generate-schema-query)
43− - [Connection options](#connection-options)
36+ - [Connection options](#connection-options)
44- [License](#license)
37- [License](#license)
45
38
39+
46## How it works
40## How it works
47
41
48Reshape 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:
42Reshape 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:
49
43
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.
512. **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.
452. **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.
53
47
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.
55
49
56## Getting started
50## Getting started
57
51
@@ -63,7 +57,7 @@ Binaries are available for macOS and Linux under [Releases](https://github.com/f
63
57
64#### Cargo
58#### Cargo
65
59
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/):
67
61
68```shell
62```shell
69cargo install reshape
63cargo install reshape
@@ -71,10 +65,10 @@ cargo install reshape
71
65
72#### Docker
66#### Docker
73
67
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).
75
69
76```shell
70```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
78```
72```
79
73
80### Creating your first migration
74### Creating your first migration
@@ -103,14 +97,9 @@ This is the equivalent of running `CREATE TABLE users (id INTEGER GENERATED ALWA
103
97
104### Preparing your application
98### Preparing your application
105
99
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:
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`.
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)
112
101
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:
114
103
115```python
104```python
116# Example for Python
105# Example for Python
@@ -123,16 +112,16 @@ db.execute(reshape_schema_query)
123To create your new `users` table, run:
112To create your new `users` table, run:
124
113
125```bash
114```bash
126−reshape migration start --complete
115+reshape migrate
127```
116```
128
117
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`.
130
119
131If 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.
120If 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.
132
121
133### Using during development
122### Using during development
134
123
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`.
136
125
137## Writing migrations
126## Writing migrations
138
127
@@ -167,9 +156,9 @@ Every action has a `type`. The supported types are detailed below.
167
156
168#### Create table
157#### Create table
169
158
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.
171
160
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*
173
162
174```toml
163```toml
175[[actions]]
164[[actions]]
@@ -187,13 +176,13 @@ primary_key = ["id"]
187 type = "TEXT"
176 type = "TEXT"
188
177
189 # Columns default to nullable
178 # Columns default to nullable
190− nullable = false
179+ nullable = false
191
180
192 # default can be any valid SQL value, in this case a string literal
181 # default can be any valid SQL value, in this case a string literal
193− default = "'PLACEHOLDER'"
182+ default = "'PLACEHOLDER'"
194```
183```
195
184
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*
197
186
198```toml
187```toml
199[[actions]]
188[[actions]]
@@ -226,34 +215,11 @@ primary_key = ["id"]
226 referenced_columns = ["id"]
215 referenced_columns = ["id"]
227```
216```
228
217
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−
252#### Rename table
218#### Rename table
253
219
254The `rename_table` action will change the name of an existing table.
220The `rename_table` action will change the name of an existing table.
255
221
256−_Example: change name of `users` table to `customers`_
222+*Example: change name of `users` table to `customers`*
257
223
258```toml
224```toml
259[[actions]]
225[[actions]]
@@ -266,7 +232,7 @@ new_name = "customers"
266
232
267The `remove_table` action will remove an existing table.
233The `remove_table` action will remove an existing table.
268
234
269−_Example: remove `users` table_
235+*Example: remove `users` table*
270
236
271```toml
237```toml
272[[actions]]
238[[actions]]
@@ -274,43 +240,13 @@ type = "remove_table"
274table = "users"
240table = "users"
275```
241```
276
242
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−
307### Columns
243### Columns
308
244
309#### Add column
245#### Add column
310
246
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.
312
248
313−_Example: add a new column `reference` to table `products`_
249+*Example: add a new column `reference` to table `products`*
314
250
315```toml
251```toml
316[[actions]]
252[[actions]]
@@ -324,7 +260,7 @@ table = "products"
324 default = "10"
260 default = "10"
325```
261```
326
262
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`*
328
264
329```toml
265```toml
330[[actions]]
266[[actions]]
@@ -360,48 +296,14 @@ column = "name"
360down = "first_name || ' ' || last_name"
296down = "first_name || ' ' || last_name"
361```
297```
362
298
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−```
397
299
398#### Alter column
300#### Alter column
399
301
400The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
302The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
401
303
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.
403
305
404−_Example: rename `last_name` column on `users` table to `family_name`_
306+*Example: rename `last_name` column on `users` table to `family_name`*
405
307
406```toml
308```toml
407[[actions]]
309[[actions]]
@@ -413,7 +315,7 @@ column = "last_name"
413 name = "family_name"
315 name = "family_name"
414```
316```
415
317
416−_Example: change the type of `reference` column from `INTEGER` to `TEXT`_
318+*Example: change the type of `reference` column from `INTEGER` to `TEXT`*
417
319
418```toml
320```toml
419[[actions]]
321[[actions]]
@@ -428,7 +330,7 @@ down = "CAST(reference AS INTEGER)" # Converts from text value to integer
428 type = "TEXT" # Previous type was 'INTEGER'
330 type = "TEXT" # Previous type was 'INTEGER'
429```
331```
430
332
431−_Example: increment all values of an `index` column by one_
333+*Example: increment all values of an `index` column by one*
432
334
433```toml
335```toml
434[[actions]]
336[[actions]]
@@ -443,22 +345,7 @@ down = "index - 1" # Decrement to revert for old schema
443 name = "index"
345 name = "index"
444```
346```
445
347
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*
462
349
463```toml
350```toml
464[[actions]]
351[[actions]]
@@ -472,11 +359,9 @@ column = "created_at"
472
359
473#### Remove column
360#### Remove column
474
361
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.
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.
476−
477−Any indices that cover the column will be removed.
478
363
479−_Example: remove column `name` from table `users`_
364+*Example: remove column `name` from table `users`*
480
365
481```toml
366```toml
482[[actions]]
367[[actions]]
@@ -488,34 +373,18 @@ column = "name"
488down = "'N/A'"
373down = "'N/A'"
489```
374```
490
375
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−
507### Indices
376### Indices
508
377
509#### Add index
378#### Add index
510
379
511The `add_index` action will add a new index to an existing table.
380The `add_index` action will add a new index to an existing table.
512
381
513−_Example: create a `users` table with a unique index on the `name` column_
382+*Example: create a `users` table with an index on the `name` column*
514
383
515```toml
384```toml
516[[actions]]
385[[actions]]
517type = "create_table"
386type = "create_table"
518−name = "users"
387+table = "users"
519primary_key = "id"
388primary_key = "id"
520
389
521 [[actions.columns]]
390 [[actions.columns]]
@@ -530,35 +399,15 @@ primary_key = "id"
530[[actions]]
399[[actions]]
531type = "add_index"
400type = "add_index"
532table = "users"
401table = "users"
533−
534− [actions.index]
535− name = "name_idx"
402+name = "name_idx"
536− columns = ["name"]
403+columns = ["name"]
537−
538− # Defaults to false
539− unique = true
540−```
541−
542−_Example: add GIN index to `data` column on `products` table_
543−
544−```toml
545−[[actions]]
546−type = "add_index"
547−table = "products"
548−
549− [actions.index]
550− name = "data_idx"
551− columns = ["data"]
552−
553− # One of: btree (default), hash, gist, spgist, gin, brin
554− type = "gin"
555```
404```
556
405
557#### Remove index
406#### Remove index
558
407
559The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
408The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
560
409
561−_Example: remove the `name_idx` index_
410+*Example: remove the `name_idx` index*
562
411
563```toml
412```toml
564[[actions]]
413[[actions]]
@@ -566,205 +415,61 @@ type = "remove_index"
566index = "name_idx"
415index = "name_idx"
567```
416```
568
417
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−
709## Commands and options
418## Commands and options
710
419
711−### `reshape migration start`
420+### `reshape migrate`
712
421
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`.
422+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`.
714
423
715#### Options
424#### Options
716
425
717−_See also [Connection options](#connection-options)_
426+*See also [Connection options](#connection-options)*
718
427
719−| Option | Default | Description |
428+| Option | Default | Description |
720−| ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- |
429+| ------ | ------- | ----------- |
721−| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
430+| `--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`. |
431+| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
723
432
724−### `reshape migration complete`
433+### `reshape complete`
725
434
726−Completes migrations previously started with `reshape migration complete`.
435+Completes migrations previously started with `reshape complete`.
727
436
728#### Options
437#### Options
729
438
730See [Connection options](#connection-options)
439See [Connection options](#connection-options)
731
440
732−### `reshape migration abort`
441+### `reshape abort`
733
442
734−Aborts any migrations which haven't yet been completed.
443+Aborts any migrations which haven't yet been completed.
735
444
736#### Options
445#### Options
737
446
738See [Connection options](#connection-options)
447See [Connection options](#connection-options)
739
448
740−### `reshape schema-query`
449+### `reshape generate-schema-query`
741
450
742Generates 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`).
451Generates 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`).
743
452
744−If your application is written in Rust, we recommend using the [Rust helper library](https://github.com/fabianlindfors/reshape-helper/) instead.
745−
746The query should look something like `SET search_path TO migration_1_initial_migration`.
453The query should look something like `SET search_path TO migration_1_initial_migration`.
747
454
748#### Options
455#### Options
749
456
750−| Option | Default | Description |
457+| Option | Default | Description |
751−| -------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
458+| ------ | ------- | ----------- |
752| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
459| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
753
460
754### Connection options
461### Connection options
755
462
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.
463+The options below can be used with all commands that communicate with Postgres. Use either a connection URL 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.
759
464
760−| Option | Default | Environment variable | Description |
465+| Option | Default | Description |
761−| ------------ | ----------- | -------------------- | ------------------------------------------- |
466+| ------ | ------- | ----------- |
762−| `--url` | | `DB_URL` | URL to your Postgres database |
467+| `--url` | | URI to connect to your Postgres database.<br>Can also be provided with the environment variable `DATABASE_URL`. |
763−| `--host` | `localhost` | `DB_HOST` | Hostname to use when connecting to Postgres |
468+| `--host` | `localhost` | Hostname to use when connecting to Postgres |
764−| `--port` | `5432` | `DB_PORT` | Port which Postgres is listening on |
469+| `--port` | `5432` | Port which Postgres is listening on |
765−| `--database` | `postgres` | `DB_NAME` | Database name |
470+| `--database` | `postgres` | Database name |
766−| `--username` | `postgres` | `DB_USERNAME` | Postgres username |
471+| `--username` | `postgres` | Postgres username |
767−| `--password` | `postgres` | `DB_PASSWORD` | Postgres password |
472+| `--password` | `postgres` | Postgres password |
768
473
769## License
474## License
770
475
src/db.rs+6−144
@@ -1,87 +1,4 @@
1−use std::{cmp::min, time::Duration};
2−
3−use anyhow::{anyhow, Context};
4use postgres::{types::ToSql, NoTls, Row};
1use postgres::{types::ToSql, NoTls, Row};
5−use rand::prelude::*;
6−
7−// DbLocker wraps a regular DbConn, only allowing access using the
8−// `lock` method. This method will acquire the advisory lock before
9−// allowing access to the database, and then release it afterwards.
10−//
11−// We use advisory locks to avoid multiple Reshape instances working
12−// on the same database as the same time. DbLocker is the only way to
13−// get a DbConn which ensures that all database access is protected by
14−// a lock.
15−//
16−// Postgres docs on advisory locks:
17−// https://www.postgresql.org/docs/current/explicit-locking.html#ADVISORY-LOCKS
18−pub struct DbLocker {
19− client: DbConn,
20−}
21−
22−impl DbLocker {
23− // Advisory lock keys in Postgres are 64-bit integers.
24− // The key we use was chosen randomly.
25− const LOCK_KEY: i64 = 4036779288569897133;
26−
27− 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−
46− Ok(Self {
47− client: DbConn::new(pg),
48− })
49− }
50−
51− pub fn lock(
52− &mut self,
53− f: impl FnOnce(&mut DbConn) -> anyhow::Result<()>,
54− ) -> anyhow::Result<()> {
55− self.acquire_lock()?;
56− let result = f(&mut self.client);
57− self.release_lock()?;
58−
59− result
60− }
61−
62− fn acquire_lock(&mut self) -> anyhow::Result<()> {
63− let success = self
64− .client
65− .query(&format!("SELECT pg_try_advisory_lock({})", Self::LOCK_KEY))?
66− .first()
67− .ok_or_else(|| anyhow!("unexpectedly failed when acquiring advisory lock"))
68− .map(|row| row.get::<'_, _, bool>(0))?;
69−
70− if success {
71− Ok(())
72− } else {
73− Err(anyhow!("another instance of Reshape is already running"))
74− }
75− }
76−
77− fn release_lock(&mut self) -> anyhow::Result<()> {
78− self.client
79− .query(&format!("SELECT pg_advisory_unlock({})", Self::LOCK_KEY))?
80− .first()
81− .ok_or_else(|| anyhow!("unexpectedly failed when releasing advisory lock"))?;
82− Ok(())
83− }
84−}
85
2
86pub trait Conn {
3pub trait Conn {
87 fn run(&mut self, query: &str) -> anyhow::Result<()>;
4 fn run(&mut self, query: &str) -> anyhow::Result<()>;
@@ -99,19 +16,20 @@ pub struct DbConn {
99}
16}
100
17
101impl DbConn {
18impl DbConn {
102− fn new(client: postgres::Client) -> Self {
19+ pub fn connect(config: &postgres::Config) -> anyhow::Result<DbConn> {
20+ let client = config.connect(NoTls)?;
103− DbConn { client }
21+ Ok(DbConn { client })
104 }
22 }
105}
23}
106
24
107impl Conn for DbConn {
25impl Conn for DbConn {
108 fn run(&mut self, query: &str) -> anyhow::Result<()> {
26 fn run(&mut self, query: &str) -> anyhow::Result<()> {
109− retry_automatically(|| self.client.batch_execute(query))?;
27+ self.client.batch_execute(query)?;
110 Ok(())
28 Ok(())
111 }
29 }
112
30
113 fn query(&mut self, query: &str) -> anyhow::Result<Vec<Row>> {
31 fn query(&mut self, query: &str) -> anyhow::Result<Vec<Row>> {
114− let rows = retry_automatically(|| self.client.query(query, &[]))?;
32+ let rows = self.client.query(query, &[])?;
115 Ok(rows)
33 Ok(rows)
116 }
34 }
117
35
@@ -120,7 +38,7 @@ impl Conn for DbConn {
120 query: &str,
38 query: &str,
121 params: &[&(dyn ToSql + Sync)],
39 params: &[&(dyn ToSql + Sync)],
122 ) -> anyhow::Result<Vec<Row>> {
40 ) -> anyhow::Result<Vec<Row>> {
123− let rows = retry_automatically(|| self.client.query(query, params))?;
41+ let rows = self.client.query(query, params)?;
124 Ok(rows)
42 Ok(rows)
125 }
43 }
126
44
@@ -139,11 +57,6 @@ impl Transaction<'_> {
139 self.transaction.commit()?;
57 self.transaction.commit()?;
140 Ok(())
58 Ok(())
141 }
59 }
142−
143− pub fn rollback(self) -> anyhow::Result<()> {
144− self.transaction.rollback()?;
145− Ok(())
146− }
147}
60}
148
61
149impl Conn for Transaction<'_> {
62impl Conn for Transaction<'_> {
@@ -171,54 +84,3 @@ impl Conn for Transaction<'_> {
171 Ok(Transaction { transaction })
84 Ok(Transaction { transaction })
172 }
85 }
173}
86}
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;
2
2
3use crate::db::Conn;
3use crate::db::Conn;
4
4
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+
6 let query = format!(
15 let query = format!(
7 "
16 "
8− CREATE OR REPLACE FUNCTION reshape.is_new_schema()
17+ CREATE OR REPLACE FUNCTION reshape.is_old_schema()
9 RETURNS BOOLEAN AS $$
18 RETURNS BOOLEAN AS $$
10 DECLARE
19 DECLARE
11− setting TEXT := current_setting('reshape.is_new_schema', TRUE);
20+ setting TEXT := current_setting('reshape.is_old_schema', TRUE);
12 setting_bool BOOLEAN := setting IS NOT NULL AND setting = 'YES';
21 setting_bool BOOLEAN := setting IS NOT NULL AND setting = 'YES';
13 BEGIN
22 BEGIN
14− RETURN current_setting('search_path') = 'migration_{}' OR setting_bool;
23+ RETURN {};
15 END
24 END
16 $$ language 'plpgsql';
25 $$ language 'plpgsql';
17 ",
26 ",
18− target_migration,
27+ predicate
19 );
28 );
20 db.query(&query)
29 db.query(&query)
21− .context("failed creating helper function reshape.is_new_schema()")?;
30+ .context("failed creating helper function reshape.is_old_schema()")?;
22
31
23 Ok(())
32 Ok(())
24}
33}
25
34
26pub fn tear_down_helpers(db: &mut dyn Conn) -> anyhow::Result<()> {
35pub 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;")?;
28 Ok(())
37 Ok(())
29}
38}
src/lib.rs+430−414
@@ -5,7 +5,7 @@ use crate::{
5
5
6use anyhow::{anyhow, Context};
6use anyhow::{anyhow, Context};
7use colored::*;
7use colored::*;
8−use db::{Conn, DbConn, DbLocker};
8+use db::{Conn, DbConn};
9use postgres::Config;
9use postgres::Config;
10use schema::Table;
10use schema::Table;
11
11
@@ -15,10 +15,11 @@ pub mod migrations;
15mod schema;
15mod schema;
16mod state;
16mod state;
17
17
18−pub use crate::state::State;
18+pub use crate::state::{State, Status};
19
19
20pub struct Reshape {
20pub struct Reshape {
21− db: DbLocker,
21+ pub state: State,
22+ db: DbConn,
22}
23}
23
24
24impl Reshape {
25impl Reshape {
@@ -30,7 +31,6 @@ impl Reshape {
30 pub fn new_with_options(
31 pub fn new_with_options(
31 host: &str,
32 host: &str,
32 port: u16,
33 port: u16,
33− database: &str,
34 username: &str,
34 username: &str,
35 password: &str,
35 password: &str,
36 ) -> anyhow::Result<Reshape> {
36 ) -> anyhow::Result<Reshape> {
@@ -39,488 +39,504 @@ impl Reshape {
39 .host(host)
39 .host(host)
40 .port(port)
40 .port(port)
41 .user(username)
41 .user(username)
42− .dbname(database)
43 .password(password);
42 .password(password);
44
43
45 Self::new_with_config(&config)
44 Self::new_with_config(&config)
46 }
45 }
47
46
48 fn new_with_config(config: &Config) -> anyhow::Result<Reshape> {
47 fn new_with_config(config: &Config) -> anyhow::Result<Reshape> {
49− let db = DbLocker::connect(config)?;
48+ let mut db = DbConn::connect(config)?;
50− Ok(Reshape { db })
51− }
52−
53− pub fn migrate(
54− &mut self,
55− migrations: impl IntoIterator<Item = Migration>,
56− ) -> anyhow::Result<()> {
57− self.db.lock(|db| {
58− let mut state = State::load(db)?;
49+ let state = State::load(&mut db);
59− migrate(db, &mut state, migrations)
60− })
61− }
62
50
63− pub fn complete(&mut self) -> anyhow::Result<()> {
64− self.db.lock(|db| {
65− let mut state = State::load(db)?;
66− complete(db, &mut state)
51+ Ok(Reshape { db, state })
67− })
68 }
52 }
69
53
70− pub fn abort(&mut self) -> anyhow::Result<()> {
54+ pub fn migrate<T>(&mut self, migrations: T) -> anyhow::Result<()>
71− self.db.lock(|db| {
55+ where
72− let mut state = State::load(db)?;
56+ T: IntoIterator<Item = Migration>,
73− abort(db, &mut state)
57+ {
74− })
75− }
76−
77− pub fn remove(&mut self) -> anyhow::Result<()> {
78− self.db.lock(|db| {
79− let mut state = State::load(db)?;
58+ self.state = State::load(&mut self.db);
80
59
81− // Remove migration schemas and views
60+ // Make sure no migration is in progress
82− if let Some(current_migration) = &state::current_migration(db)? {
61+ if let state::Status::InProgress { .. } = &self.state.status {
83− db.run(&format!(
62+ println!("Migration already in progress, please complete using 'reshape complete'");
84− "DROP SCHEMA IF EXISTS {} CASCADE",
63+ return Ok(());
85− schema_name_for_migration(current_migration)
86− ))?;
87− }
64+ }
88
65
89− if let State::InProgress { migrations } = &state {
66+ if let state::Status::Completing { .. } = &self.state.status {
90− let target_migration = migrations.last().unwrap().name.to_string();
67+ println!(
91− db.run(&format!(
68+ "Migration already in progress and has started completion, please finish using 'reshape complete'"
92− "DROP SCHEMA IF EXISTS {} CASCADE",
69+ );
93− schema_name_for_migration(&target_migration)
70+ return Ok(());
94− ))?;
95− }
71+ }
96
72
97− // Remove all tables
73+ // Determine which migrations need to be applied by comparing the provided migrations
98− let schema = Schema::new();
74+ // with the already applied ones stored in the state. This will throw an error if the
99− for table in schema.get_tables(db)? {
75+ // two sets of migrations don't agree, for example if a new migration has been added
100− db.run(&format!(
76+ // in between two existing ones.
101− r#"
77+ let current_migration = &self.state.current_migration.clone();
102− DROP TABLE IF EXISTS "{}" CASCADE
78+ let remaining_migrations = self.state.get_remaining_migrations(migrations)?;
103− "#,
79+ if remaining_migrations.is_empty() {
104− table.real_name
80+ println!("No migrations left to apply");
105− ))?;
81+ return Ok(());
106− }
82+ }
107
83
108− // Remove all enums
84+ // If we have already started applying some migrations we need to ensure that
109− let enums: Vec<String> = db
85+ // they are the same ones we want to apply now
110− .query("SELECT typname FROM pg_type WHERE typcategory = 'E'")?
86+ if let state::Status::Applying {
111− .iter()
87+ migrations: existing_migrations,
112− .map(|row| row.get("typname"))
88+ } = &self.state.status
113− .collect();
89+ {
114− for enum_type in enums {
90+ if existing_migrations != &remaining_migrations {
115− db.run(&format!("DROP TYPE {}", enum_type))?;
91+ return Err(anyhow!(
92+ "a previous migration seems to have failed without cleaning up. Please run `reshape abort` and then run migrate again."
93+ ));
116 }
94 }
95+ }
117
96
118− // Reset state
97+ // Move to the "Applying" state which is necessary as we can't run the migrations
119− state.clear(db)?;
98+ // and state update as a single transaction. If a migration unexpectedly fails without
99+ // automatically aborting, this state saves us from dangling migrations. It forces the user
100+ // to either run migrate again (which works as all migrations are idempotent) or abort.
101+ self.state.applying(remaining_migrations.clone());
102+ self.state.save(&mut self.db)?;
120
103
121− println!("Reshape and all data has been removed");
104+ println!("Applying {} migrations\n", remaining_migrations.len());
122
105
123− Ok(())
106+ helpers::set_up_helpers(&mut self.db, current_migration)
124− })
107+ .context("failed to set up helpers")?;
125− }
126−}
127
108
128−pub fn latest_schema_from_migrations(migrations: &[Migration]) -> Option<String> {
109+ let mut new_schema = Schema::new();
129− migrations
110+ let mut last_migration_index = usize::MAX;
130− .last()
111+ let mut last_action_index = usize::MAX;
131− .map(|migration| schema_name_for_migration(&migration.name))
112+ let mut result: anyhow::Result<()> = Ok(());
132−}
133
113
134−pub fn schema_query_for_migration(migration_name: &str) -> String {
114+ for (migration_index, migration) in remaining_migrations.iter().enumerate() {
135− let schema_name = schema_name_for_migration(migration_name);
115+ println!("Migrating '{}':", migration.name);
136− format!("SET search_path TO {}", schema_name)
116+ last_migration_index = migration_index;
137−}
138
117
139−fn schema_name_for_migration(migration_name: &str) -> String {
118+ for (action_index, action) in migration.actions.iter().enumerate() {
140− format!("migration_{}", migration_name)
119+ last_action_index = action_index;
141−}
142
120
143−fn migrate(
121+ let description = action.describe();
144− db: &mut DbConn,
122+ print!(" + {} ", description);
145− state: &mut State,
146− migrations: impl IntoIterator<Item = Migration>,
147−) -> anyhow::Result<()> {
148− // Make sure no migration is in progress
149− if let State::InProgress { .. } = &state {
150− println!(
151− "Migration already in progress, please complete using 'reshape migration complete'"
152− );
153− return Ok(());
154− }
155
123
156− if let State::Completing { .. } = &state {
124+ let ctx = MigrationContext::new(migration_index, action_index);
157− println!(
125+ result = action
158− "Migration already in progress and has started completion, please finish using 'reshape migration complete'"
126+ .run(&ctx, &mut self.db, &new_schema)
159− );
127+ .with_context(|| format!("failed to {}", description));
160− return Ok(());
161− }
162
128
163− // Determine which migrations need to be applied by comparing the provided migrations
129+ if result.is_ok() {
164− // with the already applied ones stored in the state. This will throw an error if the
130+ action.update_schema(&ctx, &mut new_schema);
165− // two sets of migrations don't agree, for example if a new migration has been added
131+ println!("{}", "done".green());
166− // in between two existing ones.
132+ } else {
167− let remaining_migrations = state::remaining_migrations(db, migrations)?;
133+ println!("{}", "failed".red());
168− if remaining_migrations.is_empty() {
134+ break;
169− println!("No migrations left to apply");
135+ }
170− return Ok(());
171− }
136+ }
172
137
173− // If we have already started applying some migrations we need to ensure that
138+ println!();
174− // they are the same ones we want to apply now
175− if let State::Applying {
176− migrations: existing_migrations,
177− } = &state
178− {
179− if existing_migrations != &remaining_migrations {
180− 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− ));
183 }
139 }
184− }
185
140
186− // Move to the "Applying" state which is necessary as we can't run the migrations
141+ // If a migration failed, we abort all the migrations that were applied
187− // and state update as a single transaction. If a migration unexpectedly fails without
142+ if let Err(err) = result {
188− // automatically aborting, this state saves us from dangling migrations. It forces the user
143+ println!("A migration failed, aborting migrations that have already been applied");
189− // to either run migrate again (which works as all migrations are idempotent) or abort.
190− state.applying(remaining_migrations.clone());
191− state.save(db)?;
192−
193− println!("Applying {} migrations\n", remaining_migrations.len());
194−
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")?;
197−
198− let mut new_schema = Schema::new();
199− let mut last_migration_index = usize::MAX;
200− let mut last_action_index = usize::MAX;
201− let mut result: anyhow::Result<()> = Ok(());
202−
203− 'outer: for (migration_index, migration) in remaining_migrations.iter().enumerate() {
204− println!("Migrating '{}':", migration.name);
205− last_migration_index = migration_index;
206−
207− for (action_index, action) in migration.actions.iter().enumerate() {
208− last_action_index = action_index;
209−
210− let description = action.describe();
211− print!(" + {} ", description);
212−
213− let ctx =
214− MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
215− result = action
216− .run(&ctx, db, &new_schema)
217− .with_context(|| format!("failed to {}", description));
218−
219− if result.is_ok() {
220− action.update_schema(&ctx, &mut new_schema);
221− println!("{}", "done".green());
222− } else {
223− println!("{}", "failed".red());
224− break 'outer;
225− }
226− }
227
144
228− println!();
145+ // Set to the Aborting state. This is to ensure that the failed
229− }
146+ // migration is fully aborted and nothing is left dangling.
147+ // If the abort is interrupted for any reason, the user can try again
148+ // by running `reshape abort`.
149+ self.state.aborting(
150+ remaining_migrations.clone(),
151+ last_migration_index + 1,
152+ last_action_index + 1,
153+ );
230
154
231− // If a migration failed, we abort all the migrations that were applied
155+ // Abort will only
232− if let Err(err) = result {
156+ self.abort()?;
233− println!("A migration failed, aborting migrations that have already been applied");
234
157
235− // Set to the Aborting state. This is to ensure that the failed
158+ return Err(err);
236− // migration is fully aborted and nothing is left dangling.
159+ }
237− // If the abort is interrupted for any reason, the user can try again
238− // by running `reshape migration abort`.
239− state.aborting(
240− remaining_migrations.clone(),
241− last_migration_index + 1,
242− last_action_index + 1,
243− );
244
160
245− // Abort will only
161+ // Create schema and views for migration
246− abort(db, state)?;
162+ let target_migration = remaining_migrations.last().unwrap().name.to_string();
163+ self.create_schema_for_migration(&target_migration, &new_schema)
164+ .with_context(|| {
165+ format!("failed to create schema for migration {}", target_migration)
166+ })?;
167+
168+ // Update state once migrations have been performed
169+ self.state.in_progress(remaining_migrations);
170+ self.state
171+ .save(&mut self.db)
172+ .context("failed to save in-progress state")?;
173+
174+ // If we started from a blank slate, we can finish the migration immediately
175+ if current_migration.is_none() {
176+ println!("Automatically completing migrations\n");
177+ self.complete_migration()
178+ .context("failed to automatically complete migrations")?;
179+
180+ println!("Migrations complete:");
181+ println!(
182+ " - Run '{}' from your application to use the latest schema",
183+ schema_query_for_migration(&target_migration)
184+ );
185+ } else {
186+ println!("Migrations have been applied and the new schema is ready for use:");
187+ println!(
188+ " - Run '{}' from your application to use the latest schema",
189+ schema_query_for_migration(&target_migration)
190+ );
191+ println!(
192+ " - Run 'reshape complete' once your application has been updated and the previous schema is no longer in use"
193+ );
194+ }
247
195
248− return Err(err);
196+ Ok(())
249 }
197 }
250
198
251− // Create schema and views for migration
199+ pub fn complete_migration(&mut self) -> anyhow::Result<()> {
252− create_schema_for_migration(db, &target_migration, &new_schema)
253− .with_context(|| format!("failed to create schema for migration {}", target_migration))?;
254−
255− // Update state once migrations have been performed
256− state.in_progress(remaining_migrations);
257− state.save(db).context("failed to save in-progress state")?;
258−
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− );
267− Ok(())
268−}
269−
270−fn complete(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
271− // Make sure a migration is in progress
200+ // Make sure a migration is in progress
272− let (remaining_migrations, starting_migration_index, starting_action_index) = match state.clone() {
201+ let (remaining_migrations, starting_migration_index, starting_action_index) = match self.state.status.clone() {
273− State::InProgress { migrations } => {
202+ state::Status::InProgress { migrations } => {
274− // Move into the Completing state. Once in this state,
203+ // Move into the Completing state. Once in this state,
275− // the migration can't be aborted and must be completed.
204+ // the migration can't be aborted and must be completed.
276− state.completing(migrations.clone(), 0, 0);
205+ self.state.completing(migrations.clone(), 0, 0);
277− state.save(db).context("failed to save state")?;
206+ self.state.save(&mut self.db).context("failed to save state")?;
278−
207+
279− (migrations, 0, 0)
208+ (migrations, 0, 0)
280− },
209+ },
281− State::Completing {
210+ state::Status::Completing {
282− migrations,
211+ migrations,
283− current_migration_index,
212+ current_migration_index,
284− current_action_index
213+ current_action_index
285− } => (migrations, current_migration_index, current_action_index),
214+ } => (migrations, current_migration_index, current_action_index),
286− State::Aborting { .. } => {
215+ state::Status::Aborting { .. } => {
287− return Err(anyhow!("migration been aborted and can't be completed. Please finish using `reshape migration abort`."))
216+ return Err(anyhow!("migration been aborted and can't be completed. Please finish using `reshape abort`."))
288− }
217+ }
289− State::Applying { .. } => {
218+ state::Status::Applying { .. } => {
290− return Err(anyhow!("a previous migration unexpectedly failed. Please run `reshape migrate` to try applying the migration again."))
219+ return Err(anyhow!("a previous migration unexpectedly failed. Please run `reshape migrate` to try applying the migration again."))
291− }
220+ }
292− State::Idle => {
221+ state::Status::Idle => {
293− println!("No migration in progress");
222+ println!("No migration in progress");
294− return Ok(());
223+ return Ok(());
295− }
296− };
224+ }
297−
225+ };
298− // Remove previous migration's schema
299− if let Some(current_migration) = &state::current_migration(db)? {
300− db.run(&format!(
301− "DROP SCHEMA IF EXISTS {} CASCADE",
302− schema_name_for_migration(current_migration)
303− ))
304− .context("failed to remove previous migration's schema")?;
305− }
306
226
307− for (migration_index, migration) in remaining_migrations.iter().enumerate() {
227+ // Remove previous migration's schema
308− // Skip all the migrations which have already been completed
228+ if let Some(current_migration) = &self.state.current_migration {
309− if migration_index < starting_migration_index {
229+ self.db
310− continue;
230+ .run(&format!(
231+ "DROP SCHEMA IF EXISTS {} CASCADE",
232+ schema_name_for_migration(current_migration)
233+ ))
234+ .context("failed to remove previous migration's schema")?;
311 }
235 }
312
236
313− println!("Completing '{}':", migration.name);
237+ for (migration_index, migration) in remaining_migrations.iter().enumerate() {
314−
315− for (action_index, action) in migration.actions.iter().enumerate() {
316− // Skip all actions which have already been completed
238+ // Skip all the migrations which have already been completed
317− if migration_index == starting_migration_index && action_index < starting_action_index {
239+ if migration_index < starting_migration_index {
318 continue;
240 continue;
319 }
241 }
320
242
321− let description = action.describe();
243+ println!("Completing '{}':", migration.name);
322− print!(" + {} ", description);
323
244
324− let ctx =
245+ for (action_index, action) in migration.actions.iter().enumerate() {
325− MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
246+ // Skip all actions which have already been completed
247+ if migration_index == starting_migration_index
248+ && action_index < starting_action_index
249+ {
250+ continue;
251+ }
326
252
327− // Update state to indicate that this action has been completed.
253+ let description = action.describe();
328− // We won't save this new state until after the action has completed.
254+ print!(" + {} ", description);
329− state.completing(
330− remaining_migrations.clone(),
331− migration_index + 1,
332− action_index + 1,
333− );
334
255
256+ let ctx = MigrationContext::new(migration_index, action_index);
257+
258+ // Update state to indicate that this action has been completed.
259+ // We won't save this new state until after the action has completed.
260+ self.state.completing(
261+ remaining_migrations.clone(),
262+ migration_index + 1,
263+ action_index + 1,
264+ );
265+
335− // This did_save check is necessary because of the borrow checker.
266+ // This did_save check is necessary because of the borrow checker.
336− // The Transaction which might be returned from action.complete
267+ // The Transaction which might be returned from action.complete
337− // contains a mutable reference to self.db. We need the Transaction
268+ // contains a mutable reference to self.db. We need the Transaction
338− // to be dropped before we can save the state using self.db instead,
269+ // to be dropped before we can save the state using self.db instead,
339− // which we achieve here by limiting the lifetime of the Transaction
270+ // which we achieve here by limiting the lifetime of the Transaction
340− // with a new block.
271+ // with a new block.
341− let did_save = {
272+ let did_save = {
342− let result = action
273+ let result = action
343− .complete(&ctx, db)
274+ .complete(&ctx, &mut self.db)
344− .with_context(|| format!("failed to complete migration {}", migration.name))
275+ .with_context(|| format!("failed to complete migration {}", migration.name))
345− .with_context(|| format!("failed to complete action: {}", description));
276+ .with_context(|| format!("failed to complete action: {}", description));
346−
277+
347− let maybe_transaction = match result {
278+ let maybe_transaction = match result {
348− Ok(maybe_transaction) => {
279+ Ok(maybe_transaction) => {
349− println!("{}", "done".green());
280+ println!("{}", "done".green());
350− maybe_transaction
281+ maybe_transaction
351− }
282+ }
352− Err(e) => {
283+ Err(e) => {
353− println!("{}", "failed".red());
284+ println!("{}", "failed".red());
354− return Err(e);
285+ return Err(e);
286+ }
287+ };
288+
289+ // Update state with which migrations and actions have been completed.
290+ // Each action can create and return a transaction if they need atomicity.
291+ // We use this transaction to update the state to ensure the action only completes.
292+ // once.
293+ // We want to use a single transaction for each action to keep the length of
294+ // the transaction as short as possible. Wherever possible, we don't want to
295+ // use a transaction at all.
296+ if let Some(mut transaction) = maybe_transaction {
297+ self.state
298+ .save(&mut transaction)
299+ .context("failed to save state after completing action")?;
300+ transaction
301+ .commit()
302+ .context("failed to commit transaction")?;
303+
304+ true
305+ } else {
306+ false
355 }
307 }
356 };
308 };
357
309
358− // Update state with which migrations and actions have been completed.
310+ // If the action didn't return a transaction we save the state normally instead
359− // Each action can create and return a transaction if they need atomicity.
311+ if !did_save {
360− // We use this transaction to update the state to ensure the action only completes.
361− // once.
362− // We want to use a single transaction for each action to keep the length of
363− // the transaction as short as possible. Wherever possible, we don't want to
364− // use a transaction at all.
365− if let Some(mut transaction) = maybe_transaction {
366− state
312+ self.state
367− .save(&mut transaction)
313+ .save(&mut self.db)
368 .context("failed to save state after completing action")?;
314 .context("failed to save state after completing action")?;
369− transaction
370− .commit()
371− .context("failed to commit transaction")?;
372−
373− true
374− } else {
375− false
376 }
315 }
377− };
378−
379− // If the action didn't return a transaction we save the state normally instead
380− if !did_save {
381− state
382− .save(db)
383− .context("failed to save state after completing action")?;
384 }
316 }
317+
318+ println!();
385 }
319 }
386
320
387− println!();
321+ // Remove helpers which are no longer in use
322+ helpers::tear_down_helpers(&mut self.db).context("failed to tear down helpers")?;
323+
324+ self.state
325+ .complete()
326+ .context("failed to update state as completed")?;
327+ self.state
328+ .save(&mut self.db)
329+ .context("failed to save state after setting as completed")?;
330+
331+ Ok(())
388 }
332 }
389
333
390− // Remove helpers which are no longer in use
334+ fn create_schema_for_migration(
391− helpers::tear_down_helpers(db).context("failed to tear down helpers")?;
335+ &mut self,
336+ migration_name: &str,
337+ schema: &Schema,
338+ ) -> anyhow::Result<()> {
339+ // Create schema for migration
340+ let schema_name = schema_name_for_migration(migration_name);
341+ self.db
342+ .run(&format!("CREATE SCHEMA IF NOT EXISTS {}", schema_name))
343+ .with_context(|| {
344+ format!(
345+ "failed to create schema {} for migration {}",
346+ schema_name, migration_name
347+ )
348+ })?;
349+
350+ // Create views inside schema
351+ for table in schema.get_tables(&mut self.db)? {
352+ Self::create_view_for_table(&mut self.db, &table, &schema_name)?;
353+ }
354+
355+ Ok(())
356+ }
392
357
393− state
358+ fn create_view_for_table(
394− .complete(db)
359+ db: &mut impl Conn,
395− .context("failed to update state as completed")?;
360+ table: &Table,
361+ schema: &str,
362+ ) -> anyhow::Result<()> {
363+ let select_columns: Vec<String> = table
364+ .columns
365+ .iter()
366+ .map(|column| {
367+ format!(
368+ r#"
369+ "{real_name}" AS "{alias}"
370+ "#,
371+ real_name = column.real_name,
372+ alias = column.name,
373+ )
374+ })
375+ .collect();
396
376
377+ db.run(&format!(
378+ r#"
379+ CREATE OR REPLACE VIEW {schema}."{view_name}" AS
380+ SELECT {columns}
381+ FROM "{table_name}"
382+ "#,
383+ schema = schema,
384+ table_name = table.real_name,
385+ view_name = table.name,
386+ columns = select_columns.join(","),
397− Ok(())
387+ ))
398−}
388+ .with_context(|| format!("failed to create view for table {}", table.name))?;
399
389
400−fn abort(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
390+ Ok(())
401− let (remaining_migrations, last_migration_index, last_action_index) = match state.clone() {
391+ }
402− State::InProgress { migrations } | State::Applying { migrations } => {
403− // Set to the Aborting state. Once this is done, the migration has to
404− // be fully aborted and can't be completed.
405− state.aborting(migrations.clone(), 0, 0);
406− state.save(db)?;
407
392
408− (migrations, usize::MAX, usize::MAX)
393+ pub fn remove(&mut self) -> anyhow::Result<()> {
409− }
394+ // Remove migration schemas and views
410− State::Aborting {
395+ if let Some(current_migration) = &self.state.current_migration {
411− migrations,
396+ self.db.run(&format!(
412− last_migration_index,
397+ "DROP SCHEMA IF EXISTS {} CASCADE",
413− last_action_index,
398+ schema_name_for_migration(current_migration)
414− } => (migrations, last_migration_index, last_action_index),
399+ ))?;
415− State::Completing { .. } => {
416− return Err(anyhow!("migration completion has already been started. Please run `reshape migration complete` again to finish it."));
417 }
400 }
418− State::Idle => {
401+
419− println!("No migration is in progress");
402+ if let Status::InProgress { migrations } = &self.state.status {
420− return Ok(());
403+ let target_migration = migrations.last().unwrap().name.to_string();
404+ self.db.run(&format!(
405+ "DROP SCHEMA IF EXISTS {} CASCADE",
406+ schema_name_for_migration(&target_migration)
407+ ))?;
421 }
408 }
422− };
409+
423−
410+ // Remove all tables
424− // Remove new migration's schema
411+ let schema = Schema::new();
425− let target_migration = remaining_migrations.last().unwrap().name.to_string();
412+ for table in schema.get_tables(&mut self.db)? {
426− let schema_name = schema_name_for_migration(&target_migration);
413+ self.db.run(&format!(
414+ r#"
427− db.run(&format!("DROP SCHEMA IF EXISTS {} CASCADE", schema_name,))
415+ DROP TABLE IF EXISTS "{}" CASCADE
428− .with_context(|| format!("failed to drop schema {}", schema_name))?;
416+ "#,
429−
417+ table.real_name
430− // Abort all pending migrations
418+ ))?;
431− // Abort all migrations in reverse order
432− for (migration_index, migration) in remaining_migrations.iter().enumerate().rev() {
433− // Skip migrations which shouldn't be aborted
434− // The reason can be that they have already been aborted or that
435− // the migration was never applied in the first place.
436− if migration_index >= last_migration_index {
437− continue;
438 }
419 }
439
420
440− print!("Aborting '{}' ", migration.name);
421+ // Reset state
422+ self.state.clear(&mut self.db)?;
441
423
442− for (action_index, action) in migration.actions.iter().enumerate().rev() {
424+ println!("Reshape and all data has been removed");
425+
426+ Ok(())
427+ }
428+
429+ pub fn abort(&mut self) -> anyhow::Result<()> {
430+ let (remaining_migrations, last_migration_index, last_action_index) = match self
431+ .state
432+ .status
433+ .clone()
434+ {
435+ Status::InProgress { migrations } | Status::Applying { migrations } => {
436+ // Set to the Aborting state. Once this is done, the migration has to
437+ // be fully aborted and can't be completed.
438+ self.state.aborting(migrations.clone(), 0, 0);
439+ self.state.save(&mut self.db)?;
440+
441+ (migrations, usize::MAX, usize::MAX)
442+ }
443+ Status::Aborting {
444+ migrations,
445+ last_migration_index,
446+ last_action_index,
447+ } => (migrations, last_migration_index, last_action_index),
448+ Status::Completing { .. } => {
449+ return Err(anyhow!("Migration completion has already been started. Please run `reshape complete` again to finish it."));
450+ }
451+ Status::Idle => {
452+ println!("No migration is in progress");
453+ return Ok(());
454+ }
455+ };
456+
457+ // Remove new migration's schema
458+ let target_migration = remaining_migrations.last().unwrap().name.to_string();
459+ let schema_name = schema_name_for_migration(&target_migration);
460+ self.db
461+ .run(&format!("DROP SCHEMA IF EXISTS {} CASCADE", schema_name,))
462+ .with_context(|| format!("failed to drop schema {}", schema_name))?;
463+
464+ // Abort all pending migrations
465+ self.abort_migrations(
466+ &remaining_migrations,
467+ last_migration_index,
468+ last_action_index,
469+ )?;
470+
471+ helpers::tear_down_helpers(&mut self.db).context("failed to tear down helpers")?;
472+
473+ self.state.status = state::Status::Idle;
474+ self.state
475+ .save(&mut self.db)
476+ .context("failed to save state")?;
477+
478+ Ok(())
479+ }
480+
481+ fn abort_migrations(
482+ &mut self,
483+ migrations: &[Migration],
484+ upper_migration_index: usize,
485+ upper_action_index: usize,
486+ ) -> anyhow::Result<()> {
487+ // Abort all migrations in reverse order
488+ for (migration_index, migration) in migrations.iter().enumerate().rev() {
443− // Skip actions which shouldn't be aborted
489+ // Skip migrations which shouldn't be aborted
444 // The reason can be that they have already been aborted or that
490 // The reason can be that they have already been aborted or that
445− // the action was never applied in the first place.
491+ // the migration was never applied in the first place.
446− if migration_index == last_migration_index - 1 && action_index >= last_action_index {
492+ if migration_index >= upper_migration_index {
447 continue;
493 continue;
448 }
494 }
449
495
450− let ctx =
496+ print!("Aborting '{}' ", migration.name);
451− MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
452− action
453− .abort(&ctx, db)
454− .with_context(|| format!("failed to abort migration {}", migration.name))
455− .with_context(|| format!("failed to abort action: {}", action.describe()))?;
456−
457− // Update state with which migrations and actions have been aborted.
458− // We don't need to run this in a transaction as aborts are idempotent.
459− state.aborting(remaining_migrations.to_vec(), migration_index, action_index);
460− state.save(db).context("failed to save state")?;
461− }
462
497
463− println!("{}", "done".green());
498+ for (action_index, action) in migration.actions.iter().enumerate().rev() {
499+ // Skip actions which shouldn't be aborted
500+ // The reason can be that they have already been aborted or that
501+ // the action was never applied in the first place.
502+ if migration_index == upper_migration_index - 1
503+ && action_index >= upper_action_index
504+ {
505+ continue;
464− }
506+ }
465
507
466− helpers::tear_down_helpers(db).context("failed to tear down helpers")?;
508+ let ctx = MigrationContext::new(migration_index, action_index);
509+ action
510+ .abort(&ctx, &mut self.db)
511+ .with_context(|| format!("failed to abort migration {}", migration.name))
512+ .with_context(|| format!("failed to abort action: {}", action.describe()))?;
513+
514+ // Update state with which migrations and actions have been aborted.
515+ // We don't need to run this in a transaction as aborts are idempotent.
516+ self.state
517+ .aborting(migrations.to_vec(), migration_index, action_index);
518+ self.state
519+ .save(&mut self.db)
520+ .context("failed to save state")?;
521+ }
467
522
468− *state = State::Idle;
523+ println!("{}", "done".green());
469− state.save(db).context("failed to save state")?;
524+ }
525+ Ok(())
526+ }
527+}
470
528
471− Ok(())
529+pub fn latest_schema_from_migrations(migrations: &[Migration]) -> Option<String> {
530+ migrations
531+ .last()
532+ .map(|migration| schema_name_for_migration(&migration.name))
472}
533}
473
534
474−fn create_schema_for_migration(
475− db: &mut DbConn,
476− migration_name: &str,
535+pub fn schema_query_for_migration(migration_name: &str) -> String {
477− schema: &Schema,
478−) -> anyhow::Result<()> {
479− // Create schema for migration
480 let schema_name = schema_name_for_migration(migration_name);
536 let schema_name = schema_name_for_migration(migration_name);
481− db.run(&format!("CREATE SCHEMA IF NOT EXISTS {}", schema_name))
537+ format!("SET search_path TO {}", schema_name)
482− .with_context(|| {
483− format!(
484− "failed to create schema {} for migration {}",
485− schema_name, migration_name
486− )
487− })?;
488−
489− // Create views inside schema
490− for table in schema.get_tables(db)? {
491− create_view_for_table(db, &table, &schema_name)?;
492− }
493−
494− Ok(())
495}
538}
496
539
497−fn create_view_for_table(db: &mut impl Conn, table: &Table, schema: &str) -> anyhow::Result<()> {
540+fn schema_name_for_migration(migration_name: &str) -> String {
498− let select_columns: Vec<String> = table
541+ format!("migration_{}", migration_name)
499− .columns
500− .iter()
501− .map(|column| {
502− format!(
503− r#"
504− "{real_name}" AS "{alias}"
505− "#,
506− real_name = column.real_name,
507− alias = column.name,
508− )
509− })
510− .collect();
511−
512− db.run(&format!(
513− r#"
514− CREATE OR REPLACE VIEW {schema}."{view_name}" AS
515− SELECT {columns}
516− FROM "{table_name}"
517− "#,
518− schema = schema,
519− table_name = table.real_name,
520− view_name = table.name,
521− columns = select_columns.join(","),
522− ))
523− .with_context(|| format!("failed to create view for table {}", table.name))?;
524−
525− Ok(())
526}
542}
src/main.rs+20−95
@@ -4,7 +4,6 @@ use std::{
4 path::Path,
4 path::Path,
5};
5};
6
6
7−use anyhow::Context;
8use clap::{Args, Parser};
7use clap::{Args, Parser};
9use reshape::{
8use reshape::{
10 migrations::{Action, Migration},
9 migrations::{Action, Migration},
@@ -13,69 +12,22 @@ use reshape::{
13use serde::{Deserialize, Serialize};
12use serde::{Deserialize, Serialize};
14
13
15#[derive(Parser)]
14#[derive(Parser)]
16−#[clap(name = "Reshape", version, about)]
17struct Opts {
15struct Opts {
18 #[clap(subcommand)]
16 #[clap(subcommand)]
19 cmd: Command,
17 cmd: Command,
20}
18}
21
19
22#[derive(Parser)]
20#[derive(Parser)]
23−#[clap(about)]
24enum Command {
21enum 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− )]
44 Migrate(MigrateOptions),
22 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)]
67 Complete(ConnectionOptions),
23 Complete(ConnectionOptions),
68−
24+ Remove(ConnectionOptions),
69− #[clap(
70− about = "Aborts an in-progress migration without losing any data",
71− display_order = 3
72− )]
73 Abort(ConnectionOptions),
25 Abort(ConnectionOptions),
26+ GenerateSchemaQuery(FindMigrationsOptions),
74}
27}
75
28
76#[derive(Args)]
29#[derive(Args)]
77struct MigrateOptions {
30struct MigrateOptions {
78− // Some comment
79 #[clap(long, short)]
31 #[clap(long, short)]
80 complete: bool,
32 complete: bool,
81 #[clap(flatten)]
33 #[clap(flatten)]
@@ -113,28 +65,32 @@ fn main() -> anyhow::Result<()> {
113
65
114fn run(opts: Opts) -> anyhow::Result<()> {
66fn run(opts: Opts) -> anyhow::Result<()> {
115 match opts.cmd {
67 match opts.cmd {
116− Command::Migration(MigrationCommand::Start(opts)) | Command::Migrate(opts) => {
68+ Command::Migrate(opts) => {
117 let mut reshape = reshape_from_connection_options(&opts.connection_options)?;
69 let mut reshape = reshape_from_connection_options(&opts.connection_options)?;
118 let migrations = find_migrations(&opts.find_migrations_options)?;
70 let migrations = find_migrations(&opts.find_migrations_options)?;
119 reshape.migrate(migrations)?;
71 reshape.migrate(migrations)?;
120
72
121 // Automatically complete migration if --complete flag is set
73 // Automatically complete migration if --complete flag is set
122 if opts.complete {
74 if opts.complete {
123− reshape.complete()?;
75+ reshape.complete_migration()?;
124 }
76 }
125
77
126 Ok(())
78 Ok(())
127 }
79 }
128− Command::Migration(MigrationCommand::Complete(opts)) | Command::Complete(opts) => {
80+ Command::Complete(opts) => {
81+ let mut reshape = reshape_from_connection_options(&opts)?;
82+ reshape.complete_migration()
83+ }
84+ Command::Remove(opts) => {
129 let mut reshape = reshape_from_connection_options(&opts)?;
85 let mut reshape = reshape_from_connection_options(&opts)?;
130− reshape.complete()
86+ reshape.remove()
131 }
87 }
132− Command::Migration(MigrationCommand::Abort(opts)) | Command::Abort(opts) => {
88+ Command::Abort(opts) => {
133 let mut reshape = reshape_from_connection_options(&opts)?;
89 let mut reshape = reshape_from_connection_options(&opts)?;
134 reshape.abort()
90 reshape.abort()
135 }
91 }
136− Command::SchemaQuery(opts) | Command::GenerateSchemaQuery(opts) => {
92+ Command::GenerateSchemaQuery(find_migrations_options) => {
137− let migrations = find_migrations(&opts)?;
93+ let migrations = find_migrations(&find_migrations_options)?;
138 let query = migrations
94 let query = migrations
139 .last()
95 .last()
140 .map(|migration| reshape::schema_query_for_migration(&migration.name));
96 .map(|migration| reshape::schema_query_for_migration(&migration.name));
@@ -146,35 +102,13 @@ fn run(opts: Opts) -> anyhow::Result<()> {
146}
102}
147
103
148fn reshape_from_connection_options(opts: &ConnectionOptions) -> anyhow::Result<Reshape> {
104fn reshape_from_connection_options(opts: &ConnectionOptions) -> anyhow::Result<Reshape> {
149− // Load environment variables from .env file if it exists
105+ let env_url = std::env::var("POSTGRES_URL").ok();
150− dotenv::dotenv().ok();
106+ let url = env_url.as_ref().or_else(|| opts.url.as_ref());
151
107
152− let url_env = std::env::var("DB_URL").ok();
108+ match url {
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);
109+ Some(url) => Reshape::new(url),
110+ None => Reshape::new_with_options(&opts.host, opts.port, &opts.username, &opts.password),
158 }
111 }
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)
178}
112}
179
113
180fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration>> {
114fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration>> {
@@ -196,13 +130,7 @@ fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration
196 }
130 }
197
131
198 // Sort all files by their file names (without extension)
132 // Sort all files by their file names (without extension)
199− // The files are sorted naturally, e.g. "1_test_migration" < "10_test_migration"
133+ file_paths.sort_unstable_by_key(|path| path.as_path().file_stem().unwrap().to_os_string());
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− });
206
134
207 file_paths
135 file_paths
208 .iter()
136 .iter()
@@ -218,10 +146,7 @@ fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration
218 .map(|result| {
146 .map(|result| {
219 result.and_then(|(path, data)| {
147 result.and_then(|(path, data)| {
220 let extension = path.extension().and_then(|ext| ext.to_str()).unwrap();
148 let extension = path.extension().and_then(|ext| ext.to_str()).unwrap();
221− let file_migration =
222− decode_migration_file(&data, extension).with_context(|| {
149+ let file_migration = decode_migration_file(&data, extension)?;
223− format!("failed to parse migration file {}", path.display())
224− })?;
225
150
226 let file_name = path.file_stem().and_then(|name| name.to_str()).unwrap();
151 let file_name = path.file_stem().and_then(|name| name.to_str()).unwrap();
227 Ok(Migration {
152 Ok(Migration {
src/migrations/add_column.rs+60−214
@@ -3,25 +3,14 @@ use crate::{
3 db::{Conn, Transaction},
3 db::{Conn, Transaction},
4 schema::Schema,
4 schema::Schema,
5};
5};
6−use anyhow::{bail, Context};
6+use anyhow::Context;
7use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
8
8
9#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
10pub struct AddColumn {
10pub struct AddColumn {
11 pub table: String,
11 pub table: String,
12+ pub up: Option<String>,
12 pub column: Column,
13 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− },
25}
14}
26
15
27impl AddColumn {
16impl AddColumn {
@@ -43,15 +32,6 @@ impl AddColumn {
43 )
32 )
44 }
33 }
45
34
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−
55 fn not_null_constraint_name(&self, ctx: &MigrationContext) -> String {
35 fn not_null_constraint_name(&self, ctx: &MigrationContext) -> String {
56 format!(
36 format!(
57 "{}_add_column_not_null_{}_{}",
37 "{}_add_column_not_null_{}_{}",
@@ -81,7 +61,7 @@ impl Action for AddColumn {
81 let temp_column_name = self.temp_column_name(ctx);
61 let temp_column_name = self.temp_column_name(ctx);
82
62
83 let mut definition_parts = vec![
63 let mut definition_parts = vec![
84− format!("\"{}\"", temp_column_name.to_string()),
64+ temp_column_name.to_string(),
85 self.column.data_type.to_string(),
65 self.column.data_type.to_string(),
86 ];
66 ];
87
67
@@ -106,189 +86,55 @@ impl Action for AddColumn {
106 );
86 );
107 db.run(&query).context("failed to add column")?;
87 db.run(&query).context("failed to add column")?;
108
88
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−
122 if let Some(up) = &self.up {
89 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)?;
90+ let table = schema.get_table(db, &self.table)?;
169−
91+
170− let from_table_assignments: Vec<String> = from_table
92+ let declarations: Vec<String> = table
171− .columns
93+ .columns
172− .iter()
94+ .iter()
173− .map(|column| {
95+ .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!(
96+ format!(
185− r#"
97+ "{alias} public.{table}.{real_name}%TYPE := NEW.{real_name};",
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,
98+ table = table.real_name,
237− alias = column.name,
99+ alias = column.name,
238− real_name = column.real_name,
100+ real_name = column.real_name,
239− )
101+ )
240− })
102+ })
241− .collect();
103+ .collect();
242−
104+
243− // Add triggers to fill in values as they are inserted/updated
105+ // Add triggers to fill in values as they are inserted/updated
244− let query = format!(
106+ let query = format!(
245− r#"
107+ r#"
246− CREATE OR REPLACE FUNCTION {trigger_name}()
108+ CREATE OR REPLACE FUNCTION {trigger_name}()
247− RETURNS TRIGGER AS $$
109+ RETURNS TRIGGER AS $$
248− #variable_conflict use_variable
110+ BEGIN
249− BEGIN
111+ IF reshape.is_old_schema() THEN
250− IF NOT reshape.is_new_schema() AND NOT current_setting('reshape.disable_triggers', TRUE) = 'TRUE' THEN
251− DECLARE
112+ DECLARE
252− {changed_table} migration_{existing_schema_name}.{changed_table}%ROWTYPE;
113+ {declarations}
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
114+ BEGIN
265− {from_table} = __temp_row;
266− NEW.{temp_column_name} = {value};
115+ NEW.{temp_column_name} = {up};
267− END;
268− END;
116+ END;
269− END IF;
117+ END IF;
270− RETURN NEW;
118+ RETURN NEW;
271− END
119+ END
272− $$ language 'plpgsql';
120+ $$ language 'plpgsql';
273−
121+
274− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{changed_table_real}";
122+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
275− CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{changed_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
123+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
276− "#,
124+ "#,
277− changed_table_assignments = changed_table_assignments.join("\n"),
125+ temp_column_name = temp_column_name,
278− changed_table_real = table.real_name,
126+ trigger_name = self.trigger_name(ctx),
279− changed_table = table.name,
127+ up = up,
280− from_table = from_table.name,
128+ table = self.table,
281− trigger_name = self.reverse_trigger_name(ctx),
282− temp_column_name = temp_column_name,
283− // declarations = declarations.join("\n"),
129+ declarations = declarations.join("\n"),
284− );
130+ );
285− db.run(&query)
286− .context("failed to create reverse up trigger")?;
131+ db.run(&query).context("failed to create up trigger")?;
132+ }
287
133
288− // Backfill values in batches by touching the from table
134+ // Backfill values in batches
135+ if self.up.is_some() {
289− common::batch_touch_rows(db, &from_table.real_name, None)
136+ common::batch_touch_rows(db, &table.real_name, &temp_column_name)
290− .context("failed to batch update existing rows")?;
137+ .context("failed to batch update existing rows")?;
291− }
292 }
138 }
293
139
294 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
140 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
@@ -298,10 +144,10 @@ impl Action for AddColumn {
298 if !self.column.nullable {
144 if !self.column.nullable {
299 let query = format!(
145 let query = format!(
300 r#"
146 r#"
301− ALTER TABLE "{table}"
147+ ALTER TABLE "{table}"
302− ADD CONSTRAINT "{constraint_name}"
148+ ADD CONSTRAINT "{constraint_name}"
303− CHECK ("{column}" IS NOT NULL) NOT VALID
149+ CHECK ("{column}" IS NOT NULL) NOT VALID
304− "#,
150+ "#,
305 table = self.table,
151 table = self.table,
306 constraint_name = self.not_null_constraint_name(ctx),
152 constraint_name = self.not_null_constraint_name(ctx),
307 column = temp_column_name,
153 column = temp_column_name,
@@ -323,11 +169,11 @@ impl Action for AddColumn {
323 // Remove triggers and procedures
169 // Remove triggers and procedures
324 let query = format!(
170 let query = format!(
325 r#"
171 r#"
326− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
172+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
327− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
173+ DROP FUNCTION IF EXISTS "{trigger_name}";
328 "#,
174 "#,
175+ table = self.table,
329 trigger_name = self.trigger_name(ctx),
176 trigger_name = self.trigger_name(ctx),
330− reverse_trigger_name = self.reverse_trigger_name(ctx),
331 );
177 );
332 transaction
178 transaction
333 .run(&query)
179 .run(&query)
@@ -418,11 +264,11 @@ impl Action for AddColumn {
418 // Remove triggers and procedures
264 // Remove triggers and procedures
419 let query = format!(
265 let query = format!(
420 r#"
266 r#"
421− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
267+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
422− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
268+ DROP FUNCTION IF EXISTS "{trigger_name}";
423 "#,
269 "#,
270+ table = self.table,
424 trigger_name = self.trigger_name(ctx),
271 trigger_name = self.trigger_name(ctx),
425− reverse_trigger_name = self.reverse_trigger_name(ctx),
426 );
272 );
427 db.run(&query).context("failed to drop up trigger")?;
273 db.run(&query).context("failed to drop up trigger")?;
428
274
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/add_index.rs+5−24
@@ -9,26 +9,14 @@ use serde::{Deserialize, Serialize};
9#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
10pub struct AddIndex {
10pub struct AddIndex {
11 pub table: String,
11 pub table: String,
12− pub index: Index,
13−}
14−
15−#[derive(Serialize, Deserialize, Clone, Debug)]
16−pub struct Index {
17 pub name: String,
12 pub name: String,
18 pub columns: Vec<String>,
13 pub columns: Vec<String>,
19− #[serde(default)]
20− pub unique: bool,
21− #[serde(rename = "type")]
22− pub index_type: Option<String>,
23}
14}
24
15
25#[typetag::serde(name = "add_index")]
16#[typetag::serde(name = "add_index")]
26impl Action for AddIndex {
17impl Action for AddIndex {
27 fn describe(&self) -> String {
18 fn describe(&self) -> String {
28− format!(
29− "Adding index \"{}\" to table \"{}\"",
19+ format!("Adding index \"{}\" to table \"{}\"", self.name, self.table)
30− self.index.name, self.table
31− )
32 }
20 }
33
21
34 fn run(
22 fn run(
@@ -42,22 +30,15 @@ impl Action for AddIndex {
42 let column_real_names: Vec<String> = table
30 let column_real_names: Vec<String> = table
43 .columns
31 .columns
44 .iter()
32 .iter()
45− .filter(|column| self.index.columns.contains(&column.name))
33+ .filter(|column| self.columns.contains(&column.name))
46 .map(|column| format!("\"{}\"", column.real_name))
34 .map(|column| format!("\"{}\"", column.real_name))
47 .collect();
35 .collect();
48
36
49− let unique = if self.index.unique { "UNIQUE" } else { "" };
50− let index_type_def = if let Some(index_type) = &self.index.index_type {
51− format!("USING {index_type}")
52− } else {
53− "".to_string()
54− };
55−
56 db.run(&format!(
37 db.run(&format!(
57 r#"
38 r#"
58− CREATE {unique} INDEX CONCURRENTLY "{name}" ON "{table}" {index_type_def} ({columns})
39+ CREATE INDEX CONCURRENTLY "{name}" ON "{table}" ({columns})
59 "#,
40 "#,
60− name = self.index.name,
41+ name = self.name,
61 table = self.table,
42 table = self.table,
62 columns = column_real_names.join(", "),
43 columns = column_real_names.join(", "),
63 ))
44 ))
@@ -80,7 +61,7 @@ impl Action for AddIndex {
80 r#"
61 r#"
81 DROP INDEX CONCURRENTLY IF EXISTS "{name}"
62 DROP INDEX CONCURRENTLY IF EXISTS "{name}"
82 "#,
63 "#,
83− name = self.index.name,
64+ name = self.name,
84 ))
65 ))
85 .context("failed to drop index")?;
66 .context("failed to drop index")?;
86 Ok(())
67 Ok(())
src/migrations/alter_column.rs+11−103
@@ -13,11 +13,10 @@ pub struct AlterColumn {
13 pub column: String,
13 pub column: String,
14 pub up: Option<String>,
14 pub up: Option<String>,
15 pub down: Option<String>,
15 pub down: Option<String>,
16− #[serde(default)]
17 pub changes: ColumnChanges,
16 pub changes: ColumnChanges,
18}
17}
19
18
20−#[derive(Serialize, Deserialize, Default, Debug)]
19+#[derive(Serialize, Deserialize, Debug)]
21pub struct ColumnChanges {
20pub struct ColumnChanges {
22 pub name: Option<String>,
21 pub name: Option<String>,
23 #[serde(rename = "type")]
22 #[serde(rename = "type")]
@@ -48,7 +47,9 @@ impl Action for AlterColumn {
48 let table = schema.get_table(db, &self.table)?;
47 let table = schema.get_table(db, &self.table)?;
49
48
50 let column = table
49 let column = table
50+ .columns
51+ .iter()
51− .get_column(&self.column)
52+ .find(|column| column.name == self.column)
52 .ok_or_else(|| anyhow!("no such column {} exists", self.column))?;
53 .ok_or_else(|| anyhow!("no such column {} exists", self.column))?;
53
54
54 let temporary_column_name = self.temporary_column_name(ctx);
55 let temporary_column_name = self.temporary_column_name(ctx);
@@ -56,14 +57,10 @@ impl Action for AlterColumn {
56
57
57 // Add temporary, nullable column
58 // Add temporary, nullable column
58 let mut temp_column_definition_parts: Vec<&str> =
59 let mut temp_column_definition_parts: Vec<&str> =
59− vec![&temporary_column_name, temporary_column_type];
60+ vec![&temporary_column_name, &temporary_column_type];
60
61
61 // Use either new default value or existing one if one exists
62 // Use either new default value or existing one if one exists
62− let default_value = self
63+ let default_value = self.changes.default.as_ref().or(column.default.as_ref());
63− .changes
64− .default
65− .as_ref()
66− .or_else(|| column.default.as_ref());
67 if let Some(default) = default_value {
64 if let Some(default) = default_value {
68 temp_column_definition_parts.push("DEFAULT");
65 temp_column_definition_parts.push("DEFAULT");
69 temp_column_definition_parts.push(default);
66 temp_column_definition_parts.push(default);
@@ -103,7 +100,7 @@ impl Action for AlterColumn {
103 CREATE OR REPLACE FUNCTION {up_trigger}()
100 CREATE OR REPLACE FUNCTION {up_trigger}()
104 RETURNS TRIGGER AS $$
101 RETURNS TRIGGER AS $$
105 BEGIN
102 BEGIN
106− IF NOT reshape.is_new_schema() THEN
103+ IF reshape.is_old_schema() THEN
107 DECLARE
104 DECLARE
108 {declarations}
105 {declarations}
109 {existing_column} public.{table}.{existing_column_real}%TYPE := NEW.{existing_column_real};
106 {existing_column} public.{table}.{existing_column_real}%TYPE := NEW.{existing_column_real};
@@ -121,7 +118,7 @@ impl Action for AlterColumn {
121 CREATE OR REPLACE FUNCTION {down_trigger}()
118 CREATE OR REPLACE FUNCTION {down_trigger}()
122 RETURNS TRIGGER AS $$
119 RETURNS TRIGGER AS $$
123 BEGIN
120 BEGIN
124− IF reshape.is_new_schema() THEN
121+ IF NOT reshape.is_old_schema() THEN
125 DECLARE
122 DECLARE
126 {declarations}
123 {declarations}
127 {existing_column} public.{table}.{temp_column}%TYPE := NEW.{temp_column};
124 {existing_column} public.{table}.{temp_column}%TYPE := NEW.{temp_column};
@@ -150,44 +147,14 @@ impl Action for AlterColumn {
150 .context("failed to create up and down triggers")?;
147 .context("failed to create up and down triggers")?;
151
148
152 // Backfill values in batches by touching the previous column
149 // Backfill values in batches by touching the previous column
153− common::batch_touch_rows(db, &table.real_name, Some(&column.real_name))
150+ common::batch_touch_rows(db, &table.real_name, &column.real_name)
154 .context("failed to batch update existing rows")?;
151 .context("failed to batch update existing rows")?;
155
152
156− // Duplicate any indices to the temporary column
157− 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− .into_iter()
161− .map(|idx_column| {
162− // Replace column with temporary column for new index
163− if idx_column == column.real_name {
164− temporary_column_name.to_string()
165− } else {
166− idx_column
167− }
168− })
169− .collect();
170− let temp_index_name = self.temp_index_name(ctx, index.oid);
171−
172− let unique_def = if index.unique { "UNIQUE" } else { "" };
173−
174− db.query(&format!(
175− r#"
176− CREATE {unique_def} INDEX CONCURRENTLY IF NOT EXISTS "{new_index_name}" ON "{table}" USING {index_type} ({columns})
177− "#,
178− new_index_name = temp_index_name,
179− table = table.real_name,
180− columns = index_columns.join(", "),
181− index_type = index.index_type,
182− ))
183− .context("failed to create temporary index")?;
184− }
185−
186 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
153 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
187 // This constraint is set as NOT VALID so it doesn't apply to existing rows and
154 // This constraint is set as NOT VALID so it doesn't apply to existing rows and
188 // the existing rows don't need to be scanned under an exclusive lock.
155 // the existing rows don't need to be scanned under an exclusive lock.
189 // Thanks to this, we can set the full column as NOT NULL later with minimal locking.
156 // 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) {
157+ if !column.nullable {
191 let query = format!(
158 let query = format!(
192 r#"
159 r#"
193 ALTER TABLE "{table}"
160 ALTER TABLE "{table}"
@@ -279,52 +246,10 @@ impl Action for AlterColumn {
279 .context("failed to drop NOT NULL constraint")?;
246 .context("failed to drop NOT NULL constraint")?;
280 }
247 }
281
248
282− // Replace old indices with the new temporary ones created for the temporary column
283− let indices = common::get_indices_for_column(db, &self.table, &self.column)?;
284− for current_index in indices {
285− // To keep the index handling idempotent, we need to do the following:
286− // 1. Add a prefix to the existing index
287− // 2. Rename temporary index to its final name
288− // 3. Drop existing index concurrently
289−
290− // Add prefix (if not already added) to existing index
291− let prefix = "__reshape_old";
292− let target_index_name = current_index.name.trim_start_matches(prefix);
293− let old_index_name = format!("{}_{}", prefix, target_index_name);
294− db.query(&format!(
295− r#"
296− ALTER INDEX IF EXISTS "{current_name}" RENAME TO "{new_name}"
297− "#,
298− current_name = target_index_name,
299− new_name = old_index_name,
300− ))
301− .context("failed to rename old index")?;
302−
303− // Rename temporary index to real name
304− let temp_index_name = self.temp_index_name(ctx, current_index.oid);
305− db.query(&format!(
306− r#"
307− ALTER INDEX IF EXISTS "{temp_index_name}" RENAME TO "{target_index_name}"
308− "#,
309− temp_index_name = temp_index_name,
310− target_index_name = target_index_name,
311− ))
312− .context("failed to rename temporary index")?;
313−
314− // Drop old index concurrently
315− db.query(&format!(
316− r#"
317− DROP INDEX CONCURRENTLY IF EXISTS "{old_index_name}"
318− "#,
319− old_index_name = old_index_name,
320− ))
321− .context("failed to drop old index")?;
322− }
323−
324 // Remove old column
249 // Remove old column
325 let query = format!(
250 let query = format!(
326 r#"
251 r#"
327− ALTER TABLE "{table}" DROP COLUMN IF EXISTS "{column}" CASCADE
252+ ALTER TABLE "{table}" DROP COLUMN "{column}" CASCADE
328 "#,
253 "#,
329 table = self.table,
254 table = self.table,
330 column = self.column,
255 column = self.column,
@@ -386,19 +311,6 @@ impl Action for AlterColumn {
386 }
311 }
387
312
388 fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
313 fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
389− // Safely remove any indices created for the temporary column
390− let temp_column_name = self.temporary_column_name(ctx);
391− 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);
394− db.query(&format!(
395− r#"
396− DROP INDEX CONCURRENTLY IF EXISTS "{index_name}"
397− "#,
398− index_name = temp_index_name,
399− ))?;
400− }
401−
402 // Drop temporary column
314 // Drop temporary column
403 let query = format!(
315 let query = format!(
404 r#"
316 r#"
@@ -447,10 +359,6 @@ impl AlterColumn {
447 format!("{}_alter_column_temporary", ctx.prefix())
359 format!("{}_alter_column_temporary", ctx.prefix())
448 }
360 }
449
361
450− fn temp_index_name(&self, ctx: &MigrationContext, index_oid: u32) -> String {
451− format!("{}_alter_column_temp_index_{}", ctx.prefix(), index_oid)
452− }
453−
454 fn can_short_circuit(&self) -> bool {
362 fn can_short_circuit(&self) -> bool {
455 self.changes.name.is_some()
363 self.changes.name.is_some()
456 && self.changes.data_type.is_none()
364 && self.changes.data_type.is_none()
src/migrations/common.rs+23−116
@@ -1,17 +1,25 @@
1−use anyhow::anyhow;
1+use derive_builder::Builder;
2use postgres::types::{FromSql, ToSql};
2use postgres::types::{FromSql, ToSql};
3use serde::{Deserialize, Serialize};
3use serde::{Deserialize, Serialize};
4
4
5use crate::db::Conn;
5use crate::db::Conn;
6
6
7−#[derive(Serialize, Deserialize, Clone, Debug)]
7+#[derive(Serialize, Deserialize, Builder, Clone, Debug)]
8+#[builder(setter(into))]
8pub struct Column {
9pub struct Column {
9 pub name: String,
10 pub name: String,
11+
10 #[serde(rename = "type")]
12 #[serde(rename = "type")]
11 pub data_type: String,
13 pub data_type: String,
14+
12 #[serde(default = "nullable_default")]
15 #[serde(default = "nullable_default")]
16+ #[builder(default = "true")]
13 pub nullable: bool,
17 pub nullable: bool,
18+
19+ #[builder(setter(name = "default_value", strip_option), default)]
14 pub default: Option<String>,
20 pub default: Option<String>,
21+
22+ #[builder(setter(strip_option), default)]
15 pub generated: Option<String>,
23 pub generated: Option<String>,
16}
24}
17
25
@@ -19,13 +27,6 @@ fn nullable_default() -> bool {
19 true
27 true
20}
28}
21
29
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−
29#[derive(Debug)]
30#[derive(Debug)]
30struct PostgresRawValue {
31struct PostgresRawValue {
31 bytes: Vec<u8>,
32 bytes: Vec<u8>,
@@ -69,26 +70,17 @@ impl ToSql for PostgresRawValue {
69 postgres::types::to_sql_checked!();
70 postgres::types::to_sql_checked!();
70}
71}
71
72
72−pub fn batch_touch_rows(
73+pub fn batch_touch_rows(db: &mut dyn Conn, table: &str, column: &str) -> anyhow::Result<()> {
73− db: &mut dyn Conn,
74− table: &str,
75− column: Option<&str>,
76−) -> anyhow::Result<()> {
77 const BATCH_SIZE: u16 = 1000;
74 const BATCH_SIZE: u16 = 1000;
78
75
76+ db.query("SET reshape.is_old_schema = 'YES'")?;
77+
79 let mut cursor: Option<PostgresRawValue> = None;
78 let mut cursor: Option<PostgresRawValue> = None;
80
79
81 loop {
80 loop {
82 let mut params: Vec<&(dyn ToSql + Sync)> = Vec::new();
81 let mut params: Vec<&(dyn ToSql + Sync)> = Vec::new();
83
82
84 let primary_key = get_primary_key_columns_for_table(db, table)?;
83 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−
92 let primary_key_columns = primary_key.join(", ");
84 let primary_key_columns = primary_key.join(", ");
93
85
94 let primary_key_where = primary_key
86 let primary_key_where = primary_key
@@ -131,8 +123,8 @@ pub fn batch_touch_rows(
131 ORDER BY {primary_key_columns}
123 ORDER BY {primary_key_columns}
132 LIMIT {batch_size}
124 LIMIT {batch_size}
133 ), update AS (
125 ), update AS (
134− UPDATE public."{table}" "{table}"
126+ UPDATE public."{table}"
135− SET "{touched_column}" = "{table}"."{touched_column}"
127+ SET "{column}" = "{column}"
136 FROM rows
128 FROM rows
137 WHERE {primary_key_where}
129 WHERE {primary_key_where}
138 RETURNING {returning_columns}
130 RETURNING {returning_columns}
@@ -141,7 +133,13 @@ pub fn batch_touch_rows(
141 FROM update
133 FROM update
142 LIMIT 1
134 LIMIT 1
143 "#,
135 "#,
136+ table = table,
137+ primary_key_columns = primary_key_columns,
138+ cursor_where = cursor_where,
144 batch_size = BATCH_SIZE,
139 batch_size = BATCH_SIZE,
140+ column = column,
141+ primary_key_where = primary_key_where,
142+ returning_columns = returning_columns,
145 );
143 );
146 let last_value = db
144 let last_value = db
147 .query_with_params(&query, &params)?
145 .query_with_params(&query, &params)?
@@ -155,6 +153,8 @@ pub fn batch_touch_rows(
155 cursor = last_value
153 cursor = last_value
156 }
154 }
157
155
156+ db.query("SET reshape.is_old_schema = ''")?;
157+
158 Ok(())
158 Ok(())
159}
159}
160
160
@@ -180,96 +180,3 @@ fn get_primary_key_columns_for_table(
180
180
181 Ok(primary_key_columns)
181 Ok(primary_key_columns)
182}
182}
183−
184−pub struct Index {
185− pub name: String,
186− pub oid: u32,
187− pub unique: bool,
188− pub index_type: String,
189−}
190−
191−pub fn get_indices_for_column(
192− db: &mut dyn Conn,
193− table: &str,
194− column: &str,
195−) -> anyhow::Result<Vec<Index>> {
196− let indices = db
197− .query(&format!(
198− "
199− SELECT
200− i.relname AS name,
201− i.oid AS oid,
202− ix.indisunique AS unique,
203− am.amname AS type
204− FROM pg_index ix
205− JOIN pg_class t ON t.oid = ix.indrelid
206− JOIN pg_class i ON i.oid = ix.indexrelid
207− JOIN pg_am am ON i.relam = am.oid
208− JOIN pg_attribute a ON
209− a.attrelid = t.oid AND
210− a.attnum = ANY(ix.indkey)
211− WHERE
212− t.relname = '{table}' AND
213− a.attname = '{column}'
214− ",
215− table = table,
216− column = column,
217− ))?
218− .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− })
225− .collect();
226−
227− Ok(indices)
228−}
229−
230−pub fn get_index_columns(db: &mut dyn Conn, index_name: &str) -> anyhow::Result<Vec<String>> {
231− // Get all columns which are part of the index in order
232− let (table_oid, column_nums) = db
233− .query(&format!(
234− "
235− SELECT t.oid AS table_oid, ix.indkey::INTEGER[] AS columns
236− FROM pg_index ix
237− JOIN pg_class t ON t.oid = ix.indrelid
238− JOIN pg_class i ON i.oid = ix.indexrelid
239− WHERE
240− i.relname = '{index_name}'
241− ",
242− index_name = index_name,
243− ))?
244− .first()
245− .map(|row| {
246− (
247− row.get::<'_, _, u32>("table_oid"),
248− row.get::<'_, _, Vec<i32>>("columns"),
249− )
250− })
251− .ok_or_else(|| anyhow!("failed to get columns for index"))?;
252−
253− // Get the name of each of the columns, still in order
254− column_nums
255− .iter()
256− .map(|column_num| -> anyhow::Result<String> {
257− let name: String = db
258− .query(&format!(
259− "
260− SELECT attname AS name
261− FROM pg_attribute
262− WHERE attrelid = {table_oid}
263− AND attnum = {column_num};
264− ",
265− table_oid = table_oid,
266− column_num = column_num,
267− ))?
268− .first()
269− .map(|row| row.get("name"))
270− .ok_or_else(|| anyhow!("expected to find column"))?;
271−
272− Ok(name)
273− })
274− .collect::<anyhow::Result<Vec<String>>>()
275−}
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};
4use crate::{
2use crate::{
5 db::{Conn, Transaction},
3 db::{Conn, Transaction},
6− migrations::common,
7 schema::Schema,
4 schema::Schema,
8};
5};
9use anyhow::Context;
6use anyhow::Context;
7+use derive_builder::Builder;
10use serde::{Deserialize, Serialize};
8use serde::{Deserialize, Serialize};
11
9
12−#[derive(Serialize, Deserialize, Debug)]
10+#[derive(Serialize, Deserialize, Builder, Debug)]
11+#[builder(setter(into))]
13pub struct CreateTable {
12pub struct CreateTable {
14 pub name: String,
13 pub name: String,
15 pub columns: Vec<Column>,
14 pub columns: Vec<Column>,
16 pub primary_key: Vec<String>,
15 pub primary_key: Vec<String>,
17
16
18 #[serde(default)]
17 #[serde(default)]
18+ #[builder(default)]
19 pub foreign_keys: Vec<ForeignKey>,
19 pub foreign_keys: Vec<ForeignKey>,
20−
21− pub up: Option<Transformation>,
22}
20}
23
21
24−#[derive(Serialize, Deserialize, Debug)]
22+#[derive(Serialize, Deserialize, Clone, Debug)]
25−pub struct Transformation {
23+pub struct ForeignKey {
26− table: String,
24+ pub columns: Vec<String>,
27− values: HashMap<String, String>,
25+ pub referenced_table: String,
28− upsert_constraint: Option<String>,
26+ pub referenced_columns: Vec<String>,
29−}
30−
31−impl CreateTable {
32− fn trigger_name(&self, ctx: &MigrationContext) -> String {
33− format!("{}_create_table_{}", ctx.prefix(), self.name)
34− }
35}
27}
36
28
37#[typetag::serde(name = "create_table")]
29#[typetag::serde(name = "create_table")]
@@ -42,9 +34,9 @@ impl Action for CreateTable {
42
34
43 fn run(
35 fn run(
44 &self,
36 &self,
45− ctx: &MigrationContext,
37+ _ctx: &MigrationContext,
46 db: &mut dyn Conn,
38 db: &mut dyn Conn,
47− schema: &Schema,
39+ _schema: &Schema,
48 ) -> anyhow::Result<()> {
40 ) -> anyhow::Result<()> {
49 let mut definition_rows: Vec<String> = self
41 let mut definition_rows: Vec<String> = self
50 .columns
42 .columns
@@ -86,10 +78,9 @@ impl Action for CreateTable {
86 .iter()
78 .iter()
87 .map(|col| format!("\"{}\"", col))
79 .map(|col| format!("\"{}\"", col))
88 .collect();
80 .collect();
89−
90− let referenced_table = schema.get_table(db, &foreign_key.referenced_table)?;
91− let referenced_columns: Vec<String> = referenced_table
81+ let referenced_columns: Vec<String> = foreign_key
92− .real_column_names(&foreign_key.referenced_columns)
82+ .referenced_columns
83+ .iter()
93 .map(|col| format!("\"{}\"", col))
84 .map(|col| format!("\"{}\"", col))
94 .collect();
85 .collect();
95
86
@@ -98,12 +89,12 @@ impl Action for CreateTable {
98 FOREIGN KEY ({columns}) REFERENCES "{table}" ({referenced_columns})
89 FOREIGN KEY ({columns}) REFERENCES "{table}" ({referenced_columns})
99 "#,
90 "#,
100 columns = columns.join(", "),
91 columns = columns.join(", "),
101− table = referenced_table.real_name,
92+ table = foreign_key.referenced_table,
102 referenced_columns = referenced_columns.join(", "),
93 referenced_columns = referenced_columns.join(", "),
103 ));
94 ));
104 }
95 }
105
96
106− let query = &format!(
97+ db.run(&format!(
107 r#"
98 r#"
108 CREATE TABLE "{name}" (
99 CREATE TABLE "{name}" (
109 {definition}
100 {definition}
@@ -111,121 +102,26 @@ impl Action for CreateTable {
111 "#,
102 "#,
112 name = self.name,
103 name = self.name,
113 definition = definition_rows.join(",\n"),
104 definition = definition_rows.join(",\n"),
114− );
105+ ))
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")?;
106+ .context("failed to create table")?;
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−
194 Ok(())
107 Ok(())
195 }
108 }
196
109
197 fn complete<'a>(
110 fn complete<'a>(
198 &self,
111 &self,
199− ctx: &MigrationContext,
112+ _ctx: &MigrationContext,
200− db: &'a mut dyn Conn,
113+ _db: &'a mut dyn Conn,
201 ) -> anyhow::Result<Option<Transaction<'a>>> {
114 ) -> anyhow::Result<Option<Transaction<'a>>> {
202− // Remove triggers and procedures
115+ // Do nothing
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−
211 Ok(None)
116 Ok(None)
212 }
117 }
213
118
214 fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
119 fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
215
120
216− fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
121+ 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−
226 db.run(&format!(
122 db.run(&format!(
227 r#"
123 r#"
228− DROP TABLE IF EXISTS "{name}"
124+ DROP TABLE IF EXISTS {name}
229 "#,
125 "#,
230 name = self.name,
126 name = self.name,
231 ))
127 ))
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+4−25
@@ -7,10 +7,10 @@ use serde::{Deserialize, Serialize};
7
7
8// Re-export migration types
8// Re-export migration types
9mod common;
9mod common;
10−pub use common::Column;
10+pub use common::{Column, ColumnBuilder};
11
11
12mod create_table;
12mod create_table;
13−pub use create_table::CreateTable;
13+pub use create_table::{CreateTable, CreateTableBuilder, ForeignKey};
14
14
15mod alter_column;
15mod alter_column;
16pub use alter_column::{AlterColumn, ColumnChanges};
16pub use alter_column::{AlterColumn, ColumnChanges};
@@ -22,7 +22,7 @@ mod remove_column;
22pub use remove_column::RemoveColumn;
22pub use remove_column::RemoveColumn;
23
23
24mod add_index;
24mod add_index;
25−pub use add_index::{AddIndex, Index};
25+pub use add_index::AddIndex;
26
26
27mod remove_index;
27mod remove_index;
28pub use remove_index::RemoveIndex;
28pub use remove_index::RemoveIndex;
@@ -33,21 +33,6 @@ pub use remove_table::RemoveTable;
33mod rename_table;
33mod rename_table;
34pub use rename_table::RenameTable;
34pub use rename_table::RenameTable;
35
35
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−
51#[derive(Serialize, Deserialize, Debug)]
36#[derive(Serialize, Deserialize, Debug)]
52pub struct Migration {
37pub struct Migration {
53 pub name: String,
38 pub name: String,
@@ -88,19 +73,13 @@ impl Clone for Migration {
88pub struct MigrationContext {
73pub struct MigrationContext {
89 migration_index: usize,
74 migration_index: usize,
90 action_index: usize,
75 action_index: usize,
91− existing_schema_name: Option<String>,
92}
76}
93
77
94impl MigrationContext {
78impl MigrationContext {
95− pub fn new(
96− migration_index: usize,
79+ pub fn new(migration_index: usize, action_index: usize) -> Self {
97− action_index: usize,
98− existing_schema_name: Option<String>,
99− ) -> Self {
100 MigrationContext {
80 MigrationContext {
101 migration_index,
81 migration_index,
102 action_index,
82 action_index,
103− existing_schema_name,
104 }
83 }
105 }
84 }
106
85
src/migrations/remove_column.rs+35−353
@@ -1,27 +1,16 @@
1−use super::{common, Action, MigrationContext};
1+use super::{Action, MigrationContext};
2use crate::{
2use crate::{
3 db::{Conn, Transaction},
3 db::{Conn, Transaction},
4 schema::Schema,
4 schema::Schema,
5};
5};
6−use anyhow::{anyhow, bail, Context};
6+use anyhow::Context;
7use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
8
8
9#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
10pub struct RemoveColumn {
10pub struct RemoveColumn {
11 pub table: String,
11 pub table: String,
12 pub column: String,
12 pub column: String,
13− pub down: Option<Transformation>,
13+ pub down: Option<String>,
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− },
25}
14}
26
15
27impl RemoveColumn {
16impl RemoveColumn {
@@ -33,33 +22,6 @@ impl RemoveColumn {
33 self.column
22 self.column
34 )
23 )
35 }
24 }
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− }
63}
25}
64
26
65#[typetag::serde(name = "remove_column")]
27#[typetag::serde(name = "remove_column")]
@@ -77,13 +39,10 @@ impl Action for RemoveColumn {
77 db: &mut dyn Conn,
39 db: &mut dyn Conn,
78 schema: &Schema,
40 schema: &Schema,
79 ) -> anyhow::Result<()> {
41 ) -> 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−
85 // Add down trigger
42 // Add down trigger
86 if let Some(down) = &self.down {
43 if let Some(down) = &self.down {
44+ let table = schema.get_table(db, &self.table)?;
45+
87 let declarations: Vec<String> = table
46 let declarations: Vec<String> = table
88 .columns
47 .columns
89 .iter()
48 .iter()
@@ -97,226 +56,32 @@ impl Action for RemoveColumn {
97 })
56 })
98 .collect();
57 .collect();
99
58
100− if let Transformation::Simple(down) = down {
101− let query = format!(
59+ let query = format!(
102− r#"
60+ r#"
103− CREATE OR REPLACE FUNCTION {trigger_name}()
61+ CREATE OR REPLACE FUNCTION {trigger_name}()
104− RETURNS TRIGGER AS $$
62+ RETURNS TRIGGER AS $$
105− BEGIN
63+ BEGIN
106− IF reshape.is_new_schema() THEN
64+ IF NOT reshape.is_old_schema() IS NULL THEN
107− DECLARE
65+ 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"),
66+ {declarations}
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 $$
151 BEGIN
67 BEGIN
152− IF NOT reshape.is_new_schema() THEN
68+ NEW.{column_name} = {down};
153− IF NEW.{column} IS NULL THEN
154− RAISE EXCEPTION '{column} can not be null';
155− END IF;
69+ END;
156− END IF;
70+ END IF;
157− RETURN NEW;
71+ RETURN NEW;
158− END
72+ END
159− $$ language 'plpgsql';
73+ $$ language 'plpgsql';
160−
74+
161− DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
75+ 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}();
76+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
168− "#,
77+ "#,
169− table = self.table,
78+ column_name = self.column,
170− trigger_name = self.not_null_constraint_trigger_name(ctx),
79+ trigger_name = self.trigger_name(ctx),
171− column = self.column,
80+ down = down,
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,
81+ 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"),
82+ declarations = declarations.join("\n"),
316− );
83+ );
317− db.run(&query)
318− .context("failed to create reverse down trigger")?;
84+ db.run(&query).context("failed to create down trigger")?;
319− }
320 }
85 }
321
86
322 Ok(())
87 Ok(())
@@ -327,34 +92,18 @@ impl Action for RemoveColumn {
327 ctx: &MigrationContext,
92 ctx: &MigrationContext,
328 db: &'a mut dyn Conn,
93 db: &'a mut dyn Conn,
329 ) -> anyhow::Result<Option<Transaction<'a>>> {
94 ) -> 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−
343 // Remove column, function and trigger
95 // Remove column, function and trigger
344 let query = format!(
96 let query = format!(
345 r#"
97 r#"
346 ALTER TABLE "{table}"
98 ALTER TABLE "{table}"
347 DROP COLUMN IF EXISTS "{column}";
99 DROP COLUMN IF EXISTS "{column}";
348
100
349− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
101+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
350− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
351− DROP FUNCTION IF EXISTS "{null_trigger_name}" CASCADE;
102+ DROP FUNCTION IF EXISTS "{trigger_name}";
352 "#,
103 "#,
353 table = self.table,
104 table = self.table,
354 column = self.column,
105 column = self.column,
355 trigger_name = self.trigger_name(ctx),
106 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),
358 );
107 );
359 db.run(&query)
108 db.run(&query)
360 .context("failed to drop column and down trigger")?;
109 .context("failed to drop column and down trigger")?;
@@ -371,81 +120,14 @@ impl Action for RemoveColumn {
371 }
120 }
372
121
373 fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
122 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−
439 // Remove function and trigger
123 // Remove function and trigger
440 db.run(&format!(
124 db.run(&format!(
441 r#"
125 r#"
442− DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
126+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
443− DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
444− DROP FUNCTION IF EXISTS "{null_trigger_name}" CASCADE;
127+ DROP FUNCTION IF EXISTS "{trigger_name}";
445 "#,
128 "#,
129+ table = self.table,
446 trigger_name = self.trigger_name(ctx),
130 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),
449 ))
131 ))
450 .context("failed to drop down trigger")?;
132 .context("failed to drop down trigger")?;
451
133
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 {
209 let real_columns: Vec<(String, String, bool, Option<String>)> = db
209 let real_columns: Vec<(String, String, bool, Option<String>)> = db
210 .query(&format!(
210 .query(&format!(
211 "
211 "
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
213 FROM information_schema.columns
213 FROM information_schema.columns
214 WHERE table_name = '{table}' AND table_schema = 'public'
214 WHERE table_name = '{table}' AND table_schema = 'public'
215 ORDER BY ordinal_position
215 ORDER BY ordinal_position
@@ -286,20 +286,3 @@ impl Schema {
286 Ok(table)
286 Ok(table)
287 }
287 }
288}
288}
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−}
src/state.rs+65−155
@@ -4,9 +4,17 @@ use anyhow::anyhow;
4use serde::{Deserialize, Serialize};
4use serde::{Deserialize, Serialize};
5use version::version;
5use version::version;
6
6
7+#[derive(Serialize, Deserialize, Debug)]
8+pub struct State {
9+ pub version: String,
10+ pub status: Status,
11+ pub current_migration: Option<String>,
12+ pub migrations: Vec<Migration>,
13+}
14+
7#[derive(Serialize, Deserialize, Clone, Debug)]
15#[derive(Serialize, Deserialize, Clone, Debug)]
8−#[serde(tag = "state")]
16+#[serde(tag = "status")]
9−pub enum State {
17+pub enum Status {
10 #[serde(rename = "idle")]
18 #[serde(rename = "idle")]
11 Idle,
19 Idle,
12
20
@@ -32,23 +40,24 @@ pub enum State {
32}
40}
33
41
34impl State {
42impl State {
35− pub fn load(db: &mut impl Conn) -> anyhow::Result<State> {
43+ pub fn load(db: &mut impl Conn) -> State {
36− Self::ensure_schema_and_table(db)?;
44+ Self::ensure_schema_and_table(db);
37
45
46+ let results = db
38− let results = db.query("SELECT value FROM reshape.data WHERE key = 'state'")?;
47+ .query("SELECT value FROM reshape.data WHERE key = 'state'")
48+ .unwrap();
39
49
40− let state = match results.first() {
50+ match results.first() {
41 Some(row) => {
51 Some(row) => {
42 let json: serde_json::Value = row.get(0);
52 let json: serde_json::Value = row.get(0);
43− serde_json::from_value(json)?
53+ serde_json::from_value(json).unwrap()
44 }
54 }
45 None => Default::default(),
55 None => Default::default(),
46− };
56+ }
47− Ok(state)
48 }
57 }
49
58
50 pub fn save(&self, db: &mut impl Conn) -> anyhow::Result<()> {
59 pub fn save(&self, db: &mut impl Conn) -> anyhow::Result<()> {
51− Self::ensure_schema_and_table(db)?;
60+ Self::ensure_schema_and_table(db);
52
61
53 let json = serde_json::to_value(self)?;
62 let json = serde_json::to_value(self)?;
54 db.query_with_params(
63 db.query_with_params(
@@ -61,27 +70,27 @@ impl State {
61 pub fn clear(&mut self, db: &mut impl Conn) -> anyhow::Result<()> {
70 pub fn clear(&mut self, db: &mut impl Conn) -> anyhow::Result<()> {
62 db.run("DROP SCHEMA reshape CASCADE")?;
71 db.run("DROP SCHEMA reshape CASCADE")?;
63
72
64− *self = Self::default();
73+ let default = Self::default();
74+ self.status = default.status;
75+ self.current_migration = default.current_migration;
76+ self.migrations = default.migrations;
65
77
66 Ok(())
78 Ok(())
67 }
79 }
68
80
69− // Complete will change the state from Completing to Idle
81+ // Complete will change the status from Completing to Idle
70− pub fn complete(&mut self, db: &mut impl Conn) -> anyhow::Result<()> {
82+ pub fn complete(&mut self) -> anyhow::Result<()> {
71− let current_state = std::mem::replace(self, Self::Idle);
83+ let current_status = std::mem::replace(&mut self.status, Status::Idle);
72
84
73− match current_state {
85+ match current_status {
74− Self::Completing { migrations, .. } => {
86+ Status::Completing { mut migrations, .. } => {
75− // Add migrations and update state in a transaction to ensure atomicity
87+ let target_migration = migrations.last().unwrap().name.to_string();
76− let mut transaction = db.transaction()?;
88+ self.migrations.append(&mut migrations);
77− save_migrations(&mut transaction, &migrations)?;
89+ self.current_migration = Some(target_migration);
78− self.save(&mut transaction)?;
79− transaction.commit()?;
80 }
90 }
81 _ => {
91 _ => {
82− // Move old state back
92+ // Move old status back
83− *self = current_state;
93+ self.status = current_status;
84−
85 return Err(anyhow!(
94 return Err(anyhow!(
86 "couldn't update state to be completed, not in Completing state"
95 "couldn't update state to be completed, not in Completing state"
87 ));
96 ));
@@ -92,13 +101,13 @@ impl State {
92 }
101 }
93
102
94 pub fn applying(&mut self, new_migrations: Vec<Migration>) {
103 pub fn applying(&mut self, new_migrations: Vec<Migration>) {
95− *self = Self::Applying {
104+ self.status = Status::Applying {
96 migrations: new_migrations,
105 migrations: new_migrations,
97 };
106 };
98 }
107 }
99
108
100 pub fn in_progress(&mut self, new_migrations: Vec<Migration>) {
109 pub fn in_progress(&mut self, new_migrations: Vec<Migration>) {
101− *self = Self::InProgress {
110+ self.status = Status::InProgress {
102 migrations: new_migrations,
111 migrations: new_migrations,
103 };
112 };
104 }
113 }
@@ -109,7 +118,7 @@ impl State {
109 current_migration_index: usize,
118 current_migration_index: usize,
110 current_action_index: usize,
119 current_action_index: usize,
111 ) {
120 ) {
112− *self = Self::Completing {
121+ self.status = Status::Completing {
113 migrations,
122 migrations,
114 current_migration_index,
123 current_migration_index,
115 current_action_index,
124 current_action_index,
@@ -122,151 +131,52 @@ impl State {
122 last_migration_index: usize,
131 last_migration_index: usize,
123 last_action_index: usize,
132 last_action_index: usize,
124 ) {
133 ) {
125− *self = Self::Aborting {
134+ self.status = Status::Aborting {
126 migrations,
135 migrations,
127 last_migration_index,
136 last_migration_index,
128 last_action_index,
137 last_action_index,
129 }
138 }
130 }
139 }
131
140
132− fn ensure_schema_and_table(db: &mut impl Conn) -> anyhow::Result<()> {
141+ pub fn get_remaining_migrations(
133− db.run("CREATE SCHEMA IF NOT EXISTS reshape")?;
142+ &self,
134−
143+ new_migrations: impl IntoIterator<Item = Migration>,
135− // Create data table which will be a key-value table containing
144+ ) -> anyhow::Result<Vec<Migration>> {
136− // the version and current state.
145+ let mut new_iter = new_migrations.into_iter();
137− db.run("CREATE TABLE IF NOT EXISTS reshape.data (key TEXT PRIMARY KEY, value JSONB)")?;
138−
139− // Create migrations table which will store all completed migrations
140− db.run(
141− "
142− CREATE TABLE IF NOT EXISTS reshape.migrations (
143− index INTEGER GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
144− name TEXT NOT NULL,
145− description TEXT,
146− actions JSONB NOT NULL,
147− completed_at TIMESTAMP DEFAULT NOW()
148− )
149− ",
150− )?;
151−
152− // Update the current version
153− let encoded_version = serde_json::to_value(version!().to_string())?;
154− db.query_with_params(
155− "
156− INSERT INTO reshape.data (key, value)
157− VALUES ('version', $1)
158− ON CONFLICT (key) DO UPDATE SET value = $1
159− ",
160− &[&encoded_version],
161− )?;
162−
163− Ok(())
164− }
165−}
166−
167−impl Default for State {
168− fn default() -> Self {
169− Self::Idle
170− }
171−}
172
146
173−pub fn current_migration(db: &mut dyn Conn) -> anyhow::Result<Option<String>> {
174− let name: Option<String> = db
175− .query(
176− "
177− SELECT name
178− FROM reshape.migrations
179− ORDER BY index DESC
180− LIMIT 1
181− ",
182− )?
183− .first()
184− .map(|row| row.get("name"));
185− Ok(name)
186−}
187−
188−pub fn remaining_migrations(
189− db: &mut impl Conn,
190− new_migrations: impl IntoIterator<Item = Migration>,
191−) -> anyhow::Result<Vec<Migration>> {
192− let mut new_iter = new_migrations.into_iter();
193−
194− // Ensure the new migrations match up with the existing ones
147+ // Ensure the new migration match up with the existing ones
195− let mut highest_index: Option<i32> = None;
196− loop {
197− let migrations = get_migrations(db, highest_index)?;
198− if migrations.is_empty() {
199− break;
200− }
201−
202− for (index, existing) in migrations {
148+ for pair in self.migrations.iter().zip(new_iter.by_ref()) {
203− highest_index = Some(index);
149+ let (existing, ref new) = pair;
204−
205− let new = match new_iter.next() {
206− Some(migration) => migration,
207− None => {
208− return Err(anyhow!(
209− "existing migration {} doesn't exist in local migrations",
210− existing
211− ))
212− }
213− };
214−
215− if existing != new.name {
150+ if existing != new {
216 return Err(anyhow!(
151 return Err(anyhow!(
217 "existing migration {} does not match new migration {}",
152 "existing migration {} does not match new migration {}",
218− existing,
153+ existing.name,
219 new.name
154 new.name
220 ));
155 ));
221 }
156 }
222 }
157 }
223− }
224
158
225− // Return the remaining migrations
226− let items: Vec<Migration> = new_iter.collect();
159+ let items: Vec<Migration> = new_iter.collect();
227− Ok(items)
228−}
229
160
230−fn get_migrations(
231− db: &mut impl Conn,
232− index_larger_than: Option<i32>,
233−) -> anyhow::Result<Vec<(i32, String)>> {
234− let rows = if let Some(index_larger_than) = index_larger_than {
235− db.query_with_params(
236− "
237− SELECT index, name
238− FROM reshape.migrations
239− WHERE index > $1
240− ORDER BY index ASC
241− LIMIT 100
242− ",
243− &[&index_larger_than],
244− )?
245− } else {
246− db.query(
247− "
248− SELECT index, name
249− FROM reshape.migrations
161+ // Return the remaining migrations
250− LIMIT 100
162+ Ok(items)
251− ",
252− )?
253− };
163+ }
254
164
255− let migrations = rows
165+ fn ensure_schema_and_table(db: &mut impl Conn) {
256− .iter()
166+ db.run("CREATE SCHEMA IF NOT EXISTS reshape").unwrap();
257− .map(|row| (row.get("index"), row.get("name")))
258− .collect();
259− Ok(migrations)
260−}
261
167
262−fn save_migrations(db: &mut impl Conn, migrations: &[Migration]) -> anyhow::Result<()> {
168+ db.run("CREATE TABLE IF NOT EXISTS reshape.data (key TEXT PRIMARY KEY, value JSONB)")
263− for migration in migrations {
169+ .unwrap();
264− let encoded_actions = serde_json::to_value(&migration.actions)?;
265− db.query_with_params(
266− "INSERT INTO reshape.migrations(name, description, actions) VALUES ($1, $2, $3)",
267− &[&migration.name, &migration.description, &encoded_actions],
268− )?;
269 }
170 }
171+}
270
172
271− Ok(())
173+impl Default for State {
174+ fn default() -> Self {
175+ State {
176+ version: version!().to_string(),
177+ status: Status::Idle,
178+ current_migration: None,
179+ migrations: vec![],
180+ }
181+ }
272}
182}
tests/add_column.rs+263−315
@@ -1,60 +1,85 @@
1+use reshape::migrations::{AddColumn, Column, ColumnBuilder, CreateTableBuilder, Migration};
2+use reshape::Status;
3+
1mod common;
4mod common;
2−use common::Test;
3
5
4#[test]
6#[test]
5fn add_column() {
7fn add_column() {
6− let mut test = Test::new("Add column");
8+ let (mut reshape, mut old_db, mut new_db) = common::setup();
7−
9+
8− test.first_migration(
10+ let create_users_table = Migration::new("create_user_table", None).with_action(
9− r#"
11+ CreateTableBuilder::default()
10− name = "create_user_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
12+ .name("users")
15− primary_key = ["id"]
13+ .primary_key(vec!["id".to_string()])
16−
17− [[actions.columns]]
14+ .columns(vec![
15+ ColumnBuilder::default()
18− name = "id"
16+ .name("id")
19− type = "INTEGER"
17+ .data_type("INTEGER")
20−
18+ .build()
21− [[actions.columns]]
19+ .unwrap(),
20+ ColumnBuilder::default()
22− name = "name"
21+ .name("name")
23− type = "TEXT"
22+ .data_type("TEXT")
24− "#,
23+ .build()
24+ .unwrap(),
25+ ])
26+ .build()
27+ .unwrap(),
25 );
28 );
26
29
27− test.second_migration(
28− r#"
29− name = "add_first_and_last_name_columns"
30+ let add_first_last_name_columns = Migration::new("add_first_and_last_name_columns", None)
30−
31+ .with_action(AddColumn {
31− [[actions]]
32+ table: "users".to_string(),
32− type = "add_column"
33+ column: Column {
33− table = "users"
34+ name: "first".to_string(),
34−
35+ data_type: "TEXT".to_string(),
36+ nullable: false,
37+ default: None,
38+ generated: None,
39+ },
35− up = "(STRING_TO_ARRAY(name, ' '))[1]"
40+ up: Some("(STRING_TO_ARRAY(name, ' '))[1]".to_string()),
36−
41+ })
37− [actions.column]
42+ .with_action(AddColumn {
38− name = "first"
43+ table: "users".to_string(),
39− type = "TEXT"
44+ column: Column {
45+ name: "last".to_string(),
46+ data_type: "TEXT".to_string(),
40− nullable = false
47+ nullable: false,
41−
48+ default: None,
42− [[actions]]
49+ generated: None,
43− type = "add_column"
50+ },
44− table = "users"
45−
46− up = "(STRING_TO_ARRAY(name, ' '))[2]"
51+ up: Some("(STRING_TO_ARRAY(name, ' '))[2]".to_string()),
47−
52+ });
48− [actions.column]
53+
49− name = "last"
54+ let first_migrations = vec![create_users_table.clone()];
50− type = "TEXT"
55+ let second_migrations = vec![
51− nullable = false
56+ create_users_table.clone(),
52− "#,
57+ add_first_last_name_columns.clone(),
58+ ];
59+
60+ // Run first migration, should automatically finish
61+ reshape.migrate(first_migrations.clone()).unwrap();
62+ assert!(matches!(reshape.state.status, Status::Idle));
63+ assert_eq!(
64+ Some(&create_users_table.name),
65+ reshape.state.current_migration.as_ref()
53 );
66 );
54
67
55− test.after_first(|db| {
68+ // Update search paths
69+ old_db
70+ .simple_query(&reshape::schema_query_for_migration(
71+ &first_migrations.last().unwrap().name,
72+ ))
73+ .unwrap();
74+ new_db
75+ .simple_query(&reshape::schema_query_for_migration(
76+ &first_migrations.last().unwrap().name,
77+ ))
78+ .unwrap();
79+
56− // Insert some test users
80+ // Insert some test users
81+ new_db
57− db.simple_query(
82+ .simple_query(
58 "
83 "
59 INSERT INTO users (id, name) VALUES
84 INSERT INTO users (id, name) VALUES
60 (1, 'John Doe'),
85 (1, 'John Doe'),
@@ -62,300 +87,223 @@ fn add_column() {
62 ",
87 ",
63 )
88 )
64 .unwrap();
89 .unwrap();
65− });
66−
67− test.intermediate(|old_db, new_db| {
68− // Check that the existing users have the new columns populated
69− let expected = vec![("John", "Doe"), ("Jane", "Doe")];
70− assert!(new_db
71− .query("SELECT first, last FROM users ORDER BY id", &[],)
72− .unwrap()
73− .iter()
74− .map(|row| (row.get("first"), row.get("last")))
75− .eq(expected));
76−
77− // Insert data using old schema and make sure the new columns are populated
78− old_db
79− .simple_query("INSERT INTO users (id, name) VALUES (3, 'Test Testsson')")
80− .unwrap();
81− let (first_name, last_name): (String, String) = new_db
82− .query_one("SELECT first, last from users WHERE id = 3", &[])
83− .map(|row| (row.get("first"), row.get("last")))
84− .unwrap();
85− assert_eq!(
86− ("Test", "Testsson"),
87− (first_name.as_ref(), last_name.as_ref())
88− );
89− });
90
90
91− test.after_completion(|db| {
91+ // Run second migration
92− let expected = vec![("John", "Doe"), ("Jane", "Doe"), ("Test", "Testsson")];
92+ reshape.migrate(second_migrations.clone()).unwrap();
93− assert!(db
93+ new_db
94− .query("SELECT first, last FROM users ORDER BY id", &[],)
94+ .simple_query(&reshape::schema_query_for_migration(
95− .unwrap()
95+ &second_migrations.last().unwrap().name,
96− .iter()
96+ ))
97− .map(|row| (row.get("first"), row.get("last")))
97+ .unwrap();
98− .eq(expected));
99− });
100
98
101− test.after_abort(|db| {
99+ // Check that the existing users have the new columns populated
102− let expected = vec![("John Doe"), ("Jane Doe"), ("Test Testsson")];
100+ let expected = vec![("John", "Doe"), ("Jane", "Doe")];
103− assert!(db
101+ assert!(new_db
104− .query("SELECT name FROM users ORDER BY id", &[],)
102+ .query("SELECT first, last FROM users ORDER BY id", &[],)
105− .unwrap()
103+ .unwrap()
106− .iter()
104+ .iter()
107− .map(|row| row.get::<'_, _, String>("name"))
105+ .map(|row| (row.get("first"), row.get("last")))
108− .eq(expected));
106+ .eq(expected));
107+
108+ // Insert data using old schema and make sure the new columns are populated
109+ old_db
110+ .simple_query("INSERT INTO users (id, name) VALUES (3, 'Test Testsson')")
111+ .unwrap();
112+ let (first_name, last_name): (String, String) = new_db
113+ .query_one("SELECT first, last from users WHERE id = 3", &[])
114+ .map(|row| (row.get("first"), row.get("last")))
115+ .unwrap();
116+ assert_eq!(
117+ ("Test", "Testsson"),
118+ (first_name.as_ref(), last_name.as_ref())
109− });
119+ );
110
120
111− test.run()
121+ reshape.complete_migration().unwrap();
122+ common::assert_cleaned_up(&mut new_db);
112}
123}
113
124
114#[test]
125#[test]
115fn add_column_nullable() {
126fn add_column_nullable() {
116− let mut test = Test::new("Add nullable column");
127+ let (mut reshape, mut old_db, mut new_db) = common::setup();
117−
128+
118− test.first_migration(
119− r#"
120− name = "create_users_table"
129+ let create_users_table = Migration::new("create_user_table", None).with_action(
121−
130+ CreateTableBuilder::default()
122− [[actions]]
123− type = "create_table"
124− name = "users"
131+ .name("users")
125− primary_key = ["id"]
132+ .primary_key(vec!["id".to_string()])
126−
133+ .columns(vec![ColumnBuilder::default()
127− [[actions.columns]]
128− name = "id"
134+ .name("id")
129− type = "INTEGER"
135+ .data_type("INTEGER")
130− "#,
136+ .build()
137+ .unwrap()])
138+ .build()
139+ .unwrap(),
131 );
140 );
141+ let add_name_column = Migration::new("add_nullable_name_column", None).with_action(AddColumn {
142+ table: "users".to_string(),
143+ column: Column {
144+ name: "name".to_string(),
145+ data_type: "TEXT".to_string(),
146+ nullable: true,
147+ default: None,
148+ generated: None,
149+ },
150+ up: None,
151+ });
132
152
133− test.second_migration(
153+ let first_migrations = vec![create_users_table.clone()];
134− r#"
154+ let second_migrations = vec![create_users_table.clone(), add_name_column.clone()];
135− name = "add_nullable_name_column"
136−
137− [[actions]]
138− type = "add_column"
139− table = "users"
140
155
141− [actions.column]
156+ // Run first migration, should automatically finish
142− name = "name"
157+ reshape.migrate(first_migrations.clone()).unwrap();
143− type = "TEXT"
158+ assert!(matches!(reshape.state.status, Status::Idle));
144− "#,
159+ assert_eq!(
160+ Some(&create_users_table.name),
161+ reshape.state.current_migration.as_ref()
145 );
162 );
146
163
147− test.after_first(|db| {
164+ // Update search paths
165+ old_db
166+ .simple_query(&reshape::schema_query_for_migration(
167+ &first_migrations.last().unwrap().name,
168+ ))
169+ .unwrap();
170+ new_db
171+ .simple_query(&reshape::schema_query_for_migration(
172+ &first_migrations.last().unwrap().name,
173+ ))
174+ .unwrap();
175+
148− // Insert some test values
176+ // Insert some test values
177+ new_db
149− db.simple_query(
178+ .simple_query(
150 "
179 "
151− INSERT INTO users (id) VALUES (1), (2);
180+ INSERT INTO users (id) VALUES
181+ (1),
182+ (2);
152 ",
183 ",
153 )
184 )
154 .unwrap();
185 .unwrap();
155− });
156
186
157− test.intermediate(|old_db, new_db| {
187+ // Run second migration
158− // Ensure existing data got updated
188+ reshape.migrate(second_migrations.clone()).unwrap();
159− let expected: Vec<Option<String>> = vec![None, None];
189+ new_db
160− assert!(new_db
190+ .simple_query(&reshape::schema_query_for_migration(
161− .query("SELECT name FROM users ORDER BY id", &[],)
191+ &second_migrations.last().unwrap().name,
162− .unwrap()
192+ ))
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);
176−
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();
193+ .unwrap();
181− });
182
194
183− test.after_completion(|db| {
195+ // Ensure existing data got updated
184− let expected: Vec<Option<String>> =
196+ let expected: Vec<Option<String>> = vec![None, None];
185− vec![None, None, None, Some("Test Testsson".to_string()), None];
197+ assert!(new_db
186− let result: Vec<Option<String>> = db
187− .query("SELECT id, name FROM users ORDER BY id", &[])
198+ .query("SELECT name FROM users ORDER BY id", &[],)
188− .unwrap()
199+ .unwrap()
189− .iter()
200+ .iter()
190− .map(|row| row.get("name"))
201+ .map(|row| row.get::<_, Option<String>>("name"))
191− .collect();
202+ .eq(expected));
192−
203+
204+ // Insert data using old schema and ensure new column is NULL
205+ old_db
206+ .simple_query("INSERT INTO users (id) VALUES (3)")
207+ .unwrap();
208+ let name: Option<String> = new_db
209+ .query_one("SELECT name from users WHERE id = 3", &[])
210+ .map(|row| (row.get("name")))
211+ .unwrap();
193− assert_eq!(result, expected);
212+ assert_eq!(None, name);
194− });
195
213
196− test.run();
214+ // Ensure data can be inserted against new schema
215+ new_db
216+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'Test Testsson'), (5, NULL)")
217+ .unwrap();
218+
219+ reshape.complete_migration().unwrap();
220+ common::assert_cleaned_up(&mut new_db);
197}
221}
198
222
199#[test]
223#[test]
200fn add_column_with_default() {
224fn add_column_with_default() {
201− let mut test = Test::new("Add column with default value");
225+ let (mut reshape, mut old_db, mut new_db) = common::setup();
202−
226+
203− test.first_migration(
227+ let create_users_table = Migration::new("create_user_table", None).with_action(
204− r#"
228+ CreateTableBuilder::default()
205− name = "create_users_table"
206−
207− [[actions]]
208− type = "create_table"
209− name = "users"
229+ .name("users")
210− primary_key = ["id"]
230+ .primary_key(vec!["id".to_string()])
211−
231+ .columns(vec![ColumnBuilder::default()
212− [[actions.columns]]
213− name = "id"
232+ .name("id")
214− type = "INTEGER"
233+ .data_type("INTEGER")
215− "#,
234+ .build()
216− );
235+ .unwrap()])
217−
236+ .build()
218− test.second_migration(
237+ .unwrap(),
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 );
238 );
233−
239+ let add_name_column =
234− test.after_first(|db| {
240+ Migration::new("add_name_column_with_default", None).with_action(AddColumn {
235− // Insert some test values
241+ table: "users".to_string(),
236− db.simple_query("INSERT INTO users (id) VALUES (1), (2)")
242+ column: Column {
237− .unwrap();
243+ name: "name".to_string(),
238− });
244+ data_type: "TEXT".to_string(),
239−
245+ nullable: false,
240− test.intermediate(|old_db, new_db| {
246+ default: Some("'DEFAULT'".to_string()),
241− // Ensure existing data got updated with defaults
247+ generated: None,
242− let expected = vec!["DEFAULT".to_string(), "DEFAULT".to_string()];
248+ },
243− assert!(new_db
249+ up: None,
244− .query("SELECT name FROM users ORDER BY id", &[],)
250+ });
245− .unwrap()
251+
246− .iter()
252+ let first_migrations = vec![create_users_table.clone()];
247− .map(|row| row.get::<_, String>("name"))
253+ let second_migrations = vec![create_users_table.clone(), add_name_column.clone()];
248− .eq(expected));
254+
249−
255+ // Run first migration, should automatically finish
250− // Insert data using old schema and ensure new column gets the default value
256+ reshape.migrate(first_migrations.clone()).unwrap();
251− old_db
257+ assert!(matches!(reshape.state.status, Status::Idle));
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);
258+ assert_eq!(
259− });
259+ Some(&create_users_table.name),
260−
260+ reshape.state.current_migration.as_ref()
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 );
261 );
295
262
296− test.second_migration(
263+ // Update search paths
297− r#"
264+ old_db
298− name = "add_profiles_email_column"
265+ .simple_query(&reshape::schema_query_for_migration(
299−
266+ &first_migrations.last().unwrap().name,
300− [[actions]]
267+ ))
301− type = "add_column"
268+ .unwrap();
302− table = "profiles"
269+ new_db
303−
270+ .simple_query(&reshape::schema_query_for_migration(
304− [actions.column]
271+ &first_migrations.last().unwrap().name,
305− name = "email"
272+ ))
306− type = "TEXT"
273+ .unwrap();
307− nullable = false
308
274
309− [actions.up]
275+ // Insert some test values
310− table = "users"
276+ new_db
311− value = "users.email"
277+ .simple_query("INSERT INTO users (id) VALUES (1), (2)")
312− where = "profiles.user_id = users.id"
278+ .unwrap();
313− "#,
314− );
315
279
316− test.after_first(|db| {
280+ // Run second migration
317− db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test@example.com')")
281+ reshape.migrate(second_migrations.clone()).unwrap();
318− .unwrap();
282+ new_db
319− db.simple_query("INSERT INTO profiles (user_id) VALUES (1)")
283+ .simple_query(&reshape::schema_query_for_migration(
284+ &second_migrations.last().unwrap().name,
285+ ))
320− .unwrap();
286+ .unwrap();
321− });
322
287
323− test.intermediate(|old_db, new_db| {
288+ // Ensure existing data got updated with defaults
324− // Ensure email was backfilled on profiles
289+ let expected = vec!["DEFAULT".to_string(), "DEFAULT".to_string()];
325− let email: String = new_db
290+ assert!(new_db
326− .query(
291+ .query("SELECT name FROM users ORDER BY id", &[],)
327− "
328− SELECT email
329− FROM profiles
330− WHERE user_id = 1
331− ",
332− &[],
333− )
334− .unwrap()
292+ .unwrap()
335− .first()
293+ .iter()
336− .map(|row| row.get("email"))
294+ .map(|row| row.get::<_, String>("name"))
337− .unwrap();
295+ .eq(expected));
338− assert_eq!("test@example.com", email);
296+
339−
297+ // Insert data using old schema and ensure new column gets the default value
340− // Ensure email change in old schema is propagated to profiles table in new schema
341− old_db
298+ old_db
342− .simple_query("UPDATE users SET email = 'test2@example.com' WHERE id = 1")
299+ .simple_query("INSERT INTO users (id) VALUES (3)")
343− .unwrap();
300+ .unwrap();
344− let email: String = new_db
301+ let name: String = new_db
345− .query(
302+ .query_one("SELECT name from users WHERE id = 3", &[])
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"))
303+ .map(|row| row.get("name"))
356− .unwrap();
304+ .unwrap();
357− assert_eq!("test2@example.com", email);
305+ assert_eq!("DEFAULT", name);
358− });
359
306
360− test.run();
307+ reshape.complete_migration().unwrap();
308+ common::assert_cleaned_up(&mut new_db);
361}
309}
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+61−215
@@ -1,223 +1,69 @@
1+use reshape::migrations::{AddIndex, ColumnBuilder, CreateTableBuilder, Migration};
2+
1mod common;
3mod common;
2−use common::Test;
3
4
4#[test]
5#[test]
5fn add_index() {
6fn add_index() {
6− let mut test = Test::new("Add index");
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
7−
8+
8− test.first_migration(
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
9− r#"
10+ CreateTableBuilder::default()
10− name = "create_users_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
11+ .name("users")
15− primary_key = ["id"]
12+ .primary_key(vec!["id".to_string()])
16−
17− [[actions.columns]]
13+ .columns(vec![
14+ ColumnBuilder::default()
18− name = "id"
15+ .name("id")
19− type = "INTEGER"
16+ .data_type("INTEGER")
20−
17+ .build()
21− [[actions.columns]]
18+ .unwrap(),
19+ ColumnBuilder::default()
22− name = "name"
20+ .name("name")
23− type = "TEXT"
21+ .data_type("TEXT")
24− "#,
22+ .build()
25− );
23+ .unwrap(),
26−
24+ ])
27− test.second_migration(
25+ .build()
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()
26+ .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");
60− });
61−
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();
84−}
85−
86−#[test]
87−fn 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− "#,
122 );
27 );
123−
28+ let add_index_migration = Migration::new("add_name_index", None).with_action(AddIndex {
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− &[],
135− )
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− });
151−
152− test.run();
153−}
154−
155−#[test]
156−fn 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"
29+ table: "users".to_string(),
185−
30+ name: "name_idx".to_string(),
186− [actions.index]
31+ columns: vec!["name".to_string()],
187− name = "data_idx"
188− columns = ["data"]
189− type = "gin"
190− "#,
191− );
192−
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− &[],
205− )
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 });
32 });
221
33
222− test.run();
34+ let first_migrations = vec![create_table_migration.clone()];
35+ let second_migrations = vec![create_table_migration.clone(), add_index_migration.clone()];
36+
37+ // Run migrations
38+ reshape.migrate(first_migrations.clone()).unwrap();
39+ reshape.migrate(second_migrations.clone()).unwrap();
40+
41+ // Update schemas of Postgres connections
42+ let old_schema_query =
43+ reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
44+ let new_schema_query =
45+ reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
46+ old_db.simple_query(&old_schema_query).unwrap();
47+ new_db.simple_query(&new_schema_query).unwrap();
48+
49+ // Ensure index is valid and ready
50+ let result: Vec<(bool, bool)> = new_db
51+ .query(
52+ "
53+ SELECT pg_index.indisready, pg_index.indisvalid
54+ FROM pg_catalog.pg_index
55+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
56+ WHERE pg_class.relname = 'name_idx'
57+ ",
58+ &[],
59+ )
60+ .unwrap()
61+ .iter()
62+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
63+ .collect();
64+
65+ assert_eq!(vec![(true, true)], result);
66+
67+ reshape.complete_migration().unwrap();
68+ common::assert_cleaned_up(&mut new_db);
223}
69}
tests/alter_column.rs+445−646
@@ -1,45 +1,67 @@
1+use reshape::migrations::{
2+ AlterColumn, ColumnBuilder, ColumnChanges, CreateTableBuilder, Migration,
3+};
4+use reshape::Status;
5+
1mod common;
6mod common;
2−use common::Test;
3
7
4#[test]
8#[test]
5fn alter_column_data() {
9fn alter_column_data() {
6− let mut test = Test::new("Alter column");
10+ let (mut reshape, mut old_db, mut new_db) = common::setup();
7−
11+
8− test.first_migration(
12+ let create_users_table = Migration::new("create_user_table", None).with_action(
9− r#"
13+ CreateTableBuilder::default()
10− name = "create_user_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
14+ .name("users")
15− primary_key = ["id"]
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+ let uppercase_name = Migration::new("uppercase_name", None).with_action(AlterColumn {
32+ table: "users".to_string(),
33+ column: "name".to_string(),
34+ up: Some("UPPER(name)".to_string()),
35+ down: Some("LOWER(name)".to_string()),
36+ changes: ColumnChanges {
37+ data_type: None,
38+ nullable: None,
39+ name: None,
40+ default: None,
41+ },
42+ });
16
43
17− [[actions.columns]]
44+ let first_migrations = vec![create_users_table.clone()];
18− name = "id"
45+ let second_migrations = vec![create_users_table.clone(), uppercase_name.clone()];
19− type = "INTEGER"
20
46
21− [[actions.columns]]
47+ // Run first migration, should automatically finish
22− name = "name"
48+ reshape.migrate(first_migrations.clone()).unwrap();
23− type = "TEXT"
49+ assert!(matches!(reshape.state.status, Status::Idle));
24− "#,
50+ assert_eq!(
51+ Some(&create_users_table.name),
52+ reshape.state.current_migration.as_ref()
25 );
53 );
26
54
27− test.second_migration(
55+ // Update search paths
28− r#"
56+ old_db
29− name = "uppercase_name"
57+ .simple_query(&reshape::schema_query_for_migration(
30−
58+ &first_migrations.last().unwrap().name,
31− [[actions]]
59+ ))
32− type = "alter_column"
60+ .unwrap();
33− table = "users"
34− column = "name"
35− up = "UPPER(name)"
36− down = "LOWER(name)"
37− "#,
38− );
39
61
40− test.after_first(|db| {
41− // Insert some test users
62+ // Insert some test users
63+ old_db
42− db.simple_query(
64+ .simple_query(
43 "
65 "
44 INSERT INTO users (id, name) VALUES
66 INSERT INTO users (id, name) VALUES
45 (1, 'john Doe'),
67 (1, 'john Doe'),
@@ -47,81 +69,103 @@ fn alter_column_data() {
47 ",
69 ",
48 )
70 )
49 .unwrap();
71 .unwrap();
50− });
51
72
52− test.intermediate(|old_db, new_db| {
73+ // Run second migration
74+ reshape.migrate(second_migrations.clone()).unwrap();
75+ new_db
76+ .simple_query(&reshape::schema_query_for_migration(
77+ &second_migrations.last().unwrap().name,
78+ ))
79+ .unwrap();
80+
53− // Check that the existing users has the altered data
81+ // Check that the existing users has the altered data
54− let expected = vec!["JOHN DOE", "JANE DOE"];
82+ let expected = vec!["JOHN DOE", "JANE DOE"];
55− assert!(new_db
83+ assert!(new_db
56− .query("SELECT name FROM users ORDER BY id", &[],)
84+ .query("SELECT name FROM users ORDER BY id", &[],)
57− .unwrap()
85+ .unwrap()
58− .iter()
86+ .iter()
59− .map(|row| row.get::<_, String>("name"))
87+ .map(|row| row.get::<_, String>("name"))
60− .eq(expected));
88+ .eq(expected));
61−
89+
62− // Insert data using old schema and make sure the new schema gets correct values
90+ // Insert data using old schema and make sure the new schema gets correct values
63− old_db
91+ old_db
64− .simple_query("INSERT INTO users (id, name) VALUES (3, 'test testsson')")
92+ .simple_query("INSERT INTO users (id, name) VALUES (3, 'test testsson')")
65− .unwrap();
93+ .unwrap();
66− let result = new_db
94+ let result = new_db
67− .query_one("SELECT name from users WHERE id = 3", &[])
95+ .query_one("SELECT name from users WHERE id = 3", &[])
68− .unwrap();
96+ .unwrap();
69− assert_eq!("TEST TESTSSON", result.get::<_, &str>("name"));
97+ assert_eq!("TEST TESTSSON", result.get::<_, &str>("name"));
70−
98+
71− // Insert data using new schema and make sure the old schema gets correct values
99+ // Insert data using new schema and make sure the old schema gets correct values
72− new_db
100+ new_db
73− .simple_query("INSERT INTO users (id, name) VALUES (4, 'TEST TESTSSON')")
101+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'TEST TESTSSON')")
74− .unwrap();
102+ .unwrap();
75− let result = old_db
103+ let result = old_db
76− .query_one("SELECT name from users WHERE id = 4", &[])
104+ .query_one("SELECT name from users WHERE id = 4", &[])
77− .unwrap();
105+ .unwrap();
78− assert_eq!("test testsson", result.get::<_, &str>("name"));
106+ assert_eq!("test testsson", result.get::<_, &str>("name"));
79− });
80
107
81− test.run();
108+ reshape.complete_migration().unwrap();
109+ common::assert_cleaned_up(&mut new_db);
82}
110}
83
111
84#[test]
112#[test]
85fn alter_column_set_not_null() {
113fn alter_column_set_not_null() {
86− let mut test = Test::new("Set column not null");
114+ let (mut reshape, mut old_db, mut new_db) = common::setup();
87−
115+
88− test.first_migration(
116+ let create_users_table = Migration::new("create_user_table", None).with_action(
89− r#"
117+ CreateTableBuilder::default()
90− name = "create_user_table"
91−
92− [[actions]]
93− type = "create_table"
94− name = "users"
118+ .name("users")
95− primary_key = ["id"]
119+ .primary_key(vec!["id".to_string()])
96−
97− [[actions.columns]]
120+ .columns(vec![
121+ ColumnBuilder::default()
98− name = "id"
122+ .name("id")
99− type = "INTEGER"
123+ .data_type("INTEGER")
100−
124+ .build()
101− [[actions.columns]]
125+ .unwrap(),
126+ ColumnBuilder::default()
102− name = "name"
127+ .name("name")
103− type = "TEXT"
128+ .data_type("TEXT")
104− "#,
129+ .build()
130+ .unwrap(),
131+ ])
132+ .build()
133+ .unwrap(),
105 );
134 );
135+ let set_name_not_null = Migration::new("set_name_not_null", None).with_action(AlterColumn {
136+ table: "users".to_string(),
137+ column: "name".to_string(),
138+ up: Some("COALESCE(name, 'TEST_DEFAULT_VALUE')".to_string()),
139+ down: Some("name".to_string()),
140+ changes: ColumnChanges {
141+ data_type: None,
142+ nullable: Some(false),
143+ name: None,
144+ default: None,
145+ },
146+ });
106
147
107− test.second_migration(
148+ let first_migrations = vec![create_users_table.clone()];
108− r#"
149+ let second_migrations = vec![create_users_table.clone(), set_name_not_null.clone()];
109− name = "set_name_not_null"
110−
111− [[actions]]
112− type = "alter_column"
113− table = "users"
114− column = "name"
115− up = "COALESCE(name, 'TEST_DEFAULT_VALUE')"
116
150
117− [actions.changes]
151+ // Run first migration, should automatically finish
118− nullable = false
152+ reshape.migrate(first_migrations.clone()).unwrap();
119− "#,
153+ assert!(matches!(reshape.state.status, Status::Idle));
154+ assert_eq!(
155+ Some(&create_users_table.name),
156+ reshape.state.current_migration.as_ref()
120 );
157 );
121
158
122− test.after_first(|db| {
159+ // Update search paths
160+ old_db
161+ .simple_query(&reshape::schema_query_for_migration(
162+ &first_migrations.last().unwrap().name,
163+ ))
164+ .unwrap();
165+
123− // Insert some test users
166+ // Insert some test users
167+ old_db
124− db.simple_query(
168+ .simple_query(
125 "
169 "
126 INSERT INTO users (id, name) VALUES
170 INSERT INTO users (id, name) VALUES
127 (1, 'John Doe'),
171 (1, 'John Doe'),
@@ -129,180 +173,104 @@ fn alter_column_set_not_null() {
129 ",
173 ",
130 )
174 )
131 .unwrap();
175 .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
176
167− test.after_completion(|db| {
177+ // Run second migration
168− // Ensure NULL can't be inserted
178+ reshape.migrate(second_migrations.clone()).unwrap();
169− let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
179+ new_db
170− assert!(result.is_err(), "expected insert to fail");
180+ .simple_query(&reshape::schema_query_for_migration(
171− });
181+ &second_migrations.last().unwrap().name,
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− });
178−
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− )
182+ ))
229 .unwrap();
183 .unwrap();
230− });
231
184
232− test.intermediate(|old_db, new_db| {
185+ // Check that existing users got the correct values
186+ let expected = vec!["John Doe", "TEST_DEFAULT_VALUE"];
187+ assert!(new_db
188+ .query("SELECT name FROM users ORDER BY id", &[],)
189+ .unwrap()
190+ .iter()
191+ .map(|row| row.get::<_, String>("name"))
192+ .eq(expected));
193+
233− // Insert data using new schema and make sure the old schema gets correct values
194+ // Insert data using old schema and make sure the new schema gets correct values
234− new_db
195+ old_db
235− .simple_query("INSERT INTO users (id, name) VALUES (2, NULL)")
196+ .simple_query("INSERT INTO users (id, name) VALUES (3, NULL)")
236− .unwrap();
197+ .unwrap();
237− let result = old_db
198+ let result = new_db
238− .query_one("SELECT name from users WHERE id = 2", &[])
199+ .query_one("SELECT name from users WHERE id = 3", &[])
239− .unwrap();
200+ .unwrap();
240− assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
201+ 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− });
250−
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− });
256
202
257− test.after_abort(|db| {
203+ // Insert data using new schema and make sure the old schema gets correct values
258− // Ensure NULL can't be inserted
204+ new_db
259− let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
205+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'Jane Doe')")
260− assert!(result.is_err(), "expected insert to fail");
206+ .unwrap();
261− });
207+ let result = old_db
208+ .query_one("SELECT name from users WHERE id = 4", &[])
209+ .unwrap();
210+ assert_eq!("Jane Doe", result.get::<_, &str>("name"));
262
211
263− test.run();
212+ reshape.complete_migration().unwrap();
213+ common::assert_cleaned_up(&mut new_db);
264}
214}
265
215
266#[test]
216#[test]
267fn alter_column_rename() {
217fn alter_column_rename() {
268− let mut test = Test::new("Rename column");
218+ let (mut reshape, mut old_db, mut new_db) = common::setup();
269−
219+
270− test.first_migration(
220+ let create_users_table = Migration::new("create_user_table", None).with_action(
271− r#"
221+ CreateTableBuilder::default()
272− name = "create_user_table"
273−
274− [[actions]]
275− type = "create_table"
276− name = "users"
222+ .name("users")
277− primary_key = ["id"]
223+ .primary_key(vec!["id".to_string()])
278−
279− [[actions.columns]]
224+ .columns(vec![
225+ ColumnBuilder::default()
280− name = "id"
226+ .name("id")
281− type = "INTEGER"
227+ .data_type("INTEGER")
282−
228+ .build()
283− [[actions.columns]]
229+ .unwrap(),
230+ ColumnBuilder::default()
284− name = "name"
231+ .name("name")
285− type = "TEXT"
232+ .data_type("TEXT")
286− "#,
233+ .build()
234+ .unwrap(),
235+ ])
236+ .build()
237+ .unwrap(),
287 );
238 );
288−
239+ let rename_to_full_name =
289− test.second_migration(
240+ Migration::new("rename_to_full_name", None).with_action(AlterColumn {
290− r#"
291− name = "set_name_not_null"
292−
293− [[actions]]
294− type = "alter_column"
295− table = "users"
241+ table: "users".to_string(),
296− column = "name"
242+ column: "name".to_string(),
297−
243+ up: None, // up and down are not required when only renaming a column
244+ down: None,
298− [actions.changes]
245+ changes: ColumnChanges {
246+ data_type: None,
247+ nullable: None,
299− name = "full_name"
248+ name: Some("full_name".to_string()),
300− "#,
249+ default: None,
250+ },
251+ });
252+
253+ let first_migrations = vec![create_users_table.clone()];
254+ let second_migrations = vec![create_users_table.clone(), rename_to_full_name.clone()];
255+
256+ // Run first migration, should automatically finish
257+ reshape.migrate(first_migrations.clone()).unwrap();
258+ assert!(matches!(reshape.state.status, Status::Idle));
259+ assert_eq!(
260+ Some(&create_users_table.name),
261+ reshape.state.current_migration.as_ref()
301 );
262 );
302
263
303− test.after_first(|db| {
264+ // Update search paths
265+ old_db
266+ .simple_query(&reshape::schema_query_for_migration(
267+ &first_migrations.last().unwrap().name,
268+ ))
269+ .unwrap();
270+
304− // Insert some test data
271+ // Insert some test data
272+ old_db
305− db.simple_query(
273+ .simple_query(
306 "
274 "
307 INSERT INTO users (id, name) VALUES
275 INSERT INTO users (id, name) VALUES
308 (1, 'John Doe'),
276 (1, 'John Doe'),
@@ -310,69 +278,99 @@ fn alter_column_rename() {
310 ",
278 ",
311 )
279 )
312 .unwrap();
280 .unwrap();
313− });
314
281
315− test.intermediate(|_, new_db| {
282+ // Run second migration
316− // Check that existing values can be queried using new column name
283+ reshape.migrate(second_migrations.clone()).unwrap();
317− let expected = vec!["John Doe", "Jane Doe"];
284+ new_db
318− assert!(new_db
285+ .simple_query(&reshape::schema_query_for_migration(
319− .query("SELECT full_name FROM users ORDER BY id", &[],)
286+ &second_migrations.last().unwrap().name,
287+ ))
320− .unwrap()
288+ .unwrap();
321− .iter()
322− .map(|row| row.get::<_, String>("full_name"))
323− .eq(expected));
324− });
325
289
326− test.run();
290+ // Check that existing values can be queried using new column name
291+ let expected = vec!["John Doe", "Jane Doe"];
292+ assert!(new_db
293+ .query("SELECT full_name FROM users ORDER BY id", &[],)
294+ .unwrap()
295+ .iter()
296+ .map(|row| row.get::<_, String>("full_name"))
297+ .eq(expected));
298+
299+ reshape.complete_migration().unwrap();
300+ common::assert_cleaned_up(&mut new_db);
327}
301}
328
302
329#[test]
303#[test]
330fn alter_column_multiple() {
304fn alter_column_multiple() {
331− let mut test = Test::new("Alter column value multiple times");
305+ let (mut reshape, mut old_db, mut new_db) = common::setup();
332−
306+
333− test.first_migration(
307+ let create_users_table = Migration::new("create_user_table", None).with_action(
334− r#"
308+ CreateTableBuilder::default()
335− name = "create_user_table"
336−
337− [[actions]]
338− type = "create_table"
339− name = "users"
309+ .name("users")
340− primary_key = ["id"]
310+ .primary_key(vec!["id".to_string()])
341−
342− [[actions.columns]]
311+ .columns(vec![
312+ ColumnBuilder::default()
343− name = "id"
313+ .name("id")
344− type = "INTEGER"
314+ .data_type("INTEGER")
345−
315+ .build()
346− [[actions.columns]]
316+ .unwrap(),
317+ ColumnBuilder::default()
347− name = "counter"
318+ .name("counter")
348− type = "INTEGER"
319+ .data_type("INTEGER")
349− nullable = false
320+ .nullable(false)
350− "#,
321+ .build()
322+ .unwrap(),
323+ ])
324+ .build()
325+ .unwrap(),
351 );
326 );
352−
353− test.second_migration(
354− r#"
355− name = "increment_counter_twice"
327+ let increment_counter_twice = Migration::new("increment_counter_twice", None)
356−
328+ .with_action(AlterColumn {
357− [[actions]]
358− type = "alter_column"
359− table = "users"
329+ table: "users".to_string(),
360− column = "counter"
330+ column: "counter".to_string(),
361− up = "counter + 1"
331+ up: Some("counter + 1".to_string()),
362− down = "counter - 1"
332+ down: Some("counter - 1".to_string()),
363−
333+ changes: ColumnChanges {
364− [[actions]]
334+ data_type: None,
365− type = "alter_column"
335+ nullable: None,
336+ name: None,
337+ default: None,
338+ },
339+ })
340+ .with_action(AlterColumn {
366− table = "users"
341+ table: "users".to_string(),
367− column = "counter"
342+ column: "counter".to_string(),
368− up = "counter + 1"
343+ up: Some("counter + 1".to_string()),
369− down = "counter - 1"
344+ down: Some("counter - 1".to_string()),
370− "#,
345+ changes: ColumnChanges {
346+ data_type: None,
347+ nullable: None,
348+ name: None,
349+ default: None,
350+ },
351+ });
352+
353+ let first_migrations = vec![create_users_table.clone()];
354+ let second_migrations = vec![create_users_table.clone(), increment_counter_twice.clone()];
355+
356+ // Run first migration, should automatically finish
357+ reshape.migrate(first_migrations.clone()).unwrap();
358+ assert!(matches!(reshape.state.status, Status::Idle));
359+ assert_eq!(
360+ Some(&create_users_table.name),
361+ reshape.state.current_migration.as_ref()
371 );
362 );
372
363
373− test.after_first(|db| {
364+ // Update search paths
365+ old_db
366+ .simple_query(&reshape::schema_query_for_migration(
367+ &first_migrations.last().unwrap().name,
368+ ))
369+ .unwrap();
370+
374− // Insert some test data
371+ // Insert some test data
372+ old_db
375− db.simple_query(
373+ .simple_query(
376 "
374 "
377 INSERT INTO users (id, counter) VALUES
375 INSERT INTO users (id, counter) VALUES
378 (1, 0),
376 (1, 0),
@@ -380,355 +378,156 @@ fn alter_column_multiple() {
380 ",
378 ",
381 )
379 )
382 .unwrap();
380 .unwrap();
383− });
384
381
385− test.intermediate(|old_db, new_db| {
382+ // Run second migration
383+ reshape.migrate(second_migrations.clone()).unwrap();
384+ new_db
385+ .simple_query(&reshape::schema_query_for_migration(
386+ &second_migrations.last().unwrap().name,
387+ ))
388+ .unwrap();
389+
386− // Check that the existing data has been updated
390+ // Check that the existing data has been updated
387− let expected = vec![2, 102];
391+ let expected = vec![2, 102];
388− let results: Vec<i32> = new_db
392+ let results: Vec<i32> = new_db
389− .query("SELECT counter FROM users ORDER BY id", &[])
393+ .query("SELECT counter FROM users ORDER BY id", &[])
390− .unwrap()
394+ .unwrap()
391− .iter()
395+ .iter()
392− .map(|row| row.get::<_, i32>("counter"))
396+ .map(|row| row.get::<_, i32>("counter"))
393− .collect();
397+ .collect();
394− assert_eq!(expected, results);
398+ assert_eq!(expected, results);
395−
399+
396− // Update data using old schema and make sure it was updated for the new schema
400+ // Update data using old schema and make sure it was updated for the new schema
397− old_db
401+ old_db
398− .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
402+ .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
399− .unwrap();
403+ .unwrap();
400− let result: i32 = new_db
404+ let result: i32 = new_db
401− .query("SELECT counter FROM users WHERE id = 1", &[])
405+ .query("SELECT counter FROM users WHERE id = 1", &[])
402− .unwrap()
406+ .unwrap()
403− .iter()
407+ .iter()
404− .map(|row| row.get("counter"))
408+ .map(|row| row.get("counter"))
405− .nth(0)
409+ .nth(0)
406− .unwrap();
410+ .unwrap();
407− assert_eq!(52, result);
411+ 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− });
422
412
423− test.run();
413+ // Update data using new schema and make sure it was updated for the old schema
414+ new_db
415+ .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
416+ .unwrap();
417+ let result: i32 = old_db
418+ .query("SELECT counter FROM users WHERE id = 1", &[])
419+ .unwrap()
420+ .iter()
421+ .map(|row| row.get("counter"))
422+ .nth(0)
423+ .unwrap();
424+ assert_eq!(48, result);
425+
426+ reshape.complete_migration().unwrap();
427+ common::assert_cleaned_up(&mut new_db);
424}
428}
425
429
426#[test]
430#[test]
427fn alter_column_default() {
431fn alter_column_default() {
428− let mut test = Test::new("Change default value for column");
432+ let (mut reshape, mut old_db, mut new_db) = common::setup();
429−
433+
430− test.first_migration(
434+ let create_users_table = Migration::new("create_user_table", None).with_action(
431− r#"
435+ CreateTableBuilder::default()
432− name = "create_user_table"
433−
434− [[actions]]
435− type = "create_table"
436− name = "users"
436+ .name("users")
437− primary_key = ["id"]
437+ .primary_key(vec!["id".to_string()])
438−
439− [[actions.columns]]
438+ .columns(vec![
439+ ColumnBuilder::default()
440− name = "id"
440+ .name("id")
441− type = "INTEGER"
441+ .data_type("INTEGER")
442−
442+ .build()
443− [[actions.columns]]
443+ .unwrap(),
444+ ColumnBuilder::default()
444− name = "name"
445+ .name("name")
445− type = "TEXT"
446+ .data_type("TEXT")
446− nullable = false
447+ .nullable(false)
447− default = "'DEFAULT'"
448+ .default_value("'DEFAULT'")
448− "#,
449+ .build()
450+ .unwrap(),
451+ ])
452+ .build()
453+ .unwrap(),
449 );
454 );
450−
455+ let change_name_default =
451− test.second_migration(
452− r#"
453− name = "change_name_default"
456+ Migration::new("change_name_default", None).with_action(AlterColumn {
454−
455− [[actions]]
456− type = "alter_column"
457− table = "users"
457+ table: "users".to_string(),
458− column = "name"
458+ column: "name".to_string(),
459−
459+ up: None,
460+ down: None,
460− [actions.changes]
461+ changes: ColumnChanges {
462+ data_type: None,
463+ nullable: None,
464+ name: None,
461− default = "'NEW DEFAULT'"
465+ default: Some("'NEW DEFAULT'".to_string()),
462− "#,
466+ },
467+ });
468+
469+ let first_migrations = vec![create_users_table.clone()];
470+ let second_migrations = vec![create_users_table.clone(), change_name_default.clone()];
471+
472+ // Run first migration, should automatically finish
473+ reshape.migrate(first_migrations.clone()).unwrap();
474+ assert!(matches!(reshape.state.status, Status::Idle));
475+ assert_eq!(
476+ Some(&create_users_table.name),
477+ reshape.state.current_migration.as_ref()
463 );
478 );
464
479
465− test.after_first(|db| {
480+ // Update search paths
481+ old_db
482+ .simple_query(&reshape::schema_query_for_migration(
483+ &first_migrations.last().unwrap().name,
484+ ))
485+ .unwrap();
486+
466− // Insert a test user
487+ // Insert a test user
488+ old_db
467− db.simple_query(
489+ .simple_query(
468 "
490 "
469 INSERT INTO users (id) VALUES (1)
491 INSERT INTO users (id) VALUES (1)
470 ",
492 ",
471 )
493 )
472 .unwrap();
494 .unwrap();
473− });
474−
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− });
503
495
504− test.run();
496+ // Run second migration
505−}
497+ reshape.migrate(second_migrations.clone()).unwrap();
506−
498+ new_db
507−#[test]
499+ .simple_query(&reshape::schema_query_for_migration(
508−fn alter_column_with_index() {
500+ &second_migrations.last().unwrap().name,
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"
527−
528− [[actions.columns]]
529− name = "last_name"
530− type = "TEXT"
531−
532− [[actions]]
533− type = "add_index"
534− table = "users"
535−
536− [actions.index]
537− name = "users_name_idx"
538− columns = ["first_name", "last_name"]
539− "#,
540− );
541−
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− );
554−
555− test.after_completion(|db| {
556− // Make sure index still exists
557− let result: i64 = db
558− .query(
559− "
560− SELECT COUNT(*)
561− FROM pg_catalog.pg_index
562− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
563− WHERE pg_class.relname = 'users_name_idx'
564− ",
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− );
501+ ))
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()
502+ .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
503
700− test.second_migration(
504+ // Check that the existing users has the old default value
701− r#"
505+ let expected = vec!["DEFAULT"];
702− name = "uppercase_name"
506+ assert!(new_db
703−
507+ .query("SELECT name FROM users", &[],)
704− [[actions]]
508+ .unwrap()
705− type = "alter_column"
509+ .iter()
706− table = "users"
510+ .map(|row| row.get::<_, String>("name"))
707− column = "name"
511+ .eq(expected));
708− up = "UPPER(name)"
512+
709− down = "LOWER(name)"
513+ // Insert data using old schema and make those get the old default value
710− "#,
514+ old_db
711− );
515+ .simple_query("INSERT INTO users (id) VALUES (2)")
516+ .unwrap();
517+ let result = new_db
518+ .query_one("SELECT name from users WHERE id = 2", &[])
519+ .unwrap();
520+ assert_eq!("DEFAULT", result.get::<_, &str>("name"));
712
521
713− test.after_completion(|db| {
522+ // Insert data using new schema and make sure it gets the new default value
714− // Make sure index still has type GIN
523+ new_db
715− let index_type: String = db
524+ .simple_query("INSERT INTO users (id) VALUES (3)")
716− .query(
525+ .unwrap();
717− "
526+ let result = old_db
718− SELECT pg_am.amname
527+ .query_one("SELECT name from users WHERE id = 3", &[])
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();
528+ .unwrap();
730− assert_eq!("hash", index_type);
529+ assert_eq!("NEW DEFAULT", result.get::<_, &str>("name"));
731− });
732
530
733− test.run();
531+ reshape.complete_migration().unwrap();
532+ common::assert_cleaned_up(&mut new_db);
734}
533}
tests/common.rs+9−236
@@ -1,244 +1,17 @@
1−use colored::Colorize;
2use postgres::{Client, NoTls};
1use postgres::{Client, NoTls};
3−use reshape::{migrations::Migration, Reshape};
2+use reshape::Reshape;
4
3
5−pub struct Test<'a> {
4+pub fn setup() -> (Reshape, Client, Client) {
6− name: &'a str,
5+ let connection_string = std::env::var("POSTGRES_CONNECTION_STRING")
7− reshape: Reshape,
6+ .unwrap_or("postgres://postgres:postgres@localhost/reshape_test".to_string());
8− old_db: Client,
9− new_db: Client,
10
7
11− first_migration: Option<Migration>,
8+ let old_db = Client::connect(&connection_string, NoTls).unwrap();
12− second_migration: Option<Migration>,
9+ let new_db = Client::connect(&connection_string, NoTls).unwrap();
13− expect_failure: bool,
14
10
15− clear_fn: Option<fn(&mut Client) -> ()>,
16− after_first_fn: Option<fn(&mut Client) -> ()>,
17− intermediate_fn: Option<fn(&mut Client, &mut Client) -> ()>,
18− after_completion_fn: Option<fn(&mut Client) -> ()>,
19− after_abort_fn: Option<fn(&mut Client) -> ()>,
20−}
21−
22−impl Test<'_> {
23− pub fn new<'a>(name: &'a str) -> Test<'a> {
24− let connection_string = std::env::var("POSTGRES_CONNECTION_STRING")
25− .unwrap_or("postgres://postgres:postgres@localhost/reshape_test".to_string());
26−
27− let old_db = Client::connect(&connection_string, NoTls).unwrap();
28− let new_db = Client::connect(&connection_string, NoTls).unwrap();
29−
30− let reshape = Reshape::new(&connection_string).unwrap();
11+ let mut reshape = Reshape::new(&connection_string).unwrap();
31−
32− Test {
33− name,
34− reshape,
35− old_db,
36− new_db,
37− first_migration: None,
38− second_migration: None,
39− expect_failure: false,
40− clear_fn: None,
41− after_first_fn: None,
42− intermediate_fn: None,
43− after_completion_fn: None,
44− after_abort_fn: None,
45− }
46− }
47−
48− pub fn first_migration(&mut self, migration: &str) -> &mut Self {
49− self.first_migration = Some(Self::parse_migration(migration));
50− self
51− }
52−
53− #[allow(dead_code)]
54− pub fn second_migration(&mut self, migration: &str) -> &mut Self {
55− self.second_migration = Some(Self::parse_migration(migration));
56− self
57− }
58−
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)]
66− pub fn after_first(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
67− self.after_first_fn = Some(f);
68− self
69− }
70−
71− #[allow(dead_code)]
72− pub fn intermediate(&mut self, f: fn(&mut Client, &mut Client) -> ()) -> &mut Self {
73− self.intermediate_fn = Some(f);
74− self
75− }
76−
77− #[allow(dead_code)]
78− pub fn after_completion(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
79− self.after_completion_fn = Some(f);
80− self
81− }
82−
83− #[allow(dead_code)]
84− pub fn after_abort(&mut self, f: fn(&mut Client) -> ()) -> &mut Self {
85− self.after_abort_fn = Some(f);
86− self
87− }
88−
89− #[allow(dead_code)]
90− pub fn expect_failure(&mut self) {
91− self.expect_failure = true;
92− }
93−
94− fn parse_migration(encoded: &str) -> Migration {
95− toml::from_str(encoded).unwrap()
96− }
97−}
98−
99−enum RunType {
100− Simple,
101− Completion,
102− Abort,
103−}
104−
105−impl Test<'_> {
106− #[allow(dead_code)]
107− pub fn run(&mut self) {
108− if self.second_migration.is_some() {
109− // Run to completion
110− print_heading(&format!("Test completion: {}", self.name));
111− self.run_internal(RunType::Completion);
112−
113− // Run and abort
114− print_heading(&format!("Test abort: {}", self.name));
115− self.run_internal(RunType::Abort);
116− } else {
117− print_heading(&format!("Test: {}", self.name));
118− self.run_internal(RunType::Simple);
119− }
120− }
121−
122− fn run_internal(&mut self, run_type: RunType) {
123− print_subheading("Clearing database");
124− self.reshape.remove().unwrap();
12+ reshape.remove().unwrap();
125−
126− if let Some(clear_fn) = self.clear_fn {
127− clear_fn(&mut self.old_db);
128− }
129−
130− // Apply first migration, will automatically complete
131− print_subheading("Applying first migration");
132− let first_migration = self
133− .first_migration
134− .as_ref()
135− .expect("no starting migration set");
136− self.reshape.migrate(vec![first_migration.clone()]).unwrap();
137−
138− // Update search path
139− self.old_db
140− .simple_query(&reshape::schema_query_for_migration(&first_migration.name))
141− .unwrap();
142−
143− // Automatically complete first migration
144− self.reshape.complete().unwrap();
145−
146− // Run setup function
147− if let Some(after_first_fn) = self.after_first_fn {
148− print_subheading("Running setup and first checks");
149− after_first_fn(&mut self.old_db);
150− print_success();
151− }
152−
153− // Apply second migration
154− 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− }
170−
171− // Update search path
172− self.new_db
173− .simple_query(&reshape::schema_query_for_migration(&second_migration.name))
174− .unwrap();
175−
176− if let Some(intermediate_fn) = self.intermediate_fn {
177− print_subheading("Running intermediate checks");
178− intermediate_fn(&mut self.old_db, &mut self.new_db);
179− print_success();
180− }
181−
182− match run_type {
183− RunType::Completion => {
184− print_subheading("Completing");
185− self.reshape.complete().unwrap();
186−
187− if let Some(after_completion_fn) = self.after_completion_fn {
188− print_subheading("Running post-completion checks");
189− after_completion_fn(&mut self.new_db);
190− print_success();
191− }
192− }
193− RunType::Abort => {
194− print_subheading("Aborting");
195− self.reshape.abort().unwrap();
196−
197− if let Some(after_abort_fn) = self.after_abort_fn {
198− print_subheading("Running post-abort checks");
199− after_abort_fn(&mut self.old_db);
200− print_success();
201− }
202− }
203− _ => {}
204− }
205− }
206−
207− print_subheading("Checking cleanup");
208− assert_cleaned_up(&mut self.new_db);
209− print_success();
210− }
211−}
212−
213−fn print_heading(text: &str) {
214− let delimiter = std::iter::repeat("=").take(80).collect::<String>();
215−
216− println!();
217− println!();
218− println!("{}", delimiter.blue().bold());
219− println!("{}", add_spacer(text, "=").blue().bold());
220− println!("{}", delimiter.blue().bold());
221−}
222−
223−fn print_subheading(text: &str) {
224− println!();
225− println!("{}", add_spacer(text, "=").blue());
226−}
227−
228−fn print_success() {
229− println!("{}", add_spacer("Success", "=").green());
230−}
231−
232−fn add_spacer(text: &str, char: &str) -> String {
233− const TARGET_WIDTH: usize = 80;
234− let num_of_chars = (TARGET_WIDTH - text.len() - 2) / 2;
235− let spacer = std::iter::repeat(char)
236− .take(num_of_chars)
237− .collect::<String>();
238−
239− let extra = if text.len() % 2 == 0 { "" } else { char };
240
13
241− format!("{spacer} {text} {spacer}{extra}", spacer = spacer)
14+ (reshape, old_db, new_db)
242}
15}
243
16
244pub fn assert_cleaned_up(db: &mut Client) {
17pub fn assert_cleaned_up(db: &mut Client) {
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+196−184
@@ -1,200 +1,212 @@
1+use reshape::{
2+ migrations::{ColumnBuilder, CreateTableBuilder, ForeignKey, Migration},
3+ Status,
4+};
5+
1mod common;
6mod common;
2−use common::Test;
3
7
4#[test]
8#[test]
5fn create_table() {
9fn create_table() {
6− let mut test = Test::new("Create table");
10+ let (mut reshape, mut db, _) = common::setup();
7−
11+
8− test.first_migration(
12+ let create_table_migration = Migration::new("create_users_table", None).with_action(
9− r#"
13+ CreateTableBuilder::default()
10− name = "create_users_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
14+ .name("users")
15− primary_key = ["id"]
15+ .primary_key(vec!["id".to_string()])
16−
17− [[actions.columns]]
16+ .columns(vec![
17+ ColumnBuilder::default()
18− name = "id"
18+ .name("id")
19− type = "INTEGER"
19+ .data_type("INTEGER")
20− generated = "ALWAYS AS IDENTITY"
20+ .generated("ALWAYS AS IDENTITY")
21−
21+ .build()
22− [[actions.columns]]
22+ .unwrap(),
23+ ColumnBuilder::default()
23− name = "name"
24+ .name("name")
24− type = "TEXT"
25+ .data_type("TEXT")
25−
26+ .build()
26− [[actions.columns]]
27+ .unwrap(),
28+ ColumnBuilder::default()
27− name = "created_at"
29+ .name("created_at")
28− type = "TIMESTAMP"
30+ .data_type("TIMESTAMP")
29− nullable = false
31+ .nullable(false)
30− default = "NOW()"
32+ .default_value("NOW()")
31− "#,
33+ .build()
34+ .unwrap(),
35+ ])
36+ .build()
37+ .unwrap(),
32 );
38 );
33
39
34− test.after_first(|db| {
40+ reshape
35− // Ensure table was created
41+ .migrate(vec![create_table_migration.clone()])
36− let result = db
42+ .unwrap();
37− .query_opt(
43+ assert!(matches!(reshape.state.status, Status::Idle));
38− "
44+ assert_eq!(
39− SELECT table_name
45+ Some(&create_table_migration.name),
40− FROM information_schema.tables
46+ reshape.state.current_migration.as_ref()
41− WHERE table_name = 'users' AND table_schema = 'public'",
47+ );
42− &[],
43− )
44− .unwrap();
45− assert!(result.is_some());
46−
47− // Ensure table has the right columns
48− let result = db
49− .query(
50− "
51− SELECT column_name, column_default, is_nullable, data_type
52− FROM information_schema.columns
53− WHERE table_name = 'users' AND table_schema = 'public'
54− ORDER BY ordinal_position",
55− &[],
56− )
57− .unwrap();
58−
59− // id column
60− let id_row = &result[0];
61− assert_eq!("id", id_row.get::<_, String>("column_name"));
62− assert!(id_row.get::<_, Option<String>>("column_default").is_none());
63− assert_eq!("NO", id_row.get::<_, String>("is_nullable"));
64− assert_eq!("integer", id_row.get::<_, String>("data_type"));
65−
66− // name column
67− let name_row = &result[1];
68− assert_eq!("name", name_row.get::<_, String>("column_name"));
69− assert!(name_row
70− .get::<_, Option<String>>("column_default")
71− .is_none());
72− assert_eq!("YES", name_row.get::<_, String>("is_nullable"));
73− assert_eq!("text", name_row.get::<_, String>("data_type"));
74−
75− // created_at column
76− let created_at_column = &result[2];
77− assert_eq!(
78− "created_at",
79− created_at_column.get::<_, String>("column_name")
80− );
81− assert!(created_at_column
82− .get::<_, Option<String>>("column_default")
83− .is_some());
84− assert_eq!("NO", created_at_column.get::<_, String>("is_nullable"));
85− assert_eq!(
86− "timestamp without time zone",
87− created_at_column.get::<_, String>("data_type")
88− );
89−
90− // Ensure the primary key has the right columns
91− let primary_key_columns: Vec<String> = db
92− .query(
93− "
94− SELECT a.attname AS column
95− FROM pg_index i
96− JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = ANY(i.indkey)
97− JOIN pg_class t ON t.oid = i.indrelid
98− WHERE t.relname = 'users' AND i.indisprimary
99− ",
100− &[],
101− )
102− .unwrap()
103− .iter()
104− .map(|row| row.get("column"))
105− .collect();
106
48
107− assert_eq!(vec!["id"], primary_key_columns);
49+ // Ensure table was created
50+ let result = db
51+ .query_opt(
52+ "
53+ SELECT table_name
54+ FROM information_schema.tables
55+ WHERE table_name = 'users' AND table_schema = 'public'",
56+ &[],
57+ )
58+ .unwrap();
59+ assert!(result.is_some());
60+
61+ // Ensure table has the right columns
62+ let result = db
63+ .query(
64+ "
65+ SELECT column_name, column_default, is_nullable, data_type
66+ FROM information_schema.columns
67+ WHERE table_name = 'users' AND table_schema = 'public'
68+ ORDER BY ordinal_position",
69+ &[],
70+ )
71+ .unwrap();
72+
73+ // id column
74+ let id_row = &result[0];
75+ assert_eq!("id", id_row.get::<_, String>("column_name"));
76+ assert!(id_row.get::<_, Option<String>>("column_default").is_none());
77+ assert_eq!("NO", id_row.get::<_, String>("is_nullable"));
78+ assert_eq!("integer", id_row.get::<_, String>("data_type"));
79+
80+ // name column
81+ let name_row = &result[1];
82+ assert_eq!("name", name_row.get::<_, String>("column_name"));
83+ assert!(name_row
84+ .get::<_, Option<String>>("column_default")
85+ .is_none());
86+ assert_eq!("YES", name_row.get::<_, String>("is_nullable"));
87+ assert_eq!("text", name_row.get::<_, String>("data_type"));
88+
89+ // created_at column
90+ let created_at_column = &result[2];
91+ assert_eq!(
92+ "created_at",
93+ created_at_column.get::<_, String>("column_name")
94+ );
95+ assert!(created_at_column
96+ .get::<_, Option<String>>("column_default")
97+ .is_some());
98+ assert_eq!("NO", created_at_column.get::<_, String>("is_nullable"));
99+ assert_eq!(
100+ "timestamp without time zone",
101+ created_at_column.get::<_, String>("data_type")
108− });
102+ );
109
103
110− test.run();
104+ // Ensure the primary key has the right columns
105+ let primary_key_columns: Vec<String> = db
106+ .query(
107+ "
108+ SELECT a.attname AS column
109+ FROM pg_index i
110+ JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = ANY(i.indkey)
111+ WHERE i.indrelid = 'users'::regclass AND i.indisprimary
112+ ",
113+ &[],
114+ )
115+ .unwrap()
116+ .iter()
117+ .map(|row| row.get("column"))
118+ .collect();
119+
120+ assert_eq!(vec!["id"], primary_key_columns);
121+ common::assert_cleaned_up(&mut db);
111}
122}
112
123
113#[test]
124#[test]
114fn create_table_with_foreign_keys() {
125fn create_table_with_foreign_keys() {
115− let mut test = Test::new("Create table");
126+ let (mut reshape, mut db, _) = common::setup();
116−
127+
117− test.first_migration(
128+ let create_table_migration = Migration::new("create_users_table", None).with_action(
118− r#"
129+ CreateTableBuilder::default()
119− name = "create_users_table"
120−
121− [[actions]]
122− type = "create_table"
123− name = "users"
130+ .name("users")
124− primary_key = ["id"]
131+ .primary_key(vec!["id".to_string()])
125−
132+ .columns(vec![ColumnBuilder::default()
126− [[actions.columns]]
127− name = "id"
133+ .name("id")
128− type = "INTEGER"
134+ .data_type("INTEGER")
129− generated = "ALWAYS AS IDENTITY"
135+ .generated("ALWAYS AS IDENTITY")
130−
136+ .build()
131− [[actions.columns]]
137+ .unwrap()])
132− name = "name"
138+ .build()
133− type = "TEXT"
139+ .unwrap(),
134−
140+ );
135− [[actions.columns]]
141+
136− name = "created_at"
142+ let create_second_table_migration = Migration::new("create_items_table", None).with_action(
137− type = "TIMESTAMP"
138− nullable = false
139− default = "NOW()"
143+ CreateTableBuilder::default()
140−
141− [[actions]]
142− type = "create_table"
143− name = "items"
144+ .name("items")
144− primary_key = ["id"]
145+ .primary_key(vec!["id".to_string()])
145−
146− [[actions.columns]]
147− name = "id"
148− type = "INTEGER"
149−
150− [[actions.columns]]
151− name = "user_id"
152− type = "INTEGER"
153− nullable = false
154−
155− [[actions.foreign_keys]]
146+ .foreign_keys(vec![ForeignKey {
156− columns = ["user_id"]
147+ columns: vec!["user_id".to_string()],
157− referenced_table = "users"
148+ referenced_table: "users".to_string(),
158− referenced_columns = ["id"]
149+ referenced_columns: vec!["id".to_string()],
159− "#,
150+ }])
151+ .columns(vec![
152+ ColumnBuilder::default()
153+ .name("id")
154+ .data_type("INTEGER")
155+ .generated("ALWAYS AS IDENTITY")
156+ .build()
157+ .unwrap(),
158+ ColumnBuilder::default()
159+ .name("user_id")
160+ .data_type("INTEGER")
161+ .nullable(false)
162+ .build()
163+ .unwrap(),
164+ ])
165+ .build()
166+ .unwrap(),
160 );
167 );
161
168
162− test.after_first(|db| {
169+ reshape
170+ .migrate(vec![
171+ create_table_migration.clone(),
172+ create_second_table_migration.clone(),
173+ ])
174+ .unwrap();
175+
163− let foreign_key_columns: Vec<(String, String, String)> = db
176+ let foreign_key_columns: Vec<(String, String, String)> = db
164− .query(
177+ .query(
165− "
178+ "
166− SELECT
179+ SELECT
167− kcu.column_name,
180+ kcu.column_name,
168− ccu.table_name AS foreign_table_name,
181+ ccu.table_name AS foreign_table_name,
169− ccu.column_name AS foreign_column_name
182+ ccu.column_name AS foreign_column_name
170− FROM
183+ FROM
171− information_schema.table_constraints AS tc
184+ information_schema.table_constraints AS tc
172− JOIN information_schema.key_column_usage AS kcu
185+ JOIN information_schema.key_column_usage AS kcu
173− ON tc.constraint_name = kcu.constraint_name
186+ ON tc.constraint_name = kcu.constraint_name
174− AND tc.table_schema = kcu.table_schema
187+ AND tc.table_schema = kcu.table_schema
175− JOIN information_schema.constraint_column_usage AS ccu
188+ JOIN information_schema.constraint_column_usage AS ccu
176− ON ccu.constraint_name = tc.constraint_name
189+ ON ccu.constraint_name = tc.constraint_name
177− AND ccu.table_schema = tc.table_schema
190+ AND ccu.table_schema = tc.table_schema
178− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
191+ WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
179− ",
192+ ",
180− &[],
193+ &[],
194+ )
195+ .unwrap()
196+ .iter()
197+ .map(|row| {
198+ (
199+ row.get("column_name"),
200+ row.get("foreign_table_name"),
201+ row.get("foreign_column_name"),
181 )
202 )
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− })
203+ })
191− .collect();
204+ .collect();
192−
205+
193− assert_eq!(
206+ assert_eq!(
194− vec![("user_id".to_string(), "users".to_string(), "id".to_string())],
207+ vec![("user_id".to_string(), "users".to_string(), "id".to_string())],
195− foreign_key_columns
208+ foreign_key_columns
196− );
197− });
209+ );
198−
210+
199− test.run();
211+ common::assert_cleaned_up(&mut db);
200}
212}
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+66−34
@@ -1,51 +1,83 @@
1+use reshape::migrations::{AddColumn, Column, CreateTable, Migration};
2+use reshape::Status;
3+
1mod common;
4mod common;
2−use common::Test;
3
5
4#[test]
6#[test]
5fn invalid_migration() {
7fn invalid_migration() {
6− let mut test = Test::new("Invalid migration");
8+ let (mut reshape, mut old_db, mut new_db) = common::setup();
7
9
8− test.first_migration(
10+ let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
9− r#"
11+ name: "users".to_string(),
10− name = "invalid_migration"
12+ primary_key: vec!["id".to_string()],
13+ foreign_keys: vec![],
14+ columns: vec![
15+ Column {
16+ name: "id".to_string(),
17+ data_type: "SERIAL".to_string(),
18+ nullable: true,
19+ default: None,
20+ generated: None,
21+ },
22+ Column {
23+ name: "name".to_string(),
24+ data_type: "TEXT".to_string(),
25+ nullable: false,
26+ default: None,
27+ generated: None,
28+ },
29+ ],
30+ });
31+ let add_first_column = Migration::new("add_first_column", None).with_action(AddColumn {
32+ table: "users".to_string(),
33+ column: Column {
34+ name: "first".to_string(),
35+ data_type: "TEXT".to_string(),
36+ nullable: false,
37+ default: None,
38+ generated: None,
39+ },
40+ up: Some("INVALID SQL".to_string()),
41+ });
11
42
12− [[actions]]
43+ let first_migrations = vec![create_users_table.clone()];
13− type = "create_table"
44+ let second_migrations = vec![create_users_table.clone(), add_first_column.clone()];
14− name = "users"
15− primary_key = ["id"]
16
45
17− [[actions.columns]]
46+ // Run first migration, should automatically finish
18− name = "id"
47+ reshape.migrate(first_migrations.clone()).unwrap();
19− type = "INTEGER"
48+ assert!(matches!(reshape.state.status, Status::Idle));
20− "#,
49+ assert_eq!(
50+ Some(&create_users_table.name),
51+ reshape.state.current_migration.as_ref()
21 );
52 );
22
53
23− test.second_migration(
54+ // Update search paths
24− r#"
55+ old_db
25− name = "add_invalid_column"
56+ .simple_query(&reshape::schema_query_for_migration(
26−
57+ &first_migrations.last().unwrap().name,
27− [[actions]]
58+ ))
28− type = "add_column"
59+ .unwrap();
29− table = "users"
60+ new_db
30−
61+ .simple_query(&reshape::schema_query_for_migration(
31− up = "INVALID SQL"
62+ &first_migrations.last().unwrap().name,
32−
63+ ))
33− [actions.column]
64+ .unwrap();
34− name = "first"
35− type = "TEXT"
36− "#,
37− );
38
65
39 // Insert a test user
66 // Insert a test user
40− test.after_first(|db| {
67+ new_db
41− db.simple_query(
68+ .simple_query(
42 "
69 "
43− INSERT INTO users (id) VALUES (1)
70+ INSERT INTO users (id, name) VALUES
71+ (1, 'John Doe')
44 ",
72 ",
45 )
73 )
46 .unwrap();
74 .unwrap();
47− });
48
75
49− test.expect_failure();
76+ // Run second migration and ensure it fails
50− test.run();
77+ assert!(
78+ reshape.migrate(second_migrations.clone()).is_err(),
79+ "invalid migration succeeded"
80+ );
81+
82+ common::assert_cleaned_up(&mut new_db);
51}
83}
tests/remove_column.rs+73−209
@@ -1,217 +1,81 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, Migration, RemoveColumn};
2+
1mod common;
3mod common;
2−use common::Test;
3
4
4#[test]
5#[test]
5fn remove_column() {
6fn remove_column() {
6− let mut test = Test::new("Remove column");
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
7−
8+
8− test.first_migration(
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
9− r#"
10+ CreateTableBuilder::default()
10− name = "create_user_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
11+ .name("users")
15− primary_key = ["id"]
12+ .primary_key(vec!["id".to_string()])
16−
17− [[actions.columns]]
13+ .columns(vec![
14+ ColumnBuilder::default()
18− name = "id"
15+ .name("id")
19− type = "INTEGER"
16+ .data_type("INTEGER")
20−
17+ .build()
21− [[actions.columns]]
18+ .unwrap(),
19+ ColumnBuilder::default()
22− name = "name"
20+ .name("name")
23− type = "TEXT"
21+ .data_type("TEXT")
24− "#,
22+ .nullable(false)
25− );
23+ .build()
26−
24+ .unwrap(),
27− test.second_migration(
25+ ])
28− r#"
26+ .build()
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();
27+ .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− "#,
169 );
28 );
170−
29+ let remove_column_migration =
171− test.second_migration(
30+ Migration::new("remove_name_column", None).with_action(RemoveColumn {
172− r#"
31+ table: "users".to_string(),
173− name = "remove_users_email_column"
32+ column: "name".to_string(),
174−
33+ down: Some("'TEST_DOWN_VALUE'".to_string()),
175− [[actions]]
34+ });
176− type = "remove_column"
35+
177− table = "users"
36+ let first_migrations = vec![create_table_migration.clone()];
178− column = "email"
37+ let second_migrations = vec![
179−
38+ create_table_migration.clone(),
180− [actions.down]
39+ remove_column_migration.clone(),
181− table = "profiles"
40+ ];
182− value = "profiles.email"
41+
183− where = "users.id = profiles.user_id"
42+ // Run migrations
184− "#,
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"))
185 );
77 );
186
78
187− test.after_first(|db| {
79+ reshape.complete_migration().unwrap();
188− db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test@example.com')")
80+ common::assert_cleaned_up(&mut new_db);
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();
217}
81}
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+91−68
@@ -1,86 +1,109 @@
1+use reshape::migrations::{AddIndex, ColumnBuilder, CreateTableBuilder, Migration, RemoveIndex};
2+
1mod common;
3mod common;
2−use common::Test;
3
4
4#[test]
5#[test]
5fn remove_index() {
6fn remove_index() {
6− let mut test = Test::new("Remove index");
7+ let (mut reshape, _, mut db) = common::setup();
7
8
8− test.first_migration(
9+ let create_table_migration = Migration::new("create_user_table", None)
9− r#"
10+ .with_action(
10− name = "create_users_table"
11+ CreateTableBuilder::default()
12+ .name("users")
13+ .primary_key(vec!["id".to_string()])
14+ .columns(vec![
15+ ColumnBuilder::default()
16+ .name("id")
17+ .data_type("INTEGER")
18+ .build()
19+ .unwrap(),
20+ ColumnBuilder::default()
21+ .name("name")
22+ .data_type("TEXT")
23+ .build()
24+ .unwrap(),
25+ ])
26+ .build()
27+ .unwrap(),
28+ )
29+ .with_action(AddIndex {
30+ table: "users".to_string(),
31+ name: "name_idx".to_string(),
32+ columns: vec!["name".to_string()],
33+ });
11
34
12− [[actions]]
35+ let remove_index_migration =
13− type = "create_table"
36+ Migration::new("remove_name_index", None).with_action(RemoveIndex {
14− name = "users"
37+ index: "name_idx".to_string(),
15− primary_key = ["id"]
38+ });
16
39
17− [[actions.columns]]
40+ let first_migrations = vec![create_table_migration.clone()];
18− name = "id"
41+ let second_migrations = vec![
19− type = "INTEGER"
42+ create_table_migration.clone(),
43+ remove_index_migration.clone(),
44+ ];
20
45
21− [[actions.columns]]
46+ // Run migrations
22− name = "name"
47+ reshape.migrate(first_migrations.clone()).unwrap();
23− type = "TEXT"
24
48
25− [[actions]]
49+ // Ensure index is valid and ready
26− type = "add_index"
50+ let result: Vec<(bool, bool)> = db
27− table = "users"
51+ .query(
52+ "
53+ SELECT pg_index.indisready, pg_index.indisvalid
54+ FROM pg_catalog.pg_index
55+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
56+ WHERE pg_class.relname = 'name_idx'
57+ ",
58+ &[],
59+ )
60+ .unwrap()
61+ .iter()
62+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
63+ .collect();
28
64
29− [actions.index]
65+ assert_eq!(vec![(true, true)], result);
30− name = "name_idx"
31− columns = ["name"]
32− "#,
33− );
34
66
35− test.second_migration(
67+ // Run migration to remove index
36− r#"
68+ reshape.migrate(second_migrations.clone()).unwrap();
37− name = "remove_name_index"
38
69
39− [[actions]]
70+ // Ensure index is still valid and ready during the migration
40− type = "remove_index"
71+ let result: Vec<(bool, bool)> = db
41− index = "name_idx"
72+ .query(
42− "#,
73+ "
43− );
74+ SELECT pg_index.indisready, pg_index.indisvalid
75+ FROM pg_catalog.pg_index
76+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
77+ WHERE pg_class.relname = 'name_idx'
78+ ",
79+ &[],
80+ )
81+ .unwrap()
82+ .iter()
83+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
84+ .collect();
44
85
45− test.intermediate(|db, _| {
86+ assert_eq!(vec![(true, true)], result);
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();
61
87
62− assert_eq!(vec![(true, true)], result);
88+ reshape.complete_migration().unwrap();
63− });
64
89
65− test.after_completion(|db| {
66− // Ensure index has been removed after the migration is complete
90+ // Ensure index has been removed after the migration is complete
67− let count: i64 = db
91+ let count: i64 = db
68− .query(
92+ .query(
69− "
93+ "
70− SELECT COUNT(*)
94+ SELECT COUNT(*)
71− FROM pg_catalog.pg_index
95+ FROM pg_catalog.pg_index
72− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
96+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
73− WHERE pg_class.relname = 'name_idx'
97+ WHERE pg_class.relname = 'name_idx'
74− ",
98+ ",
75− &[],
99+ &[],
76− )
100+ )
77− .unwrap()
101+ .unwrap()
78− .first()
102+ .first()
79− .map(|row| row.get(0))
103+ .map(|row| row.get(0))
80− .unwrap();
104+ .unwrap();
81
105
82− assert_eq!(0, count, "expected index to not exist");
106+ assert_eq!(0, count, "expected index to not exist");
83− });
84
107
85− test.run();
108+ common::assert_cleaned_up(&mut db);
86}
109}
tests/remove_table.rs+48−38
@@ -1,44 +1,54 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, Migration, RemoveTable};
2+
1mod common;
3mod common;
2−use common::Test;
3
4
4#[test]
5#[test]
5fn remove_table() {
6fn remove_table() {
6− let mut test = Test::new("Remove table");
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
7−
8+
8− test.first_migration(
9+ let create_table_migration = Migration::new("create_user_table", None).with_action(
9− r#"
10+ CreateTableBuilder::default()
10− name = "create_users_table"
11−
12− [[actions]]
13− type = "create_table"
14− name = "users"
11+ .name("users")
15− primary_key = ["id"]
12+ .primary_key(vec!["id".to_string()])
16−
13+ .columns(vec![ColumnBuilder::default()
17− [[actions.columns]]
18− name = "id"
14+ .name("id")
19− type = "INTEGER"
15+ .data_type("INTEGER")
20− "#,
16+ .build()
21− );
17+ .unwrap()])
22−
18+ .build()
23− test.second_migration(
19+ .unwrap(),
24− r#"
25− name = "remove_users_table"
26−
27− [[actions]]
28− type = "remove_table"
29− table = "users"
30− "#,
31 );
20 );
32−
21+ let remove_table_migration =
33− test.intermediate(|old_db, new_db| {
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+
34− // Make sure inserts work against the old schema
44+ // Make sure inserts work against the old schema
35− old_db
45+ old_db
36− .simple_query("INSERT INTO users(id) VALUES (1)")
46+ .simple_query("INSERT INTO users(id) VALUES (1)")
37− .unwrap();
47+ .unwrap();
38−
48+
39− // Ensure the table is not accessible through the new schema
49+ // Ensure the table is not accessible through the new schema
40− assert!(new_db.query("SELECT id FROM users", &[]).is_err());
50+ assert!(new_db.query("SELECT id FROM users", &[]).is_err());
41− });
51+
42−
52+ reshape.complete_migration().unwrap();
43− test.run();
53+ common::assert_cleaned_up(&mut new_db);
44}
54}
tests/rename_table.rs+66−56
@@ -1,70 +1,80 @@
1+use reshape::migrations::{ColumnBuilder, CreateTableBuilder, Migration, RenameTable};
2+
1mod common;
3mod common;
2−use common::Test;
3
4
4#[test]
5#[test]
5fn rename_table() {
6fn rename_table() {
6− let mut test = Test::new("Rename table");
7+ let (mut reshape, mut old_db, mut new_db) = common::setup();
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
8
17− [[actions.columns]]
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()
18− name = "id"
14+ .name("id")
19− type = "INTEGER"
15+ .data_type("INTEGER")
20− "#,
16+ .build()
17+ .unwrap()])
18+ .build()
19+ .unwrap(),
21 );
20 );
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+ });
22
26
23− test.second_migration(
27+ let first_migrations = vec![create_table_migration.clone()];
24− r#"
28+ let second_migrations = vec![
25− name = "rename_users_table_to_customers"
29+ create_table_migration.clone(),
30+ rename_table_migration.clone(),
31+ ];
26
32
27− [[actions]]
33+ // Run migrations
28− type = "rename_table"
34+ reshape.migrate(first_migrations.clone()).unwrap();
29− table = "users"
35+ reshape.migrate(second_migrations.clone()).unwrap();
30− new_name = "customers"
36+
31− "#,
37+ // Update schemas of Postgres connections
32− );
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();
33
44
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,
36 old_db
57 old_db
37− .simple_query("INSERT INTO users(id) VALUES (1)")
58+ .query("SELECT id FROM users ORDER BY id", &[])
38− .unwrap();
59+ .unwrap()
60+ .iter()
61+ .map(|row| row.get::<_, i32>("id"))
62+ .collect::<Vec<i32>>()
63+ );
64+ assert_eq!(
65+ expected,
39 new_db
66 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", &[])
67+ .query("SELECT id FROM customers 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()
68+ .unwrap()
59− .iter()
69+ .iter()
60− .map(|row| row.get::<_, i32>("id"))
70+ .map(|row| row.get::<_, i32>("id"))
61− .collect::<Vec<i32>>()
71+ .collect::<Vec<i32>>()
62− );
72+ );
63
73
64− // Ensure the table can't be queried using the wrong name for the schema
74+ // 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());
75+ assert!(old_db.simple_query("SELECT id FROM customers").is_err());
66− assert!(new_db.simple_query("SELECT id FROM users").is_err());
76+ assert!(new_db.simple_query("SELECT id FROM users").is_err());
67− });
68
77
69− test.run();
78+ reshape.complete_migration().unwrap();
79+ common::assert_cleaned_up(&mut new_db);
70}
80}