on main help sign in
.github/workflows/lint.yaml+6−3
since splitsnapshots
unifiedsplit
@@ -3,6 +3,9 @@ name: Lint
3on:
3on:
4 push:
4 push:
5 branches: [ main ]
5 branches: [ main ]
6+ pull_request:
7+ branches:
8+ - main
6
9
7env:
10env:
8 CARGO_TERM_COLOR: always
11 CARGO_TERM_COLOR: always
@@ -12,7 +15,7 @@ jobs:
12 runs-on: ubuntu-latest
15 runs-on: ubuntu-latest
13 steps:
16 steps:
14 - name: Checkout
17 - name: Checkout
15− uses: actions/checkout@v2
18+ uses: actions/checkout@v4
16 - name: Select Rust toolchain with Clippy
19 - name: Select Rust toolchain with Clippy
17 uses: actions-rs/toolchain@v1
20 uses: actions-rs/toolchain@v1
18 with:
21 with:
@@ -20,6 +23,6 @@ jobs:
20 components: clippy
23 components: clippy
21 override: true
24 override: true
22 - name: Use cache for Rust dependencies
25 - name: Use cache for Rust dependencies
23− uses: Swatinem/rust-cache@v1
26+ uses: Swatinem/rust-cache@v2
24 - name: Lint using Clippy
27 - name: Lint using Clippy
25− run: cargo clippy
28+ run: cargo clippy
.github/workflows/publish-crate.yamlnew file+20
@@ -0,0 +1,20 @@
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.yamlnew file+25
@@ -0,0 +1,25 @@
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/release.yaml+21−3
@@ -47,6 +47,7 @@ jobs:
47 uses: actions-rs/toolchain@v1
47 uses: actions-rs/toolchain@v1
48 with:
48 with:
49 toolchain: stable
49 toolchain: stable
50+ override: true
50 target: ${{ matrix.target }}
51 target: ${{ matrix.target }}
51 - name: Use cache for Rust dependencies
52 - name: Use cache for Rust dependencies
52 uses: Swatinem/rust-cache@v1
53 uses: Swatinem/rust-cache@v1
@@ -54,10 +55,10 @@ jobs:
54 uses: actions-rs/cargo@v1
55 uses: actions-rs/cargo@v1
55 with:
56 with:
56 command: build
57 command: build
57− args: --release
58+ args: --release --target ${{ matrix.target }}
58 use-cross: ${{ matrix.use-cross }}
59 use-cross: ${{ matrix.use-cross }}
59 - name: Rename binary
60 - name: Rename binary
60− run: mv target/release/reshape ./reshape-${{ matrix.file-name }}
61+ run: mv target/${{ matrix.target }}/release/reshape ./reshape-${{ matrix.file-name }}
61 - name: Upload binary to release
62 - name: Upload binary to release
62 env:
63 env:
63 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
64 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -78,4 +79,21 @@ jobs:
78 # The shell expansion used below will remove everything up to the version number, leaving 0.0.1
79 # The shell expansion used below will remove everything up to the version number, leaving 0.0.1
79 run: docker build . --tag ${{ secrets.DOCKER_USER }}/reshape:${GITHUB_REF##*/v} --tag ${{ secrets.DOCKER_USER }}/reshape:latest
80 run: docker build . --tag ${{ secrets.DOCKER_USER }}/reshape:${GITHUB_REF##*/v} --tag ${{ secrets.DOCKER_USER }}/reshape:latest
80 - name: Push Docker image
81 - name: Push Docker image
81− run: docker push --all-tags ${{ secrets.DOCKER_USER }}/reshape
82+ run: docker push --all-tags ${{ secrets.DOCKER_USER }}/reshape
83+
84+ publish-crate:
85+ runs-on: ubuntu-latest
86+ needs: ["build-binary", "publish-docker"]
87+ steps:
88+ - name: Checkout
89+ uses: actions/checkout@v2
90+ - name: Select Rust toolchain
91+ uses: actions-rs/toolchain@v1
92+ with:
93+ toolchain: stable
94+ - name: Publish to crates.io
95+ uses: actions-rs/cargo@v1
96+ with:
97+ command: publish
98+ env:
99+ CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
.github/workflows/test.yaml+3
@@ -3,6 +3,9 @@ name: Tests
3on:
3on:
4 push:
4 push:
5 branches: [ main ]
5 branches: [ main ]
6+ pull_request:
7+ branches:
8+ - main
6
9
7env:
10env:
8 CARGO_TERM_COLOR: always
11 CARGO_TERM_COLOR: always
Cargo.toml+14−4
@@ -1,16 +1,26 @@
1[package]
1[package]
2name = "reshape"
2name = "reshape"
3−version = "0.1.0"
3+version = "0.7.0"
4+description = "An easy-to-use, zero-downtime schema migration tool for Postgres"
5+homepage = "https://github.com/fabianlindfors/reshape"
6+documentation = "https://github.com/fabianlindfors/reshape"
7+repository = "https://github.com/fabianlindfors/reshape"
8+license = "MIT"
9+keywords = ["postgres", "migrations"]
4edition = "2021"
10edition = "2021"
11+authors = ["Fabian Lindfors"]
12+rust-version = "1.70"
5
13
6[dependencies]
14[dependencies]
7postgres = { version = "0.19.2", features = ["with-serde_json-1"] }
15postgres = { version = "0.19.2", features = ["with-serde_json-1"] }
8serde = { version = "1.0", features = ["derive"] }
16serde = { version = "1.0", features = ["derive"] }
9serde_json = "1.0"
17serde_json = "1.0"
10typetag = "0.1.7"
18typetag = "0.1.7"
11−anyhow = "1.0.44"
19+anyhow = { version = "1.0.44", features = ["backtrace"] }
12−clap = { version = "3.0.0-rc.8", features = ["derive"] }
20+clap = { version = "3.1.9", features = ["derive"] }
13toml = "0.5"
21toml = "0.5"
14version = "3.0.0"
22version = "3.0.0"
15colored = "2"
23colored = "2"
16−bimap = "0.6.1"
24+rand = "0.8"
25+dotenv = "0.15.0"
26+lexical-sort = "0.3.1"
Dockerfile+1−1
@@ -1,4 +1,4 @@
1−FROM rust:1.57.0 AS builder
1+FROM rust:1.70.0 AS builder
2WORKDIR /usr/src/reshape
2WORKDIR /usr/src/reshape
3COPY . .
3COPY . .
4RUN cargo build --release
4RUN cargo build --release
LICENSE.mdnew file+21
@@ -0,0 +1,21 @@
1+MIT License
2+
3+Copyright (c) 2022 Fabian Lindfors
4+
5+Permission is hereby granted, free of charge, to any person obtaining a copy
6+of this software and associated documentation files (the "Software"), to deal
7+in the Software without restriction, including without limitation the rights
8+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+copies of the Software, and to permit persons to whom the Software is
10+furnished to do so, subject to the following conditions:
11+
12+The above copyright notice and this permission notice shall be included in all
13+copies or substantial portions of the Software.
14+
15+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+SOFTWARE.
README.md+436−89
@@ -1,35 +1,57 @@
1# Reshape
1# Reshape
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)
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−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.
5+> Also check out [ReshapeDB](https://reshapedb.com), a new database built from the ground up to make zero-downtime schema and data migrations as simple and safe as possible. If you'd like to chat about it, please [reach out](contact@reshapedb.com)!
6
6
7−*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) destroy your data and break your application.*
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/).
8
8
9+Designed for Postgres 12 and later.
10+
11+- [How it works](#how-it-works)
9- [Getting started](#getting-started)
12- [Getting started](#getting-started)
10− - [Installation](#installation)
13+ - [Installation](#installation)
11− - [Creating your first migration](#creating-your-first-migration)
14+ - [Creating your first migration](#creating-your-first-migration)
12− - [Preparing your application](#preparing-your-application)
15+ - [Preparing your application](#preparing-your-application)
13− - [Running your migration](#running-your-migration)
16+ - [Running your migration](#running-your-migration)
17+ - [Using during development](#using-during-development)
14- [Writing migrations](#writing-migrations)
18- [Writing migrations](#writing-migrations)
15− - [Basics](#basics)
19+ - [Basics](#basics)
16− - [Tables](#tables)
20+ - [Tables](#tables)
17− - [Create table](#create-table)
21+ - [Create table](#create-table)
18− - [Rename table](#rename-table)
22+ - [Rename table](#rename-table)
19− - [Remove table](#remove-table)
23+ - [Remove table](#remove-table)
24+ - [Add foreign key](#add-foreign-key)
25+ - [Remove foreign key](#remove-foreign-key)
20− - [Columns](#columns)
26+ - [Columns](#columns)
21− - [Add column](#add-column)
27+ - [Add column](#add-column)
22− - [Alter column](#alter-column)
28+ - [Alter column](#alter-column)
23− - [Remove column](#remove-column)
29+ - [Remove column](#remove-column)
24− - [Indices](#indices)
30+ - [Indices](#indices)
25− - [Add index](#add-index)
31+ - [Add index](#add-index)
32+ - [Remove index](#remove-index)
33+ - [Enums](#enums)
34+ - [Create enum](#create-enum)
35+ - [Remove enum](#remove-enum)
36+ - [Custom](#custom)
37+ - [Complex changes across tables](#complex-changes-across-tables)
26- [Commands and options](#commands-and-options)
38- [Commands and options](#commands-and-options)
27− - [`reshape migrate`](#reshape-migrate)
39+ - [`reshape migration start`](#reshape-migration-start)
28− - [`reshape complete`](#reshape-complete)
40+ - [`reshape migration complete`](#reshape-migration-complete)
29− - [`reshape abort`](#reshape-abort)
41+ - [`reshape migration abort`](#reshape-migration-abort)
30− - [`reshape generate-schema-query`](#reshape-generate-schema-query)
42+ - [`reshape schema-query`](#reshape-schema-query)
31− - [Connection options](#connection-options)
43+ - [Connection options](#connection-options)
44+- [License](#license)
45+
32−- [How it works](#how-it-works)
46+## How it works
47+
48+Reshape 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+
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.
51+2. **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.
53+
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.
33
55
34## Getting started
56## Getting started
35
57
@@ -39,24 +61,33 @@ Reshape is an easy-to-use, zero-downtime schema migration tool for Postgres. It
39
61
40Binaries are available for macOS and Linux under [Releases](https://github.com/fabianlindfors/reshape/releases).
62Binaries are available for macOS and Linux under [Releases](https://github.com/fabianlindfors/reshape/releases).
41
63
64+#### Cargo
65+
66+Reshape can be installed using [Cargo](https://doc.rust-lang.org/cargo/) (requires Rust 1.58 or later):
67+
68+```shell
69+cargo install reshape
70+```
71+
42#### Docker
72#### Docker
43
73
44−Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
74+Reshape is available as a Docker image on [Docker Hub](https://hub.docker.com/repository/docker/fabianlindfors/reshape).
45
75
46```shell
76```shell
47−docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migrate
77+docker run -v $(pwd):/usr/share/app fabianlindfors/reshape reshape migration start
48```
78```
49
79
50### Creating your first migration
80### Creating your first migration
51
81
52−Each migration should be stored as a separate file under `migrations/`. The files can be in either JSON or TOML format. The name of the file will become the name of your migration and they will be sorted by file name. We recommend prefixing every migration with an incrementing number.
82+Each migration should be stored as a separate file in a `migrations/` directory. The files can be in either JSON or TOML format and the name of the file will become the name of your migration. We recommend prefixing every migration with an incrementing number as migrations are sorted by file name.
53
83
54−Let's create a simple migration to set up a new table `users` with two fields, `id` and `name`. We'll create a file called `migration/1_create_users_table.toml`:
84+Let's create a simple migration to set up a new table `users` with two fields, `id` and `name`. We'll create a file called `migrations/1_create_users_table.toml`:
55
85
56```toml
86```toml
57[[actions]]
87[[actions]]
58type = "create_table"
88type = "create_table"
59−table = "users"
89+name = "users"
90+primary_key = ["id"]
60
91
61 [[actions.columns]]
92 [[actions.columns]]
62 name = "id"
93 name = "id"
@@ -72,9 +103,14 @@ This is the equivalent of running `CREATE TABLE users (id INTEGER GENERATED ALWA
72
103
73### Preparing your application
104### Preparing your application
74
105
75−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`.
106+Reshape relies on your application using a specific schema. When establishing the connection to Postgres in your application, you need to run a query to select the most recent schema. The simplest way to do this is to use one of the helper libraries:
107+
108+- [Rust](https://github.com/fabianlindfors/reshape-helper)
109+- [Ruby (and Rails)](https://github.com/fabianlindfors/reshape-ruby)
110+- [Python (and Django)](https://github.com/fabianlindfors/reshape-python)
111+- [Go](https://github.com/leourbina/reshape-helper)
76
112
77−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:
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:
78
114
79```python
115```python
80# Example for Python
116# Example for Python
@@ -87,13 +123,17 @@ db.execute(reshape_schema_query)
87To create your new `users` table, run:
123To create your new `users` table, run:
88
124
89```bash
125```bash
90−reshape migrate
126+reshape migration start --complete
91```
127```
92
128
93−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`.
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.
94
130
95If 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.
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.
96
132
133+### Using during development
134+
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`.
136+
97## Writing migrations
137## Writing migrations
98
138
99### Basics
139### Basics
@@ -103,7 +143,8 @@ Every migration consists of one or more actions. The actions will be run sequent
103```toml
143```toml
104[[actions]]
144[[actions]]
105type = "create_table"
145type = "create_table"
106−table = "customers"
146+name = "customers"
147+primary_key = ["id"]
107
148
108 [[actions.columns]]
149 [[actions.columns]]
109 name = "id"
150 name = "id"
@@ -112,7 +153,8 @@ table = "customers"
112
153
113[[actions]]
154[[actions]]
114type = "create_table"
155type = "create_table"
115−table = "products"
156+name = "products"
157+primary_key = ["sku"]
116
158
117 [[actions.columns]]
159 [[actions.columns]]
118 name = "sku"
160 name = "sku"
@@ -125,15 +167,15 @@ Every action has a `type`. The supported types are detailed below.
125
167
126#### Create table
168#### Create table
127
169
128−The `create_table` action will create a new table with the specified columns, indices and constraints.
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.
129
171
130−*Example: create a `customers` table with a few columns and a primary key*
172+_Example: create a `customers` table with a few columns and a primary key_
131
173
132```toml
174```toml
133[[actions]]
175[[actions]]
134type = "create_table"
176type = "create_table"
135−table = "customers"
177+name = "customers"
136−primary_key = "id"
178+primary_key = ["id"]
137
179
138 [[actions.columns]]
180 [[actions.columns]]
139 name = "id"
181 name = "id"
@@ -145,19 +187,19 @@ primary_key = "id"
145 type = "TEXT"
187 type = "TEXT"
146
188
147 # Columns default to nullable
189 # Columns default to nullable
148− nullable = false
190+ nullable = false
149
191
150 # default can be any valid SQL value, in this case a string literal
192 # default can be any valid SQL value, in this case a string literal
151− default = "'PLACEHOLDER'"
193+ default = "'PLACEHOLDER'"
152```
194```
153
195
154−*Example: create `users` and `items` tables with a foreign key between them*
196+_Example: create `users` and `items` tables with a foreign key between them_
155
197
156```toml
198```toml
157[[actions]]
199[[actions]]
158type = "create_table"
200type = "create_table"
159−table = "users"
201+name = "users"
160−primary_key = "id"
202+primary_key = ["id"]
161
203
162 [[actions.columns]]
204 [[actions.columns]]
163 name = "id"
205 name = "id"
@@ -166,8 +208,8 @@ primary_key = "id"
166
208
167[[actions]]
209[[actions]]
168type = "create_table"
210type = "create_table"
169−table = "items"
211+name = "items"
170−primary_key = "id"
212+primary_key = ["id"]
171
213
172 [[actions.columns]]
214 [[actions.columns]]
173 name = "id"
215 name = "id"
@@ -184,11 +226,34 @@ primary_key = "id"
184 referenced_columns = ["id"]
226 referenced_columns = ["id"]
185```
227```
186
228
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+
187#### Rename table
252#### Rename table
188
253
189The `rename_table` action will change the name of an existing table.
254The `rename_table` action will change the name of an existing table.
190
255
191−*Example: change name of `users` table to `customers`*
256+_Example: change name of `users` table to `customers`_
192
257
193```toml
258```toml
194[[actions]]
259[[actions]]
@@ -201,7 +266,7 @@ new_name = "customers"
201
266
202The `remove_table` action will remove an existing table.
267The `remove_table` action will remove an existing table.
203
268
204−*Example: remove `users` table*
269+_Example: remove `users` table_
205
270
206```toml
271```toml
207[[actions]]
272[[actions]]
@@ -209,13 +274,43 @@ type = "remove_table"
209table = "users"
274table = "users"
210```
275```
211
276
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+
212### Columns
307### Columns
213
308
214#### Add column
309#### Add column
215
310
216−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.
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)).
217
312
218−*Example: add a new column `reference` to table `products`*
313+_Example: add a new column `reference` to table `products`_
219
314
220```toml
315```toml
221[[actions]]
316[[actions]]
@@ -229,7 +324,7 @@ table = "products"
229 default = "10"
324 default = "10"
230```
325```
231
326
232−*Example: replace an existing `name` column with two new columns, `first_name` and `last_name`*
327+_Example: replace an existing `name` column with two new columns, `first_name` and `last_name`_
233
328
234```toml
329```toml
235[[actions]]
330[[actions]]
@@ -265,14 +360,48 @@ column = "name"
265down = "first_name || ' ' || last_name"
360down = "first_name || ' ' || last_name"
266```
361```
267
362
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+```
268
397
269#### Alter column
398#### Alter column
270
399
271The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
400The `alter_column` action enables many different changes to an existing column, for example renaming, changing type and changing existing values.
272
401
273−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.
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.
274
403
275−*Example: rename `last_name` column on `users` table to `family_name`*
404+_Example: rename `last_name` column on `users` table to `family_name`_
276
405
277```toml
406```toml
278[[actions]]
407[[actions]]
@@ -284,7 +413,7 @@ column = "last_name"
284 name = "family_name"
413 name = "family_name"
285```
414```
286
415
287−*Example: change the type of `reference` column from `INTEGER` to `TEXT`*
416+_Example: change the type of `reference` column from `INTEGER` to `TEXT`_
288
417
289```toml
418```toml
290[[actions]]
419[[actions]]
@@ -299,12 +428,13 @@ down = "CAST(reference AS INTEGER)" # Converts from text value to integer
299 type = "TEXT" # Previous type was 'INTEGER'
428 type = "TEXT" # Previous type was 'INTEGER'
300```
429```
301
430
302−*Example: increment all values of an `index` column by one*
431+_Example: increment all values of an `index` column by one_
303
432
304```toml
433```toml
305[[actions]]
434[[actions]]
306type = "alter_column"
435type = "alter_column"
307table = "users"
436table = "users"
437+column = "index"
308
438
309up = "index + 1" # Increment for new schema
439up = "index + 1" # Increment for new schema
310down = "index - 1" # Decrement to revert for old schema
440down = "index - 1" # Decrement to revert for old schema
@@ -313,11 +443,40 @@ down = "index - 1" # Decrement to revert for old schema
313 name = "index"
443 name = "index"
314```
444```
315
445
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_
462+
463+```toml
464+[[actions]]
465+type = "alter_column"
466+table = "users"
467+column = "created_at"
468+
469+ [actions.changes]
470+ default = "NOW()"
471+```
472+
316#### Remove column
473#### Remove column
317
474
318−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.
475+The `remove_column` action will remove an existing column from a table. You can optionally provide a `down` setting. This should be an SQL expression which will be used to determine values for the old schema when inserting or updating rows using the new schema. `down` may also reference another table to perform cross-table migrations (see ["Complex changes across tables"](#complex-changes-across-tables)) . The `down` setting must be provided when the removed column is `NOT NULL` or doesn't have a default value.
476+
477+Any indices that cover the column will be removed.
319
478
320−*Example: remove column `name` from table `users`*
479+_Example: remove column `name` from table `users`_
321
480
322```toml
481```toml
323[[actions]]
482[[actions]]
@@ -329,18 +488,34 @@ column = "name"
329down = "'N/A'"
488down = "'N/A'"
330```
489```
331
490
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+
332### Indices
507### Indices
333
508
334#### Add index
509#### Add index
335
510
336The `add_index` action will add a new index to an existing table.
511The `add_index` action will add a new index to an existing table.
337
512
338−*Example: create a `users` table with an index on the `name` column*
513+_Example: create a `users` table with a unique index on the `name` column_
339
514
340```toml
515```toml
341[[actions]]
516[[actions]]
342type = "create_table"
517type = "create_table"
343−table = "users"
518+name = "users"
344primary_key = "id"
519primary_key = "id"
345
520
346 [[actions.columns]]
521 [[actions.columns]]
@@ -355,70 +530,242 @@ primary_key = "id"
355[[actions]]
530[[actions]]
356type = "add_index"
531type = "add_index"
357table = "users"
532table = "users"
533+
534+ [actions.index]
358−name = "name_idx"
535+ name = "name_idx"
359−columns = ["name"]
536+ 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+```
556+
557+#### Remove index
558+
559+The `remove_index` action will remove an existing index. The index won't actually be removed until the migration is completed.
560+
561+_Example: remove the `name_idx` index_
562+
563+```toml
564+[[actions]]
565+type = "remove_index"
566+index = "name_idx"
567+```
568+
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"
360```
707```
361
708
362## Commands and options
709## Commands and options
363
710
364−### `reshape migrate`
711+### `reshape migration start`
365
712
366−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`.
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`.
367
714
368#### Options
715#### Options
369
716
370−*See also [Connection options](#connection-options)*
717+_See also [Connection options](#connection-options)_
371
718
372−| Option | Default | Description |
719+| Option | Default | Description |
373−| ------ | ------- | ----------- |
720+| ------------------ | ------------- | --------------------------------------------------------------------------------------------------------------- |
374−| `--complete`, `-c` | `false` | Automatically complete migration after applying it. Useful during development. |
721+| `--complete`, `-c` | `false` | Automatically complete migration after applying it. |
375−| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
722+| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
376
723
377−### `reshape complete`
724+### `reshape migration complete`
378
725
379−Completes migrations previously started with `reshape complete`.
726+Completes migrations previously started with `reshape migration complete`.
380
727
381#### Options
728#### Options
382
729
383See [Connection options](#connection-options)
730See [Connection options](#connection-options)
384
731
385−### `reshape abort`
732+### `reshape migration abort`
386
733
387−Aborts any migrations which haven't yet been completed.
734+Aborts any migrations which haven't yet been completed.
388
735
389#### Options
736#### Options
390
737
391See [Connection options](#connection-options)
738See [Connection options](#connection-options)
392
739
393−### `reshape generate-schema-query`
740+### `reshape schema-query`
394
741
395Generates 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`).
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`).
396
743
744+If your application is written in Rust, we recommend using the [Rust helper library](https://github.com/fabianlindfors/reshape-helper/) instead.
745+
397The query should look something like `SET search_path TO migration_1_initial_migration`.
746The query should look something like `SET search_path TO migration_1_initial_migration`.
398
747
399#### Options
748#### Options
400
749
401−| Option | Default | Description |
750+| Option | Default | Description |
402−| ------ | ------- | ----------- |
751+| -------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
403| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
752| `--dirs` | `migrations/` | Directories to search for migration files. Multiple directories can be specified using `--dirs dir1 dir2 dir3`. |
404
753
405### Connection options
754### Connection options
406
755
407−The options below can be used with all commands that communicate with Postgres. Use either a connection URL or specify each connection option individually.
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.
408
757
409−| Option | Default | Description |
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.
410−| ------ | ------- | ----------- |
411−| `--url` | | URI to connect to your Postgres database.<br>Can also be provided with the environment variable `DATABASE_URL`. |
412−| `--host` | `localhost` | Hostname to use when connecting to Postgres |
413−| `--port` | `5432` | Port which Postgres is listening on |
414−| `--database` | `postgres` | Database name |
415−| `--username` | `postgres` | Postgres username |
416−| `--password` | `postgres` | Postgres password |
417
759
418−## How it works
760+| Option | Default | Environment variable | Description |
761+| ------------ | ----------- | -------------------- | ------------------------------------------- |
762+| `--url` | | `DB_URL` | URL to your Postgres database |
763+| `--host` | `localhost` | `DB_HOST` | Hostname to use when connecting to Postgres |
764+| `--port` | `5432` | `DB_PORT` | Port which Postgres is listening on |
765+| `--database` | `postgres` | `DB_NAME` | Database name |
766+| `--username` | `postgres` | `DB_USERNAME` | Postgres username |
767+| `--password` | `postgres` | `DB_PASSWORD` | Postgres password |
419
768
420−Reshape 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 migration is a two phase process:
769+## License
421
770
422−1. **Start migration** (`reshape migrate`): Create new views to ensure both the new and old schema are usable at the same time.
771+Reshape is released under the [MIT license](https://choosealicense.com/licenses/mit/).
423− - After phase one is complete, you can start the roll out of your application. Once the roll out is complete, the second phase can be run.
424−2. **Complete migration** (`reshape complete`): Removes the old schema and any intermediate data.
src/db.rs+155−11
@@ -1,4 +1,87 @@
1+use std::{cmp::min, time::Duration};
2+
3+use anyhow::{anyhow, Context};
1use postgres::{types::ToSql, NoTls, Row};
4use 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+}
2
85
3pub trait Conn {
86pub trait Conn {
4 fn run(&mut self, query: &str) -> anyhow::Result<()>;
87 fn run(&mut self, query: &str) -> anyhow::Result<()>;
@@ -8,6 +91,7 @@ pub trait Conn {
8 query: &str,
91 query: &str,
9 params: &[&(dyn ToSql + Sync)],
92 params: &[&(dyn ToSql + Sync)],
10 ) -> anyhow::Result<Vec<Row>>;
93 ) -> anyhow::Result<Vec<Row>>;
94+ fn transaction(&mut self) -> anyhow::Result<Transaction>;
11}
95}
12
96
13pub struct DbConn {
97pub struct DbConn {
@@ -15,25 +99,19 @@ pub struct DbConn {
15}
99}
16
100
17impl DbConn {
101impl DbConn {
18− pub fn connect(config: &postgres::Config) -> anyhow::Result<DbConn> {
102+ fn new(client: postgres::Client) -> Self {
19− let client = config.connect(NoTls)?;
20− Ok(DbConn { client })
103+ DbConn { client }
21− }
22−
23− pub fn transaction(&mut self) -> anyhow::Result<Transaction> {
24− let transaction = self.client.transaction()?;
25− Ok(Transaction { transaction })
26 }
104 }
27}
105}
28
106
29impl Conn for DbConn {
107impl Conn for DbConn {
30 fn run(&mut self, query: &str) -> anyhow::Result<()> {
108 fn run(&mut self, query: &str) -> anyhow::Result<()> {
31− self.client.batch_execute(query)?;
109+ retry_automatically(|| self.client.batch_execute(query))?;
32 Ok(())
110 Ok(())
33 }
111 }
34
112
35 fn query(&mut self, query: &str) -> anyhow::Result<Vec<Row>> {
113 fn query(&mut self, query: &str) -> anyhow::Result<Vec<Row>> {
36− let rows = self.client.query(query, &[])?;
114+ let rows = retry_automatically(|| self.client.query(query, &[]))?;
37 Ok(rows)
115 Ok(rows)
38 }
116 }
39
117
@@ -42,9 +120,14 @@ impl Conn for DbConn {
42 query: &str,
120 query: &str,
43 params: &[&(dyn ToSql + Sync)],
121 params: &[&(dyn ToSql + Sync)],
44 ) -> anyhow::Result<Vec<Row>> {
122 ) -> anyhow::Result<Vec<Row>> {
45− let rows = self.client.query(query, params)?;
123+ let rows = retry_automatically(|| self.client.query(query, params))?;
46 Ok(rows)
124 Ok(rows)
47 }
125 }
126+
127+ fn transaction(&mut self) -> anyhow::Result<Transaction> {
128+ let transaction = self.client.transaction()?;
129+ Ok(Transaction { transaction })
130+ }
48}
131}
49
132
50pub struct Transaction<'a> {
133pub struct Transaction<'a> {
@@ -56,6 +139,11 @@ impl Transaction<'_> {
56 self.transaction.commit()?;
139 self.transaction.commit()?;
57 Ok(())
140 Ok(())
58 }
141 }
142+
143+ pub fn rollback(self) -> anyhow::Result<()> {
144+ self.transaction.rollback()?;
145+ Ok(())
146+ }
59}
147}
60
148
61impl Conn for Transaction<'_> {
149impl Conn for Transaction<'_> {
@@ -77,4 +165,60 @@ impl Conn for Transaction<'_> {
77 let rows = self.transaction.query(query, params)?;
165 let rows = self.transaction.query(query, params)?;
78 Ok(rows)
166 Ok(rows)
79 }
167 }
168+
169+ fn transaction(&mut self) -> anyhow::Result<Transaction> {
170+ let transaction = self.transaction.transaction()?;
171+ Ok(Transaction { transaction })
172+ }
173+}
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)
80}
224}
src/helpers.rs+8−17
@@ -2,37 +2,28 @@ use anyhow::Context;
2
2
3use crate::db::Conn;
3use crate::db::Conn;
4
4
5−pub fn setup_helpers(db: &mut dyn Conn, current_migration: &Option<String>) -> anyhow::Result<()> {
5+pub fn set_up_helpers(db: &mut dyn Conn, target_migration: &str) -> 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− format!("setting_bool")
13− };
14−
15 let query = format!(
6 let query = format!(
16 "
7 "
17− CREATE OR REPLACE FUNCTION reshape.is_old_schema()
8+ CREATE OR REPLACE FUNCTION reshape.is_new_schema()
18 RETURNS BOOLEAN AS $$
9 RETURNS BOOLEAN AS $$
19 DECLARE
10 DECLARE
20− setting TEXT := current_setting('reshape.is_old_schema', TRUE);
11+ setting TEXT := current_setting('reshape.is_new_schema', TRUE);
21 setting_bool BOOLEAN := setting IS NOT NULL AND setting = 'YES';
12 setting_bool BOOLEAN := setting IS NOT NULL AND setting = 'YES';
22 BEGIN
13 BEGIN
23− RETURN {};
14+ RETURN current_setting('search_path') = 'migration_{}' OR setting_bool;
24 END
15 END
25 $$ language 'plpgsql';
16 $$ language 'plpgsql';
26 ",
17 ",
27− predicate
18+ target_migration,
28 );
19 );
29 db.query(&query)
20 db.query(&query)
30− .context("failed creating helper function reshape.is_old_schema()")?;
21+ .context("failed creating helper function reshape.is_new_schema()")?;
31
22
32 Ok(())
23 Ok(())
33}
24}
34
25
35−pub fn teardown_helpers(db: &mut dyn Conn) -> anyhow::Result<()> {
26+pub fn tear_down_helpers(db: &mut dyn Conn) -> anyhow::Result<()> {
36− db.query("DROP FUNCTION reshape.is_old_schema;")?;
27+ db.query("DROP FUNCTION IF EXISTS reshape.is_new_schema;")?;
37 Ok(())
28 Ok(())
38}
29}
src/lib.rs+419−198
@@ -1,10 +1,11 @@
1use crate::{
1use crate::{
2− migrations::{Context, Migration},
2+ migrations::{Migration, MigrationContext},
3 schema::Schema,
3 schema::Schema,
4};
4};
5
5
6+use anyhow::{anyhow, Context};
6use colored::*;
7use colored::*;
7−use db::{Conn, DbConn};
8+use db::{Conn, DbConn, DbLocker};
8use postgres::Config;
9use postgres::Config;
9use schema::Table;
10use schema::Table;
10
11
@@ -14,11 +15,10 @@ pub mod migrations;
14mod schema;
15mod schema;
15mod state;
16mod state;
16
17
17−pub use crate::state::{State, Status};
18+pub use crate::state::State;
18
19
19pub struct Reshape {
20pub struct Reshape {
20− pub state: State,
21+ db: DbLocker,
21− db: DbConn,
22}
22}
23
23
24impl Reshape {
24impl Reshape {
@@ -30,6 +30,7 @@ impl Reshape {
30 pub fn new_with_options(
30 pub fn new_with_options(
31 host: &str,
31 host: &str,
32 port: u16,
32 port: u16,
33+ database: &str,
33 username: &str,
34 username: &str,
34 password: &str,
35 password: &str,
35 ) -> anyhow::Result<Reshape> {
36 ) -> anyhow::Result<Reshape> {
@@ -38,268 +39,488 @@ impl Reshape {
38 .host(host)
39 .host(host)
39 .port(port)
40 .port(port)
40 .user(username)
41 .user(username)
42+ .dbname(database)
41 .password(password);
43 .password(password);
42
44
43 Self::new_with_config(&config)
45 Self::new_with_config(&config)
44 }
46 }
45
47
46 fn new_with_config(config: &Config) -> anyhow::Result<Reshape> {
48 fn new_with_config(config: &Config) -> anyhow::Result<Reshape> {
47− let mut db = DbConn::connect(config)?;
49+ let db = DbLocker::connect(config)?;
48− let state = State::load(&mut db);
50+ Ok(Reshape { db })
51+ }
49
52
50− Ok(Reshape { db, state })
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)?;
59+ migrate(db, &mut state, migrations)
60+ })
51 }
61 }
52
62
53− pub fn migrate<T>(&mut self, migrations: T) -> anyhow::Result<()>
63+ pub fn complete(&mut self) -> anyhow::Result<()> {
54− where
64+ self.db.lock(|db| {
55− T: IntoIterator<Item = Migration>,
56− {
57− self.state = State::load(&mut self.db);
65+ let mut state = State::load(db)?;
66+ complete(db, &mut state)
67+ })
68+ }
58
69
59− // Make sure no migration is in progress
70+ pub fn abort(&mut self) -> anyhow::Result<()> {
60− if let state::Status::InProgress { migrations: _ } = &self.state.status {
71+ self.db.lock(|db| {
61− println!("Migration already in progress, please complete using 'reshape complete'");
72+ let mut state = State::load(db)?;
62− return Ok(());
73+ abort(db, &mut state)
74+ })
63− }
75+ }
64
76
65− let current_migration = &self.state.current_migration.clone();
77+ pub fn remove(&mut self) -> anyhow::Result<()> {
66− let remaining_migrations = self.state.get_remaining_migrations(migrations)?;
78+ self.db.lock(|db| {
67− if remaining_migrations.is_empty() {
79+ let mut state = State::load(db)?;
68− println!("No migrations left to apply");
80+
69− return Ok(());
81+ // Remove migration schemas and views
82+ if let Some(current_migration) = &state::current_migration(db)? {
83+ db.run(&format!(
84+ "DROP SCHEMA IF EXISTS {} CASCADE",
85+ schema_name_for_migration(current_migration)
86+ ))?;
70− }
87+ }
71
88
72− println!(" Applying {} migrations\n", remaining_migrations.len());
89+ if let State::InProgress { migrations } = &state {
90+ let target_migration = migrations.last().unwrap().name.to_string();
91+ db.run(&format!(
92+ "DROP SCHEMA IF EXISTS {} CASCADE",
93+ schema_name_for_migration(&target_migration)
94+ ))?;
95+ }
73
96
74− let target_migration = remaining_migrations.last().unwrap().name.to_string();
97+ // Remove all tables
98+ let schema = Schema::new();
99+ for table in schema.get_tables(db)? {
100+ db.run(&format!(
101+ r#"
102+ DROP TABLE IF EXISTS "{}" CASCADE
103+ "#,
104+ table.real_name
105+ ))?;
106+ }
75
107
76− let mut new_schema = Schema::new();
108+ // Remove all enums
109+ let enums: Vec<String> = db
110+ .query("SELECT typname FROM pg_type WHERE typcategory = 'E'")?
111+ .iter()
112+ .map(|row| row.get("typname"))
113+ .collect();
114+ for enum_type in enums {
115+ db.run(&format!("DROP TYPE {}", enum_type))?;
116+ }
77
117
78− helpers::setup_helpers(&mut self.db, current_migration)?;
118+ // Reset state
119+ state.clear(db)?;
79
120
80− for (migration_index, migration) in remaining_migrations.iter().enumerate() {
121+ println!("Reshape and all data has been removed");
81− println!("Migrating '{}':", migration.name);
82
122
83− for (action_index, action) in migration.actions.iter().enumerate() {
123+ Ok(())
84− print!(" + {} ", action.describe());
124+ })
125+ }
126+}
85
127
86− let ctx = Context::new(migration_index, action_index);
128+pub fn latest_schema_from_migrations(migrations: &[Migration]) -> Option<String> {
87− action.run(&ctx, &mut self.db, &new_schema)?;
129+ migrations
88− action.update_schema(&ctx, &mut new_schema)?;
130+ .last()
131+ .map(|migration| schema_name_for_migration(&migration.name))
132+}
89
133
90− println!("{}", "done".green());
134+pub fn schema_query_for_migration(migration_name: &str) -> String {
135+ let schema_name = schema_name_for_migration(migration_name);
136+ format!("SET search_path TO {}", schema_name)
91− }
137+}
92
138
93− println!("");
139+fn schema_name_for_migration(migration_name: &str) -> String {
140+ format!("migration_{}", migration_name)
94− }
141+}
95
142
96− // Create schema and views for migration
143+fn migrate(
97− self.create_schema_for_migration(&target_migration, &new_schema)?;
144+ db: &mut DbConn,
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+ }
98
155
99− // Update state once migrations have been performed
156+ if let State::Completing { .. } = &state {
100− self.state.in_progress(remaining_migrations);
157+ println!(
101− self.state.save(&mut self.db)?;
158+ "Migration already in progress and has started completion, please finish using 'reshape migration complete'"
159+ );
160+ return Ok(());
161+ }
102
162
103− // If we started from a blank slate, we can finish the migration immediately
163+ // Determine which migrations need to be applied by comparing the provided migrations
104− if current_migration.is_none() {
164+ // with the already applied ones stored in the state. This will throw an error if the
165+ // two sets of migrations don't agree, for example if a new migration has been added
166+ // in between two existing ones.
167+ let remaining_migrations = state::remaining_migrations(db, migrations)?;
168+ if remaining_migrations.is_empty() {
105− println!("Automatically completing migrations\n");
169+ println!("No migrations left to apply");
106− self.complete_migration()?;
170+ return Ok(());
171+ }
107
172
108− println!("Migrations complete:");
173+ // If we have already started applying some migrations we need to ensure that
109− println!(
174+ // they are the same ones we want to apply now
110− " - Run '{}' from your application to use the latest schema",
175+ if let State::Applying {
111− schema_query_for_migration(&target_migration)
176+ migrations: existing_migrations,
112− );
177+ } = &state
113− } else {
178+ {
114− println!("Migrations have been applied and the new schema is ready for use:");
179+ if existing_migrations != &remaining_migrations {
115− println!(
180+ return Err(anyhow!(
116− " - Run '{}' from your application to use the latest schema",
181+ "a previous migration seems to have failed without cleaning up. Please run `reshape migration abort` and then run migrate again."
117− schema_query_for_migration(&target_migration)
118− );
119− println!(
120− " - Run 'reshape complete' once your application has been updated and the previous schema is no longer in use"
121− );
182+ ));
122 }
183 }
123−
124− Ok(())
125 }
184 }
126
185
127− pub fn complete_migration(&mut self) -> anyhow::Result<()> {
186+ // Move to the "Applying" state which is necessary as we can't run the migrations
128− // Make sure a migration is in progress
187+ // and state update as a single transaction. If a migration unexpectedly fails without
188+ // automatically aborting, this state saves us from dangling migrations. It forces the user
189+ // to either run migrate again (which works as all migrations are idempotent) or abort.
129− let remaining_migrations = match &self.state.status {
190+ state.applying(remaining_migrations.clone());
130− state::Status::InProgress { migrations } => migrations,
191+ state.save(db)?;
131− _ => {
132− println!("No migration in progress");
133− return Ok(());
134− }
135− };
136
192
137− helpers::teardown_helpers(&mut self.db)?;
193+ println!("Applying {} migrations\n", remaining_migrations.len());
138
194
139− let mut temp_schema = Schema::new();
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")?;
140
197
141− // Run all the completion changes as a transaction to avoid incomplete updates
198+ let mut new_schema = Schema::new();
142− let mut transaction = self.db.transaction()?;
199+ let mut last_migration_index = usize::MAX;
200+ let mut last_action_index = usize::MAX;
201+ let mut result: anyhow::Result<()> = Ok(());
143
202
144− // Remove previous migration's schema
203+ 'outer: for (migration_index, migration) in remaining_migrations.iter().enumerate() {
145− if let Some(current_migration) = &self.state.current_migration {
204+ println!("Migrating '{}':", migration.name);
146− transaction.run(&format!(
205+ last_migration_index = migration_index;
147− "DROP SCHEMA IF EXISTS {} CASCADE",
148− schema_name_for_migration(current_migration)
149− ))?;
150− }
151
206
152− for (migration_index, migration) in remaining_migrations.iter().enumerate() {
207+ for (action_index, action) in migration.actions.iter().enumerate() {
153− println!("Completing '{}':", migration.name);
208+ last_action_index = action_index;
154
209
155− for (action_index, action) in migration.actions.iter().enumerate() {
210+ let description = action.describe();
156− print!(" + {} ", action.describe());
211+ print!(" + {} ", description);
157
212
213+ let ctx =
158− let ctx = Context::new(migration_index, action_index);
214+ MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
159− action.complete(&ctx, &mut transaction, &temp_schema)?;
215+ result = action
160− action.update_schema(&ctx, &mut temp_schema)?;
216+ .run(&ctx, db, &new_schema)
217+ .with_context(|| format!("failed to {}", description));
161
218
219+ if result.is_ok() {
220+ action.update_schema(&ctx, &mut new_schema);
162 println!("{}", "done".green());
221 println!("{}", "done".green());
222+ } else {
223+ println!("{}", "failed".red());
224+ break 'outer;
163 }
225 }
164−
165− println!("");
166 }
226 }
167
227
168− self.state.complete()?;
228+ println!();
169− self.state.save(&mut transaction)?;
229+ }
170
230
171− transaction.commit()?;
231+ // If a migration failed, we abort all the migrations that were applied
232+ if let Err(err) = result {
233+ println!("A migration failed, aborting migrations that have already been applied");
172
234
173− Ok(())
235+ // Set to the Aborting state. This is to ensure that the failed
174− }
236+ // migration is fully aborted and nothing is left dangling.
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+ );
175
244
176− fn create_schema_for_migration(
245+ // Abort will only
177− &mut self,
246+ abort(db, state)?;
178− migration_name: &str,
179− schema: &Schema,
180− ) -> anyhow::Result<()> {
181− // Create schema for migration
182− let schema_name = schema_name_for_migration(migration_name);
183− self.db
184− .run(&format!("CREATE SCHEMA IF NOT EXISTS {}", schema_name))?;
185−
186− // Create views inside schema
187− for table in schema.get_tables(&mut self.db)? {
188− Self::create_view_for_table(&mut self.db, &table, &schema_name)?;
189− }
190
247
191− Ok(())
248+ return Err(err);
192 }
249 }
193
250
194− fn create_view_for_table(
251+ // Create schema and views for migration
195− db: &mut impl Conn,
252+ create_schema_for_migration(db, &target_migration, &new_schema)
196− table: &Table,
253+ .with_context(|| format!("failed to create schema for migration {}", target_migration))?;
197− schema: &str,
254+
198− ) -> anyhow::Result<()> {
255+ // Update state once migrations have been performed
199− let select_columns: Vec<String> = table
256+ state.in_progress(remaining_migrations);
200− .columns
257+ state.save(db).context("failed to save in-progress state")?;
201− .iter()
258+
202− .map(|column| format!("{} AS {}", column.real_name, column.name))
259+ println!("Migrations have been applied and the new schema is ready for use:");
203− .collect();
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+}
204
269
270+fn complete(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
271+ // Make sure a migration is in progress
272+ let (remaining_migrations, starting_migration_index, starting_action_index) = match state.clone() {
273+ State::InProgress { migrations } => {
274+ // Move into the Completing state. Once in this state,
275+ // the migration can't be aborted and must be completed.
276+ state.completing(migrations.clone(), 0, 0);
277+ state.save(db).context("failed to save state")?;
278+
279+ (migrations, 0, 0)
280+ },
281+ State::Completing {
282+ migrations,
283+ current_migration_index,
284+ current_action_index
285+ } => (migrations, current_migration_index, current_action_index),
286+ State::Aborting { .. } => {
287+ return Err(anyhow!("migration been aborted and can't be completed. Please finish using `reshape migration abort`."))
288+ }
289+ State::Applying { .. } => {
290+ return Err(anyhow!("a previous migration unexpectedly failed. Please run `reshape migrate` to try applying the migration again."))
291+ }
292+ State::Idle => {
293+ println!("No migration in progress");
294+ return Ok(());
295+ }
296+ };
297+
298+ // Remove previous migration's schema
299+ if let Some(current_migration) = &state::current_migration(db)? {
205 db.run(&format!(
300 db.run(&format!(
206− "CREATE OR REPLACE VIEW {schema}.{view_name} AS
301+ "DROP SCHEMA IF EXISTS {} CASCADE",
207− SELECT {columns}
302+ schema_name_for_migration(current_migration)
208− FROM {table_name}",
303+ ))
209− schema = schema,
304+ .context("failed to remove previous migration's schema")?;
210− table_name = table.real_name,
211− view_name = table.name,
212− columns = select_columns.join(","),
213− ))?;
214−
215− Ok(())
216 }
305 }
217
306
218− pub fn remove(&mut self) -> anyhow::Result<()> {
307+ for (migration_index, migration) in remaining_migrations.iter().enumerate() {
219− // Remove migration schemas and views
308+ // Skip all the migrations which have already been completed
220− if let Some(current_migration) = &self.state.current_migration {
309+ if migration_index < starting_migration_index {
221− self.db.run(&format!(
310+ continue;
222− "DROP SCHEMA IF EXISTS {} CASCADE",
223− schema_name_for_migration(current_migration)
224− ))?;
225 }
311 }
226
312
227− if let Status::InProgress { migrations } = &self.state.status {
313+ println!("Completing '{}':", migration.name);
228− let target_migration = migrations.last().unwrap().name.to_string();
229− self.db.run(&format!(
230− "DROP SCHEMA IF EXISTS {} CASCADE",
231− schema_name_for_migration(&target_migration)
232− ))?;
233− }
234
314
235− // Remove all tables
315+ for (action_index, action) in migration.actions.iter().enumerate() {
236− let schema = Schema::new();
316+ // Skip all actions which have already been completed
237− for table in schema.get_tables(&mut self.db)? {
317+ if migration_index == starting_migration_index && action_index < starting_action_index {
238− self.db
318+ continue;
239− .run(&format!("DROP TABLE IF EXISTS {} CASCADE", table.real_name))?;
240− }
319+ }
241
320
242− // Reset state
321+ let description = action.describe();
243− self.state.clear(&mut self.db)?;
322+ print!(" + {} ", description);
244
323
245− println!("Reshape and all data has been removed");
324+ let ctx =
325+ MigrationContext::new(migration_index, action_index, state::current_migration(db)?);
246
326
247− Ok(())
327+ // Update state to indicate that this action has been completed.
248− }
328+ // We won't save this new state until after the action has completed.
329+ state.completing(
330+ remaining_migrations.clone(),
331+ migration_index + 1,
332+ action_index + 1,
333+ );
249
334
250− pub fn abort(&mut self) -> anyhow::Result<()> {
335+ // This did_save check is necessary because of the borrow checker.
251− let remaining_migrations = match &self.state.status {
336+ // The Transaction which might be returned from action.complete
252− Status::InProgress { migrations } => migrations,
337+ // contains a mutable reference to self.db. We need the Transaction
253− _ => {
338+ // to be dropped before we can save the state using self.db instead,
254− println!("No migration is in progress");
339+ // which we achieve here by limiting the lifetime of the Transaction
255− return Ok(());
340+ // with a new block.
341+ let did_save = {
342+ let result = action
343+ .complete(&ctx, db)
344+ .with_context(|| format!("failed to complete migration {}", migration.name))
345+ .with_context(|| format!("failed to complete action: {}", description));
346+
347+ let maybe_transaction = match result {
348+ Ok(maybe_transaction) => {
349+ println!("{}", "done".green());
350+ maybe_transaction
351+ }
352+ Err(e) => {
353+ println!("{}", "failed".red());
354+ return Err(e);
355+ }
356+ };
357+
358+ // Update state with which migrations and actions have been completed.
359+ // Each action can create and return a transaction if they need atomicity.
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
367+ .save(&mut transaction)
368+ .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+ }
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")?;
256 }
384 }
257− };
385+ }
258− let target_migration = remaining_migrations.last().unwrap().name.to_string();
259
386
260− helpers::teardown_helpers(&mut self.db)?;
387+ println!();
388+ }
261
389
262− // Run all the abort changes as a transaction to avoid incomplete changes
390+ // Remove helpers which are no longer in use
263− let mut transaction = self.db.transaction()?;
391+ helpers::tear_down_helpers(db).context("failed to tear down helpers")?;
264
392
393+ state
394+ .complete(db)
395+ .context("failed to update state as completed")?;
396+
397+ Ok(())
398+}
399+
400+fn abort(db: &mut DbConn, state: &mut State) -> anyhow::Result<()> {
401+ let (remaining_migrations, last_migration_index, last_action_index) = match state.clone() {
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+
408+ (migrations, usize::MAX, usize::MAX)
409+ }
410+ State::Aborting {
411+ migrations,
412+ last_migration_index,
413+ last_action_index,
414+ } => (migrations, last_migration_index, last_action_index),
415+ State::Completing { .. } => {
416+ return Err(anyhow!("migration completion has already been started. Please run `reshape migration complete` again to finish it."));
417+ }
418+ State::Idle => {
419+ println!("No migration is in progress");
420+ return Ok(());
421+ }
422+ };
423+
265− // Remove new migration's schema
424+ // Remove new migration's schema
266− transaction.run(&format!(
425+ let target_migration = remaining_migrations.last().unwrap().name.to_string();
426+ let schema_name = schema_name_for_migration(&target_migration);
267− "DROP SCHEMA IF EXISTS {} CASCADE",
427+ db.run(&format!("DROP SCHEMA IF EXISTS {} CASCADE", schema_name,))
268− schema_name_for_migration(&target_migration)
428+ .with_context(|| format!("failed to drop schema {}", schema_name))?;
269− ))?;
429+
270−
271− // Abort all pending migrations in reverse order
430+ // Abort all pending migrations
431+ // Abort all migrations in reverse order
272− for (migration_index, migration) in remaining_migrations.iter().rev().enumerate() {
432+ for (migration_index, migration) in remaining_migrations.iter().enumerate().rev() {
273− print!("Aborting'{}' ", migration.name);
433+ // Skip migrations which shouldn't be aborted
274− for (action_index, action) in migration.actions.iter().rev().enumerate() {
434+ // The reason can be that they have already been aborted or that
275− let ctx = Context::new(migration_index, action_index);
435+ // the migration was never applied in the first place.
276− action.abort(&ctx, &mut transaction)?;
436+ if migration_index >= last_migration_index {
277− }
437+ continue;
278− println!("{}", "done".green());
279 }
438 }
280
439
281− let keep_count = self.state.migrations.len() - remaining_migrations.len();
440+ print!("Aborting '{}' ", migration.name);
282− self.state.migrations.truncate(keep_count);
283− self.state.status = state::Status::Idle;
284− self.state.save(&mut transaction)?;
285
441
286− transaction.commit()?;
442+ for (action_index, action) in migration.actions.iter().enumerate().rev() {
443+ // Skip actions which shouldn't be aborted
444+ // The reason can be that they have already been aborted or that
445+ // the action was never applied in the first place.
446+ if migration_index == last_migration_index - 1 && action_index >= last_action_index {
447+ continue;
448+ }
287
449
288− Ok(())
450+ let ctx =
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+
463+ println!("{}", "done".green());
289 }
464 }
290−}
291
465
292−pub fn latest_schema_from_migrations(migrations: &[Migration]) -> Option<String> {
466+ helpers::tear_down_helpers(db).context("failed to tear down helpers")?;
293− migrations
467+
294− .last()
468+ *state = State::Idle;
295− .map(|migration| schema_name_for_migration(&migration.name))
469+ state.save(db).context("failed to save state")?;
470+
471+ Ok(())
296}
472}
297
473
474+fn create_schema_for_migration(
475+ db: &mut DbConn,
298−pub fn schema_query_for_migration(migration_name: &str) -> String {
476+ migration_name: &str,
477+ schema: &Schema,
478+) -> anyhow::Result<()> {
479+ // Create schema for migration
299 let schema_name = schema_name_for_migration(migration_name);
480 let schema_name = schema_name_for_migration(migration_name);
300− format!("SET search_path TO {}", schema_name)
481+ db.run(&format!("CREATE SCHEMA IF NOT EXISTS {}", 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(())
301}
495}
302
496
303−fn schema_name_for_migration(migration_name: &str) -> String {
497+fn create_view_for_table(db: &mut impl Conn, table: &Table, schema: &str) -> anyhow::Result<()> {
304− format!("migration_{}", migration_name)
498+ let select_columns: Vec<String> = table
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(())
305}
526}
src/main.rs+98−27
@@ -4,6 +4,7 @@ use std::{
4 path::Path,
4 path::Path,
5};
5};
6
6
7+use anyhow::Context;
7use clap::{Args, Parser};
8use clap::{Args, Parser};
8use reshape::{
9use reshape::{
9 migrations::{Action, Migration},
10 migrations::{Action, Migration},
@@ -12,22 +13,69 @@ use reshape::{
12use serde::{Deserialize, Serialize};
13use serde::{Deserialize, Serialize};
13
14
14#[derive(Parser)]
15#[derive(Parser)]
16+#[clap(name = "Reshape", version, about)]
15struct Opts {
17struct Opts {
16 #[clap(subcommand)]
18 #[clap(subcommand)]
17 cmd: Command,
19 cmd: Command,
18}
20}
19
21
20#[derive(Parser)]
22#[derive(Parser)]
23+#[clap(about)]
21enum Command {
24enum 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+ )]
22 Migrate(MigrateOptions),
44 Migrate(MigrateOptions),
45+ #[clap(
46+ about = "Deprecated. Use `reshape migration complete` instead",
47+ display_order = 5
48+ )]
23 Complete(ConnectionOptions),
49 Complete(ConnectionOptions),
50+ #[clap(
51+ about = "Deprecated. Use `reshape migration abort` instead",
52+ display_order = 6
53+ )]
24− Remove(ConnectionOptions),
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),
68+
69+ #[clap(
70+ about = "Aborts an in-progress migration without losing any data",
71+ display_order = 3
72+ )]
25 Abort(ConnectionOptions),
73 Abort(ConnectionOptions),
26− GenerateSchemaQuery(FindMigrationsOptions),
27}
74}
28
75
29#[derive(Args)]
76#[derive(Args)]
30struct MigrateOptions {
77struct MigrateOptions {
78+ // Some comment
31 #[clap(long, short)]
79 #[clap(long, short)]
32 complete: bool,
80 complete: bool,
33 #[clap(flatten)]
81 #[clap(flatten)]
@@ -58,43 +106,35 @@ struct FindMigrationsOptions {
58 dirs: Vec<String>,
106 dirs: Vec<String>,
59}
107}
60
108
61−fn main() {
109+fn main() -> anyhow::Result<()> {
62 let opts: Opts = Opts::parse();
110 let opts: Opts = Opts::parse();
63−
64− let result = run(opts);
111+ run(opts)
65− if let Err(e) = result {
66− println!("Error: {}", e);
67− }
68}
112}
69
113
70fn run(opts: Opts) -> anyhow::Result<()> {
114fn run(opts: Opts) -> anyhow::Result<()> {
71 match opts.cmd {
115 match opts.cmd {
72− Command::Migrate(opts) => {
116+ Command::Migration(MigrationCommand::Start(opts)) | Command::Migrate(opts) => {
73 let mut reshape = reshape_from_connection_options(&opts.connection_options)?;
117 let mut reshape = reshape_from_connection_options(&opts.connection_options)?;
74 let migrations = find_migrations(&opts.find_migrations_options)?;
118 let migrations = find_migrations(&opts.find_migrations_options)?;
75 reshape.migrate(migrations)?;
119 reshape.migrate(migrations)?;
76
120
77 // Automatically complete migration if --complete flag is set
121 // Automatically complete migration if --complete flag is set
78 if opts.complete {
122 if opts.complete {
79− reshape.complete_migration()?;
123+ reshape.complete()?;
80 }
124 }
81
125
82 Ok(())
126 Ok(())
83 }
127 }
84− Command::Complete(opts) => {
128+ Command::Migration(MigrationCommand::Complete(opts)) | Command::Complete(opts) => {
85− let mut reshape = reshape_from_connection_options(&opts)?;
86− reshape.complete_migration()
87− }
88− Command::Remove(opts) => {
89 let mut reshape = reshape_from_connection_options(&opts)?;
129 let mut reshape = reshape_from_connection_options(&opts)?;
90− reshape.remove()
130+ reshape.complete()
91 }
131 }
92− Command::Abort(opts) => {
132+ Command::Migration(MigrationCommand::Abort(opts)) | Command::Abort(opts) => {
93 let mut reshape = reshape_from_connection_options(&opts)?;
133 let mut reshape = reshape_from_connection_options(&opts)?;
94 reshape.abort()
134 reshape.abort()
95 }
135 }
96− Command::GenerateSchemaQuery(find_migrations_options) => {
136+ Command::SchemaQuery(opts) | Command::GenerateSchemaQuery(opts) => {
97− let migrations = find_migrations(&find_migrations_options)?;
137+ let migrations = find_migrations(&opts)?;
98 let query = migrations
138 let query = migrations
99 .last()
139 .last()
100 .map(|migration| reshape::schema_query_for_migration(&migration.name));
140 .map(|migration| reshape::schema_query_for_migration(&migration.name));
@@ -106,20 +146,42 @@ fn run(opts: Opts) -> anyhow::Result<()> {
106}
146}
107
147
108fn reshape_from_connection_options(opts: &ConnectionOptions) -> anyhow::Result<Reshape> {
148fn reshape_from_connection_options(opts: &ConnectionOptions) -> anyhow::Result<Reshape> {
149+ // Load environment variables from .env file if it exists
150+ dotenv::dotenv().ok();
151+
109− let env_url = std::env::var("POSTGRES_URL").ok();
152+ let url_env = std::env::var("DB_URL").ok();
110− let url = env_url.as_ref().or(opts.url.as_ref());
153+ let url = url_env.as_ref().or_else(|| opts.url.as_ref());
111
154
112− match url {
155+ // Use the connection URL if it has been set
156+ if let Some(url) = url {
113− Some(url) => Reshape::new(&url),
157+ return Reshape::new(url);
114− None => Reshape::new_with_options(&opts.host, opts.port, &opts.username, &opts.password),
115 }
158 }
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)
116}
178}
117
179
118fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration>> {
180fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration>> {
119 let search_paths = opts
181 let search_paths = opts
120 .dirs
182 .dirs
121 .iter()
183 .iter()
122− .map(|path| Path::new(path))
184+ .map(Path::new)
123 // Filter out all directories that don't exist
185 // Filter out all directories that don't exist
124 .filter(|path| path.exists());
186 .filter(|path| path.exists());
125
187
@@ -134,7 +196,13 @@ fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration
134 }
196 }
135
197
136 // Sort all files by their file names (without extension)
198 // Sort all files by their file names (without extension)
137− file_paths.sort_unstable_by_key(|path| path.as_path().file_stem().unwrap().to_os_string());
199+ // The files are sorted naturally, e.g. "1_test_migration" < "10_test_migration"
200+ file_paths.sort_unstable_by(|path1, path2| {
201+ let file1 = path1.as_path().file_stem().unwrap().to_str().unwrap();
202+ let file2 = path2.as_path().file_stem().unwrap().to_str().unwrap();
203+
204+ lexical_sort::natural_cmp(file1, file2)
205+ });
138
206
139 file_paths
207 file_paths
140 .iter()
208 .iter()
@@ -150,7 +218,10 @@ fn find_migrations(opts: &FindMigrationsOptions) -> anyhow::Result<Vec<Migration
150 .map(|result| {
218 .map(|result| {
151 result.and_then(|(path, data)| {
219 result.and_then(|(path, data)| {
152 let extension = path.extension().and_then(|ext| ext.to_str()).unwrap();
220 let extension = path.extension().and_then(|ext| ext.to_str()).unwrap();
221+ let file_migration =
153− let file_migration = decode_migration_file(&data, extension)?;
222+ decode_migration_file(&data, extension).with_context(|| {
223+ format!("failed to parse migration file {}", path.display())
224+ })?;
154
225
155 let file_name = path.file_stem().and_then(|name| name.to_str()).unwrap();
226 let file_name = path.file_stem().and_then(|name| name.to_str()).unwrap();
156 Ok(Migration {
227 Ok(Migration {
src/migrations/add_column.rs+313−107
@@ -1,16 +1,40 @@
1−use super::{common, Action, Column, Context};
1+use super::{common, Action, Column, MigrationContext};
2+use crate::{
3+ db::{Conn, Transaction},
2−use crate::{db::Conn, schema::Schema};
4+ schema::Schema,
5+};
6+use anyhow::{bail, Context};
3use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
4
8
5#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
6pub struct AddColumn {
10pub struct AddColumn {
7 pub table: String,
11 pub table: String,
8− pub up: Option<String>,
9 pub column: Column,
12 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+ },
10}
25}
11
26
12impl AddColumn {
27impl AddColumn {
28+ fn temp_column_name(&self, ctx: &MigrationContext) -> String {
29+ format!(
30+ "{}_temp_column_{}_{}",
31+ ctx.prefix(),
32+ self.table,
33+ self.column.name,
34+ )
35+ }
36+
13− fn trigger_name(&self, ctx: &Context) -> String {
37+ fn trigger_name(&self, ctx: &MigrationContext) -> String {
14 format!(
38 format!(
15 "{}_add_column_{}_{}",
39 "{}_add_column_{}_{}",
16 ctx.prefix(),
40 ctx.prefix(),
@@ -19,7 +43,16 @@ impl AddColumn {
19 )
43 )
20 }
44 }
21
45
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+
22− fn not_null_constraint_name(&self, ctx: &Context) -> String {
55+ fn not_null_constraint_name(&self, ctx: &MigrationContext) -> String {
23 format!(
56 format!(
24 "{}_add_column_not_null_{}_{}",
57 "{}_add_column_not_null_{}_{}",
25 ctx.prefix(),
58 ctx.prefix(),
@@ -38,11 +71,17 @@ impl Action for AddColumn {
38 )
71 )
39 }
72 }
40
73
41− fn run(&self, ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()> {
74+ fn run(
75+ &self,
76+ ctx: &MigrationContext,
77+ db: &mut dyn Conn,
78+ schema: &Schema,
79+ ) -> anyhow::Result<()> {
42 let table = schema.get_table(db, &self.table)?;
80 let table = schema.get_table(db, &self.table)?;
81+ let temp_column_name = self.temp_column_name(ctx);
43
82
44 let mut definition_parts = vec![
83 let mut definition_parts = vec![
45− self.column.name.to_string(),
84+ format!("\"{}\"", temp_column_name.to_string()),
46 self.column.data_type.to_string(),
85 self.column.data_type.to_string(),
47 ];
86 ];
48
87
@@ -58,63 +97,198 @@ impl Action for AddColumn {
58
97
59 // Add column as NOT NULL
98 // Add column as NOT NULL
60 let query = format!(
99 let query = format!(
61− "
100+ r#"
62− ALTER TABLE {table}
101+ ALTER TABLE "{table}"
63 ADD COLUMN IF NOT EXISTS {definition};
102 ADD COLUMN IF NOT EXISTS {definition};
64− ",
103+ "#,
65 table = self.table,
104 table = self.table,
66 definition = definition_parts.join(" "),
105 definition = definition_parts.join(" "),
67 );
106 );
68− db.run(&query)?;
107+ db.run(&query).context("failed to add column")?;
108+
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();
69
121
70 if let Some(up) = &self.up {
122 if let Some(up) = &self.up {
71− let table = schema.get_table(db, &self.table)?;
123+ if let Transformation::Simple(up) = up {
72−
73− let declarations: Vec<String> = table
74− .columns
75− .iter()
76− .map(|column| {
77− format!(
78− "{alias} public.{table}.{real_name}%TYPE := NEW.{real_name};",
79− table = table.real_name,
80− alias = column.name,
81− real_name = column.real_name,
82− )
83− })
84− .collect();
85−
86− // Add triggers to fill in values as they are inserted/updated
124+ // Add triggers to fill in values as they are inserted/updated
87− let query = format!(
125+ let query = format!(
88− "
126+ r#"
89− CREATE OR REPLACE FUNCTION {trigger_name}()
127+ CREATE OR REPLACE FUNCTION {trigger_name}()
90− RETURNS TRIGGER AS $$
128+ RETURNS TRIGGER AS $$
91− BEGIN
129+ BEGIN
92− IF reshape.is_old_schema() THEN
130+ IF NOT reshape.is_new_schema() THEN
93− DECLARE
131+ DECLARE
94− {declarations}
132+ {declarations}
95− BEGIN
133+ BEGIN
96− NEW.{column_name} = {up};
134+ NEW."{temp_column_name}" = {up};
97− END;
135+ END;
98− END IF;
136+ END IF;
99− RETURN NEW;
137+ RETURN NEW;
100− END
138+ END
101− $$ language 'plpgsql';
139+ $$ language 'plpgsql';
102−
140+
103− DROP TRIGGER IF EXISTS {trigger_name} ON {table};
141+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
104− CREATE TRIGGER {trigger_name} BEFORE UPDATE OR INSERT ON {table} FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
142+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
105− ",
143+ "#,
106− column_name = self.column.name,
144+ temp_column_name = temp_column_name,
107− trigger_name = self.trigger_name(ctx),
145+ trigger_name = self.trigger_name(ctx),
108− up = up,
146+ up = up,
109− table = self.table,
147+ table = self.table,
110− declarations = declarations.join("\n"),
148+ declarations = declarations.join("\n"),
111− );
149+ );
112− db.run(&query)?;
150+ db.run(&query).context("failed to create up trigger")?;
113− }
151+
152+ // Backfill values in batches
153+ common::batch_touch_rows(db, &table.real_name, Some(&temp_column_name))
154+ .context("failed to batch update existing rows")?;
155+ }
156+
157+ if let Transformation::Update {
158+ table: from_table,
159+ value,
160+ r#where,
161+ } = up
162+ {
163+ let existing_schema_name = match &ctx.existing_schema_name {
164+ Some(name) => name,
165+ None => bail!("can't use update without previous migration"),
166+ };
167+
168+ let from_table = schema.get_table(db, &from_table)?;
169+
170+ let from_table_assignments: Vec<String> = from_table
171+ .columns
172+ .iter()
173+ .map(|column| {
174+ format!(
175+ "{table}.{alias} = NEW.{real_name};",
176+ table = from_table.name,
177+ alias = column.name,
178+ real_name = column.real_name,
179+ )
180+ })
181+ .collect();
114
182
183+ // Add triggers to fill in values as they are inserted/updated
184+ let query = format!(
185+ r#"
186+ CREATE OR REPLACE FUNCTION {trigger_name}()
187+ RETURNS TRIGGER AS $$
188+ #variable_conflict use_variable
189+ BEGIN
190+ IF NOT reshape.is_new_schema() THEN
191+ DECLARE
192+ {from_table} migration_{existing_schema_name}.{from_table}%ROWTYPE;
193+ BEGIN
194+ {assignments}
195+
196+ -- Don't trigger reverse trigger when making this update
197+ perform set_config('reshape.disable_triggers', 'TRUE', TRUE);
198+
199+ UPDATE public."{changed_table_real}"
200+ SET "{temp_column_name}" = {value}
201+ WHERE {where};
202+
203+ perform set_config('reshape.disable_triggers', '', TRUE);
204+ END;
205+ END IF;
206+ RETURN NEW;
207+ END
208+ $$ language 'plpgsql';
209+
210+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{from_table_real}";
211+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{from_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
212+ "#,
213+ assignments = from_table_assignments.join("\n"),
214+ changed_table_real = table.real_name,
215+ from_table = from_table.name,
216+ from_table_real = from_table.real_name,
217+ trigger_name = self.trigger_name(ctx),
218+ // declarations = from_table_declarations.join("\n"),
219+ temp_column_name = temp_column_name,
220+ );
221+ db.run(&query).context("failed to create up trigger")?;
222+
223+ let from_table_columns = from_table
224+ .columns
225+ .iter()
226+ .map(|column| format!("{} as {}", column.real_name, column.name))
227+ .collect::<Vec<String>>()
228+ .join(", ");
229+
230+ let changed_table_assignments: Vec<String> = table
231+ .columns
232+ .iter()
233+ .map(|column| {
234+ format!(
235+ "{table}.{alias} := NEW.{real_name};",
236+ table = table.name,
237+ alias = column.name,
238+ real_name = column.real_name,
239+ )
240+ })
241+ .collect();
242+
243+ // Add triggers to fill in values as they are inserted/updated
244+ let query = format!(
245+ r#"
246+ CREATE OR REPLACE FUNCTION {trigger_name}()
247+ RETURNS TRIGGER AS $$
248+ #variable_conflict use_variable
249+ BEGIN
250+ IF NOT reshape.is_new_schema() AND NOT current_setting('reshape.disable_triggers', TRUE) = 'TRUE' THEN
251+ DECLARE
252+ {changed_table} migration_{existing_schema_name}.{changed_table}%ROWTYPE;
253+ __temp_row migration_{existing_schema_name}.{from_table}%ROWTYPE;
254+ BEGIN
255+ {changed_table_assignments}
256+
257+ SELECT {from_table_columns}
258+ INTO __temp_row
259+ FROM migration_{existing_schema_name}.{from_table} {from_table}
260+ WHERE {where};
261+
262+ DECLARE
263+ {from_table} migration_{existing_schema_name}.{from_table}%ROWTYPE;
264+ BEGIN
265+ {from_table} = __temp_row;
266+ NEW.{temp_column_name} = {value};
267+ END;
268+ END;
269+ END IF;
270+ RETURN NEW;
271+ END
272+ $$ language 'plpgsql';
273+
274+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{changed_table_real}";
275+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{changed_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
276+ "#,
277+ changed_table_assignments = changed_table_assignments.join("\n"),
278+ changed_table_real = table.real_name,
279+ changed_table = table.name,
280+ from_table = from_table.name,
281+ trigger_name = self.reverse_trigger_name(ctx),
282+ temp_column_name = temp_column_name,
283+ // declarations = declarations.join("\n"),
284+ );
285+ db.run(&query)
286+ .context("failed to create reverse up trigger")?;
287+
115− // Backfill values in batches
288+ // Backfill values in batches by touching the from table
116− if self.up.is_some() {
117− common::batch_touch_rows(db, &table.real_name, &self.column.name)?;
289+ common::batch_touch_rows(db, &from_table.real_name, None)
290+ .context("failed to batch update existing rows")?;
291+ }
118 }
292 }
119
293
120 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
294 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
@@ -123,102 +297,134 @@ impl Action for AddColumn {
123 // Thanks to this, we can set the full column as NOT NULL later with minimal locking.
297 // Thanks to this, we can set the full column as NOT NULL later with minimal locking.
124 if !self.column.nullable {
298 if !self.column.nullable {
125 let query = format!(
299 let query = format!(
126− "
300+ r#"
127− ALTER TABLE {table}
301+ ALTER TABLE "{table}"
128− ADD CONSTRAINT {constraint_name}
302+ ADD CONSTRAINT "{constraint_name}"
129− CHECK ({column} IS NOT NULL) NOT VALID
303+ CHECK ("{column}" IS NOT NULL) NOT VALID
130− ",
304+ "#,
131 table = self.table,
305 table = self.table,
132− constraint_name = self.not_null_constraint_name(&ctx),
306+ constraint_name = self.not_null_constraint_name(ctx),
133− column = self.column.name,
307+ column = temp_column_name,
134 );
308 );
135− db.run(&query)?;
309+ db.run(&query)
310+ .context("failed to add NOT NULL constraint")?;
136 }
311 }
137
312
138 Ok(())
313 Ok(())
139 }
314 }
140
315
141− fn complete(&self, ctx: &Context, db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
316+ fn complete<'a>(
317+ &self,
318+ ctx: &MigrationContext,
319+ db: &'a mut dyn Conn,
320+ ) -> anyhow::Result<Option<Transaction<'a>>> {
321+ let mut transaction = db.transaction().context("failed to create transaction")?;
322+
142 // Remove triggers and procedures
323 // Remove triggers and procedures
143 let query = format!(
324 let query = format!(
144− "
325+ r#"
145− DROP TRIGGER IF EXISTS {trigger_name} ON {table};
326+ DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
146− DROP FUNCTION IF EXISTS {trigger_name};
327+ DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
147− ",
328+ "#,
148− table = self.table,
149 trigger_name = self.trigger_name(ctx),
329 trigger_name = self.trigger_name(ctx),
330+ reverse_trigger_name = self.reverse_trigger_name(ctx),
150 );
331 );
332+ transaction
151− db.run(&query)?;
333+ .run(&query)
334+ .context("failed to drop up trigger")?;
152
335
153 // Update column to be NOT NULL if necessary
336 // Update column to be NOT NULL if necessary
154 if !self.column.nullable {
337 if !self.column.nullable {
155 // Validate the temporary constraint (should always be valid).
338 // Validate the temporary constraint (should always be valid).
156 // This performs a sequential scan but does not take an exclusive lock.
339 // This performs a sequential scan but does not take an exclusive lock.
157 let query = format!(
340 let query = format!(
158− "
341+ r#"
159− ALTER TABLE {table}
342+ ALTER TABLE "{table}"
160− VALIDATE CONSTRAINT {constraint_name}
343+ VALIDATE CONSTRAINT "{constraint_name}"
161− ",
344+ "#,
162 table = self.table,
345 table = self.table,
163 constraint_name = self.not_null_constraint_name(ctx),
346 constraint_name = self.not_null_constraint_name(ctx),
164 );
347 );
348+ transaction
165− db.run(&query)?;
349+ .run(&query)
350+ .context("failed to validate NOT NULL constraint")?;
166
351
167 // Update the column to be NOT NULL.
352 // Update the column to be NOT NULL.
168 // This requires an exclusive lock but since PG 12 it can check
353 // This requires an exclusive lock but since PG 12 it can check
169 // the existing constraint for correctness which makes the lock short-lived.
354 // the existing constraint for correctness which makes the lock short-lived.
170 // Source: https://dba.stackexchange.com/a/268128
355 // Source: https://dba.stackexchange.com/a/268128
171 let query = format!(
356 let query = format!(
172− "
357+ r#"
173− ALTER TABLE {table}
358+ ALTER TABLE "{table}"
174− ALTER COLUMN {column} SET NOT NULL
359+ ALTER COLUMN "{column}" SET NOT NULL
175− ",
360+ "#,
176 table = self.table,
361 table = self.table,
177− column = self.column.name,
362+ column = self.temp_column_name(ctx),
178 );
363 );
364+ transaction
179− db.run(&query)?;
365+ .run(&query)
366+ .context("failed to set column as NOT NULL")?;
180
367
181 // Drop the temporary constraint
368 // Drop the temporary constraint
182 let query = format!(
369 let query = format!(
183− "
370+ r#"
184− ALTER TABLE {table}
371+ ALTER TABLE "{table}"
185− DROP CONSTRAINT {constraint_name}
372+ DROP CONSTRAINT "{constraint_name}"
186− ",
373+ "#,
187 table = self.table,
374 table = self.table,
188 constraint_name = self.not_null_constraint_name(ctx),
375 constraint_name = self.not_null_constraint_name(ctx),
189 );
376 );
377+ transaction
190− db.run(&query)?;
378+ .run(&query)
379+ .context("failed to drop NOT NULL constraint")?;
191 }
380 }
192
381
193− Ok(())
382+ // Rename the temporary column to its real name
383+ transaction
384+ .run(&format!(
385+ r#"
386+ ALTER TABLE "{table}"
387+ RENAME COLUMN "{temp_column_name}" TO "{column_name}"
388+ "#,
389+ table = self.table,
390+ temp_column_name = self.temp_column_name(ctx),
391+ column_name = self.column.name,
392+ ))
393+ .context("failed to rename column to final name")?;
394+
395+ Ok(Some(transaction))
194 }
396 }
195
397
196− fn update_schema(&self, _ctx: &Context, _schema: &mut Schema) -> anyhow::Result<()> {
398+ fn update_schema(&self, ctx: &MigrationContext, schema: &mut Schema) {
197− Ok(())
399+ schema.change_table(&self.table, |table_changes| {
400+ table_changes.change_column(&self.column.name, |column_changes| {
401+ column_changes.set_column(&self.temp_column_name(ctx));
402+ })
403+ });
198 }
404 }
199
405
200− fn abort(&self, ctx: &Context, db: &mut dyn Conn) -> anyhow::Result<()> {
406+ fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
201− // Remove triggers and procedures
407+ // Remove column
202 let query = format!(
408 let query = format!(
203− "
409+ r#"
204− DROP TRIGGER IF EXISTS {trigger_name} ON {table};
410+ ALTER TABLE "{table}"
205− DROP FUNCTION IF EXISTS {trigger_name};
411+ DROP COLUMN IF EXISTS "{column}"
206− ",
412+ "#,
207 table = self.table,
413 table = self.table,
208− trigger_name = self.trigger_name(ctx),
414+ column = self.temp_column_name(ctx),
209 );
415 );
210− db.run(&query)?;
416+ db.run(&query).context("failed to drop column")?;
211
417
212− // Remove column
418+ // Remove triggers and procedures
213 let query = format!(
419 let query = format!(
214− "
420+ r#"
215− ALTER TABLE {table}
421+ DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
216− DROP COLUMN IF EXISTS {column}
422+ DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
217− ",
423+ "#,
218− table = self.table,
424+ trigger_name = self.trigger_name(ctx),
219− column = self.column.name,
425+ reverse_trigger_name = self.reverse_trigger_name(ctx),
220 );
426 );
221− db.run(&query)?;
427+ db.run(&query).context("failed to drop up trigger")?;
222
428
223 Ok(())
429 Ok(())
224 }
430 }
src/migrations/add_foreign_key.rsnew file+122
@@ -0,0 +1,122 @@
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+54−23
@@ -1,57 +1,88 @@
1−use super::{Action, Context};
1+use super::{Action, MigrationContext};
2+use crate::{
3+ db::{Conn, Transaction},
2−use crate::{db::Conn, schema::Schema};
4+ schema::Schema,
5+};
6+use anyhow::Context;
3use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
4
8
5#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
6pub struct AddIndex {
10pub struct AddIndex {
7 pub table: String,
11 pub table: String,
12+ pub index: Index,
13+}
14+
15+#[derive(Serialize, Deserialize, Clone, Debug)]
16+pub struct Index {
8 pub name: String,
17 pub name: String,
9 pub columns: Vec<String>,
18 pub columns: Vec<String>,
19+ #[serde(default)]
20+ pub unique: bool,
21+ #[serde(rename = "type")]
22+ pub index_type: Option<String>,
10}
23}
11
24
12#[typetag::serde(name = "add_index")]
25#[typetag::serde(name = "add_index")]
13impl Action for AddIndex {
26impl Action for AddIndex {
14 fn describe(&self) -> String {
27 fn describe(&self) -> String {
28+ format!(
15− format!("Adding index \"{}\" to table \"{}\"", self.name, self.table)
29+ "Adding index \"{}\" to table \"{}\"",
30+ self.index.name, self.table
31+ )
16 }
32 }
17
33
18− fn run(&self, _ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()> {
34+ fn run(
35+ &self,
36+ _ctx: &MigrationContext,
37+ db: &mut dyn Conn,
38+ schema: &Schema,
39+ ) -> anyhow::Result<()> {
19 let table = schema.get_table(db, &self.table)?;
40 let table = schema.get_table(db, &self.table)?;
20
41
21 let column_real_names: Vec<String> = table
42 let column_real_names: Vec<String> = table
22 .columns
43 .columns
23 .iter()
44 .iter()
24− .filter(|column| self.columns.contains(&column.name))
45+ .filter(|column| self.index.columns.contains(&column.name))
25− .map(|column| column.real_name.to_string())
46+ .map(|column| format!("\"{}\"", column.real_name))
26 .collect();
47 .collect();
27
48
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+
28 db.run(&format!(
56 db.run(&format!(
29− "
57+ r#"
30− CREATE INDEX CONCURRENTLY {name} ON {table} ({columns})
58+ CREATE {unique} INDEX CONCURRENTLY "{name}" ON "{table}" {index_type_def} ({columns})
31− ",
59+ "#,
32− name = self.name,
60+ name = self.index.name,
33 table = self.table,
61 table = self.table,
34 columns = column_real_names.join(", "),
62 columns = column_real_names.join(", "),
35− ))?;
63+ ))
64+ .context("failed to create index")?;
36 Ok(())
65 Ok(())
37 }
66 }
38
67
39− fn complete(&self, _ctx: &Context, _db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
68+ fn complete<'a>(
69+ &self,
70+ _ctx: &MigrationContext,
71+ _db: &'a mut dyn Conn,
72+ ) -> anyhow::Result<Option<Transaction<'a>>> {
40− Ok(())
73+ Ok(None)
41 }
74 }
42
75
43− fn update_schema(&self, _ctx: &Context, _schema: &mut Schema) -> anyhow::Result<()> {
76+ fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
44− Ok(())
45− }
46
77
47− fn abort(&self, _ctx: &Context, db: &mut dyn Conn) -> anyhow::Result<()> {
78+ fn abort(&self, _ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
48 db.run(&format!(
79 db.run(&format!(
49− "
80+ r#"
50− DROP INDEX {name} ON {table}
81+ DROP INDEX CONCURRENTLY IF EXISTS "{name}"
51− ",
82+ "#,
52− name = self.name,
83+ name = self.index.name,
53− table = self.table,
84+ ))
54− ))?;
85+ .context("failed to drop index")?;
55 Ok(())
86 Ok(())
56 }
87 }
57}
88}
src/migrations/alter_column.rs+321−208
@@ -1,6 +1,10 @@
1−use super::{Action, Context};
1+use super::{Action, MigrationContext};
2+use crate::{
3+ db::{Conn, Transaction},
2−use crate::{db::Conn, migrations::common, schema::Schema};
4+ migrations::common,
5+ schema::Schema,
6+};
3−use anyhow::anyhow;
7+use anyhow::{anyhow, Context};
4use serde::{Deserialize, Serialize};
8use serde::{Deserialize, Serialize};
5
9
6#[derive(Serialize, Deserialize, Debug)]
10#[derive(Serialize, Deserialize, Debug)]
@@ -9,63 +13,31 @@ pub struct AlterColumn {
9 pub column: String,
13 pub column: String,
10 pub up: Option<String>,
14 pub up: Option<String>,
11 pub down: Option<String>,
15 pub down: Option<String>,
16+ #[serde(default)]
12 pub changes: ColumnChanges,
17 pub changes: ColumnChanges,
13}
18}
14
19
15−#[derive(Serialize, Deserialize, Debug)]
20+#[derive(Serialize, Deserialize, Default, Debug)]
16pub struct ColumnChanges {
21pub struct ColumnChanges {
17 pub name: Option<String>,
22 pub name: Option<String>,
18 #[serde(rename = "type")]
23 #[serde(rename = "type")]
19 pub data_type: Option<String>,
24 pub data_type: Option<String>,
20 pub nullable: Option<bool>,
25 pub nullable: Option<bool>,
26+ pub default: Option<String>,
21}
27}
22
28
23−impl AlterColumn {
24− fn temporary_column_name(&self, ctx: &Context) -> String {
25− format!("{}_new_{}", ctx.prefix(), self.column)
26− }
27−
28− fn up_trigger_name(&self, ctx: &Context) -> String {
29− format!(
30− "{}_alter_column_up_trigger_{}_{}",
31− ctx.prefix(),
32− self.table,
33− self.column
34− )
35− }
36−
37− fn down_trigger_name(&self, ctx: &Context) -> String {
38− format!(
39− "{}_alter_column_down_trigger_{}_{}",
40− ctx.prefix_inverse(),
41− self.table,
42− self.column
43− )
44− }
45−
46− fn not_null_constraint_name(&self, ctx: &Context) -> String {
47− format!(
48− "{}_alter_column_temporary_not_null_{}_{}",
49− ctx.prefix(),
50− self.table,
51− self.column
52− )
53− }
54−
55− fn can_short_circuit(&self) -> bool {
56− self.changes.name.is_some()
57− && self.changes.data_type.is_none()
58− && self.changes.nullable.is_none()
59− }
60−}
61−
62−#[typetag::serde(name = "uppercase_column")]
29+#[typetag::serde(name = "alter_column")]
63impl Action for AlterColumn {
30impl Action for AlterColumn {
64 fn describe(&self) -> String {
31 fn describe(&self) -> String {
65 format!("Altering column \"{}\" on \"{}\"", self.column, self.table)
32 format!("Altering column \"{}\" on \"{}\"", self.column, self.table)
66 }
33 }
67
34
68− fn run(&self, ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()> {
35+ fn run(
36+ &self,
37+ ctx: &MigrationContext,
38+ db: &mut dyn Conn,
39+ schema: &Schema,
40+ ) -> anyhow::Result<()> {
69 // If we are only changing the name of a column, we don't have to do anything at this stage
41 // If we are only changing the name of a column, we don't have to do anything at this stage
70 // We'll set the new schema to point to the old column. When the migration is completed,
42 // We'll set the new schema to point to the old column. When the migration is completed,
71 // we rename the actual column.
43 // we rename the actual column.
@@ -73,37 +45,44 @@ impl Action for AlterColumn {
73 return Ok(());
45 return Ok(());
74 }
46 }
75
47
76− // If we couldn't short circuit, then we need up and down functions
77− let (up, down) = match (&self.up, &self.down) {
78− (Some(up), Some(down)) => (up, down),
79− _ => return Err(anyhow!("missing up or down values")),
80− };
81−
82 let table = schema.get_table(db, &self.table)?;
48 let table = schema.get_table(db, &self.table)?;
83
49
84 let column = table
50 let column = table
85− .columns
86− .iter()
87− .find(|column| column.name == self.column)
51+ .get_column(&self.column)
88− .ok_or_else(|| anyhow!("no such column exists"))?;
52+ .ok_or_else(|| anyhow!("no such column {} exists", self.column))?;
53+
54+ let temporary_column_name = self.temporary_column_name(ctx);
55+ let temporary_column_type = self.changes.data_type.as_ref().unwrap_or(&column.data_type);
56+
57+ // Add temporary, nullable column
58+ let mut temp_column_definition_parts: Vec<&str> =
59+ vec![&temporary_column_name, temporary_column_type];
89
60
90− let temporary_column_type = self
61+ // Use either new default value or existing one if one exists
62+ let default_value = self
91 .changes
63 .changes
92− .data_type
64+ .default
93 .as_ref()
65 .as_ref()
94− .unwrap_or_else(|| &column.data_type);
66+ .or_else(|| column.default.as_ref());
67+ if let Some(default) = default_value {
68+ temp_column_definition_parts.push("DEFAULT");
69+ temp_column_definition_parts.push(default);
70+ }
95
71
96− // Add temporary, nullable column
97 let query = format!(
72 let query = format!(
98− "
73+ r#"
99− ALTER TABLE {table}
74+ ALTER TABLE "{table}"
100− ADD COLUMN IF NOT EXISTS {temp_column} {temp_column_type};
75+ ADD COLUMN IF NOT EXISTS {temp_column_definition}
101− ",
76+ "#,
102 table = self.table,
77 table = self.table,
103− temp_column = self.temporary_column_name(ctx),
78+ temp_column_definition = temp_column_definition_parts.join(" "),
104− temp_column_type = temporary_column_type,
105 );
79 );
106− db.run(&query)?;
80+ db.run(&query).context("failed to add temporary column")?;
81+
82+ // If up or down wasn't provided, we default to simply moving the value over.
83+ // This is the correct behaviour for example when only changing the default value.
84+ let up = self.up.as_ref().unwrap_or(&self.column);
85+ let down = self.down.as_ref().unwrap_or(&self.column);
107
86
108 let declarations: Vec<String> = table
87 let declarations: Vec<String> = table
109 .columns
88 .columns
@@ -119,45 +98,44 @@ impl Action for AlterColumn {
119 })
98 })
120 .collect();
99 .collect();
121
100
122− // Add triggers to fill in values as they are inserted/updated
123 let query = format!(
101 let query = format!(
124− "
102+ r#"
125− CREATE OR REPLACE FUNCTION {up_trigger}()
103+ CREATE OR REPLACE FUNCTION {up_trigger}()
126− RETURNS TRIGGER AS $$
104+ RETURNS TRIGGER AS $$
127− BEGIN
105+ BEGIN
128− IF reshape.is_old_schema() THEN
106+ IF NOT reshape.is_new_schema() THEN
129− DECLARE
107+ DECLARE
130− {declarations}
108+ {declarations}
131− {existing_column} public.{table}.{existing_column_real}%TYPE := NEW.{existing_column_real};
109+ {existing_column} public.{table}.{existing_column_real}%TYPE := NEW.{existing_column_real};
132− BEGIN
110+ BEGIN
133− NEW.{temp_column} = {up};
111+ NEW.{temp_column} = {up};
134− END;
112+ END;
135− END IF;
113+ END IF;
136− RETURN NEW;
114+ RETURN NEW;
137− END
115+ END
138− $$ language 'plpgsql';
116+ $$ language 'plpgsql';
139−
117+
140− DROP TRIGGER IF EXISTS {up_trigger} ON {table};
118+ DROP TRIGGER IF EXISTS "{up_trigger}" ON "{table}";
141− CREATE TRIGGER {up_trigger} BEFORE INSERT OR UPDATE ON {table} FOR EACH ROW EXECUTE PROCEDURE {up_trigger}();
119+ CREATE TRIGGER "{up_trigger}" BEFORE INSERT OR UPDATE ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {up_trigger}();
142−
120+
143− CREATE OR REPLACE FUNCTION {down_trigger}()
121+ CREATE OR REPLACE FUNCTION {down_trigger}()
144− RETURNS TRIGGER AS $$
122+ RETURNS TRIGGER AS $$
145− BEGIN
123+ BEGIN
146− IF NOT reshape.is_old_schema() THEN
124+ IF reshape.is_new_schema() THEN
147− DECLARE
125+ DECLARE
148− {declarations}
126+ {declarations}
149− {existing_column} public.{table}.{temp_column}%TYPE := NEW.{temp_column};
127+ {existing_column} public.{table}.{temp_column}%TYPE := NEW.{temp_column};
150− BEGIN
128+ BEGIN
151− NEW.{existing_column_real} = {down};
129+ NEW.{existing_column_real} = {down};
152− END;
130+ END;
153− END IF;
131+ END IF;
154− RETURN NEW;
132+ RETURN NEW;
155− END
133+ END
156− $$ language 'plpgsql';
134+ $$ language 'plpgsql';
157−
135+
158− DROP TRIGGER IF EXISTS {down_trigger} ON {table};
136+ DROP TRIGGER IF EXISTS "{down_trigger}" ON "{table}";
159− CREATE TRIGGER {down_trigger} BEFORE INSERT OR UPDATE ON {table} FOR EACH ROW EXECUTE PROCEDURE {down_trigger}();
137+ CREATE TRIGGER "{down_trigger}" BEFORE INSERT OR UPDATE ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {down_trigger}();
160− ",
138+ "#,
161 existing_column = &self.column,
139 existing_column = &self.column,
162 existing_column_real = column.real_name,
140 existing_column_real = column.real_name,
163 temp_column = self.temporary_column_name(ctx),
141 temp_column = self.temporary_column_name(ctx),
@@ -168,180 +146,315 @@ impl Action for AlterColumn {
168 down_trigger = self.down_trigger_name(ctx),
146 down_trigger = self.down_trigger_name(ctx),
169 declarations = declarations.join("\n"),
147 declarations = declarations.join("\n"),
170 );
148 );
171− db.run(&query)?;
149+ db.run(&query)
150+ .context("failed to create up and down triggers")?;
172
151
173 // Backfill values in batches by touching the previous column
152 // Backfill values in batches by touching the previous column
174− common::batch_touch_rows(db, &table.real_name, &column.real_name)?;
153+ common::batch_touch_rows(db, &table.real_name, Some(&column.real_name))
154+ .context("failed to batch update existing rows")?;
155+
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+ }
175
185
176 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
186 // Add a temporary NOT NULL constraint if the column shouldn't be nullable.
177 // This constraint is set as NOT VALID so it doesn't apply to existing rows and
187 // This constraint is set as NOT VALID so it doesn't apply to existing rows and
178 // the existing rows don't need to be scanned under an exclusive lock.
188 // the existing rows don't need to be scanned under an exclusive lock.
179 // Thanks to this, we can set the full column as NOT NULL later with minimal locking.
189 // Thanks to this, we can set the full column as NOT NULL later with minimal locking.
180− if !column.nullable {
190+ if !self.changes.nullable.unwrap_or(column.nullable) {
181 let query = format!(
191 let query = format!(
182− "
192+ r#"
183− ALTER TABLE {table}
193+ ALTER TABLE "{table}"
184− ADD CONSTRAINT {constraint_name}
194+ ADD CONSTRAINT "{constraint_name}"
185− CHECK ({column} IS NOT NULL) NOT VALID
195+ CHECK ("{column}" IS NOT NULL) NOT VALID
186− ",
196+ "#,
187 table = self.table,
197 table = self.table,
188 constraint_name = self.not_null_constraint_name(ctx),
198 constraint_name = self.not_null_constraint_name(ctx),
189 column = self.temporary_column_name(ctx),
199 column = self.temporary_column_name(ctx),
190 );
200 );
191− db.run(&query)?;
201+ db.run(&query)
202+ .context("failed to add NOT NULL constraint")?;
192 }
203 }
193
204
194 Ok(())
205 Ok(())
195 }
206 }
196
207
197− fn complete(&self, ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()> {
208+ fn complete<'a>(
209+ &self,
210+ ctx: &MigrationContext,
211+ db: &'a mut dyn Conn,
212+ ) -> anyhow::Result<Option<Transaction<'a>>> {
198 if self.can_short_circuit() {
213 if self.can_short_circuit() {
199 if let Some(new_name) = &self.changes.name {
214 if let Some(new_name) = &self.changes.name {
200 let query = format!(
215 let query = format!(
201− "
216+ r#"
202− ALTER TABLE {table}
217+ ALTER TABLE "{table}"
203− RENAME COLUMN {existing_name} TO {new_name}
218+ RENAME COLUMN "{existing_name}" TO "{new_name}"
204− ",
219+ "#,
205 table = self.table,
220 table = self.table,
206 existing_name = self.column,
221 existing_name = self.column,
207 new_name = new_name,
222 new_name = new_name,
208 );
223 );
209− db.run(&query)?;
224+ db.run(&query).context("failed to rename column")?;
210 }
225 }
211− return Ok(());
226+ return Ok(None);
212 }
227 }
213
228
214− let table = schema.get_table(db, &self.table)?;
215−
216− let column = table
217− .columns
218− .iter()
219− .find(|column| column.name == self.column)
220− .ok_or_else(|| anyhow!("no such column exists"))?;
221− let column_name = self.changes.name.as_deref().unwrap_or(&column.real_name);
222−
223− // Remove old column
224− let query = format!(
225− "
226− ALTER TABLE {} DROP COLUMN {} CASCADE
227− ",
228− self.table, column.real_name
229− );
230− db.run(&query)?;
231−
232− // Rename temporary column
233− let query = format!(
234− "
235− ALTER TABLE {table} RENAME COLUMN {temp_column} TO {name}
236− ",
237− table = self.table,
238− temp_column = self.temporary_column_name(ctx),
239− name = column_name,
240− );
241− db.run(&query)?;
242−
243− // Remove triggers and procedures
244− let query = format!(
245− "
246− DROP TRIGGER IF EXISTS {up_trigger} ON {table};
247− DROP FUNCTION IF EXISTS {up_trigger};
248−
249− DROP TRIGGER IF EXISTS {down_trigger} ON {table};
250− DROP FUNCTION IF EXISTS {down_trigger};
251− ",
252− table = self.table,
253− up_trigger = self.up_trigger_name(ctx),
254− down_trigger = self.down_trigger_name(ctx),
255− );
256− db.run(&query)?;
257−
258 // Update column to be NOT NULL if necessary
229 // Update column to be NOT NULL if necessary
259− if !column.nullable {
230+ let has_not_null_constraint = !db
231+ .query_with_params(
232+ "
233+ SELECT constraint_name
234+ FROM information_schema.constraint_column_usage
235+ WHERE constraint_name = $1
236+ ",
237+ &[&self.not_null_constraint_name(ctx)],
238+ )
239+ .context("failed to get any NOT NULL constraint")?
240+ .is_empty();
241+ if has_not_null_constraint {
260 // Validate the temporary constraint (should always be valid).
242 // Validate the temporary constraint (should always be valid).
261 // This performs a sequential scan but does not take an exclusive lock.
243 // This performs a sequential scan but does not take an exclusive lock.
262 let query = format!(
244 let query = format!(
263− "
245+ r#"
264− ALTER TABLE {table}
246+ ALTER TABLE "{table}"
265− VALIDATE CONSTRAINT {constraint_name}
247+ VALIDATE CONSTRAINT "{constraint_name}"
266− ",
248+ "#,
267 table = self.table,
249 table = self.table,
268 constraint_name = self.not_null_constraint_name(ctx),
250 constraint_name = self.not_null_constraint_name(ctx),
269 );
251 );
270− db.run(&query)?;
252+ db.run(&query)
253+ .context("failed to validate NOT NULL constraint")?;
271
254
272 // Update the column to be NOT NULL.
255 // Update the column to be NOT NULL.
273 // This requires an exclusive lock but since PG 12 it can check
256 // This requires an exclusive lock but since PG 12 it can check
274 // the existing constraint for correctness which makes the lock short-lived.
257 // the existing constraint for correctness which makes the lock short-lived.
275 // Source: https://dba.stackexchange.com/a/268128
258 // Source: https://dba.stackexchange.com/a/268128
276 let query = format!(
259 let query = format!(
277− "
260+ r#"
278− ALTER TABLE {table}
261+ ALTER TABLE "{table}"
279− ALTER COLUMN {column} SET NOT NULL
262+ ALTER COLUMN "{column}" SET NOT NULL
280− ",
263+ "#,
281 table = self.table,
264 table = self.table,
282− column = column_name,
265+ column = self.temporary_column_name(ctx),
283 );
266 );
284− db.run(&query)?;
267+ db.run(&query).context("failed to set column as NOT NULL")?;
285
268
286 // Drop the temporary constraint
269 // Drop the temporary constraint
287 let query = format!(
270 let query = format!(
288− "
271+ r#"
289− ALTER TABLE {table}
272+ ALTER TABLE "{table}"
290− DROP CONSTRAINT {constraint_name}
273+ DROP CONSTRAINT "{constraint_name}"
291− ",
274+ "#,
292 table = self.table,
275 table = self.table,
293 constraint_name = self.not_null_constraint_name(ctx),
276 constraint_name = self.not_null_constraint_name(ctx),
294 );
277 );
295− db.run(&query)?;
278+ db.run(&query)
279+ .context("failed to drop NOT NULL constraint")?;
296 }
280 }
297
281
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
325+ let query = format!(
326+ r#"
327+ ALTER TABLE "{table}" DROP COLUMN IF EXISTS "{column}" CASCADE
328+ "#,
329+ table = self.table,
330+ column = self.column,
331+ );
332+ db.run(&query).context("failed to drop old column")?;
333+
334+ // Rename temporary column
335+ let column_name = self.changes.name.as_deref().unwrap_or(&self.column);
336+ let query = format!(
337+ r#"
338+ ALTER TABLE "{table}" RENAME COLUMN "{temp_column}" TO "{name}"
339+ "#,
340+ table = self.table,
341+ temp_column = self.temporary_column_name(ctx),
342+ name = column_name,
343+ );
344+ db.run(&query)
345+ .context("failed to rename temporary column")?;
346+
347+ // Remove triggers and procedures
348+ let query = format!(
349+ r#"
350+ DROP TRIGGER IF EXISTS "{up_trigger}" ON "{table}";
351+ DROP FUNCTION IF EXISTS "{up_trigger}";
352+
353+ DROP TRIGGER IF EXISTS "{down_trigger}" ON "{table}";
354+ DROP FUNCTION IF EXISTS "{down_trigger}";
355+ "#,
356+ table = self.table,
357+ up_trigger = self.up_trigger_name(ctx),
358+ down_trigger = self.down_trigger_name(ctx),
359+ );
360+ db.run(&query)
361+ .context("failed to drop up and down triggers")?;
362+
298− Ok(())
363+ Ok(None)
299 }
364 }
300
365
301− fn update_schema(&self, ctx: &Context, schema: &mut Schema) -> anyhow::Result<()> {
366+ fn update_schema(&self, ctx: &MigrationContext, schema: &mut Schema) {
302 // If we are only changing the name of a column, we haven't created a temporary column
367 // If we are only changing the name of a column, we haven't created a temporary column
303 // Instead, we rename the schema column but point it to the old column
368 // Instead, we rename the schema column but point it to the old column
304 if self.can_short_circuit() {
369 if self.can_short_circuit() {
305 if let Some(new_name) = &self.changes.name {
370 if let Some(new_name) = &self.changes.name {
306− schema.set_column_alias(&self.table, &self.column, new_name);
371+ schema.change_table(&self.table, |table_changes| {
307− println!("Schema is now: {:?}", schema);
372+ table_changes.change_column(&self.column, |column_changes| {
373+ column_changes.set_name(new_name);
374+ });
375+ });
308 }
376 }
309
377
310− return Ok(());
378+ return;
311 }
379 }
312
380
381+ schema.change_table(&self.table, |table_changes| {
382+ table_changes.change_column(&self.column, |column_changes| {
313− schema.set_column_alias(&self.table, &self.temporary_column_name(ctx), &self.column);
383+ column_changes.set_column(&self.temporary_column_name(ctx));
314−
384+ });
315− Ok(())
385+ });
316 }
386 }
317
387
318− fn abort(&self, ctx: &Context, db: &mut dyn Conn) -> anyhow::Result<()> {
388+ fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
319− // Remove triggers and procedures
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);
320− let query = format!(
394+ db.query(&format!(
321− "
395+ r#"
322− DROP TRIGGER IF EXISTS {up_trigger} ON {table};
396+ DROP INDEX CONCURRENTLY IF EXISTS "{index_name}"
323− DROP FUNCTION IF EXISTS {up_trigger};
397+ "#,
398+ index_name = temp_index_name,
399+ ))?;
400+ }
324
401
325− DROP TRIGGER IF EXISTS {down_trigger} ON {table};
402+ // Drop temporary column
326− DROP FUNCTION IF EXISTS {down_trigger};
403+ let query = format!(
404+ r#"
405+ ALTER TABLE "{table}"
406+ DROP COLUMN IF EXISTS "{temp_column}";
327− ",
407+ "#,
328 table = self.table,
408 table = self.table,
329− up_trigger = self.up_trigger_name(ctx),
409+ temp_column = self.temporary_column_name(ctx),
330− down_trigger = self.down_trigger_name(ctx),
331 );
410 );
332− db.run(&query)?;
411+ db.run(&query).context("failed to drop temporary column")?;
333
412
334− // Drop temporary column
413+ // Remove triggers and procedures
335 let query = format!(
414 let query = format!(
336− "
415+ r#"
337− ALTER TABLE {table}
416+ DROP TRIGGER IF EXISTS "{up_trigger}" ON "{table}";
338− DROP COLUMN IF EXISTS {temp_column};
417+ DROP FUNCTION IF EXISTS "{up_trigger}";
418+
419+ DROP TRIGGER IF EXISTS "{down_trigger}" ON "{table}";
420+ DROP FUNCTION IF EXISTS "{down_trigger}";
339− ",
421+ "#,
340 table = self.table,
422 table = self.table,
341− temp_column = self.temporary_column_name(ctx),
423+ up_trigger = self.up_trigger_name(ctx),
424+ down_trigger = self.down_trigger_name(ctx),
342 );
425 );
343− db.run(&query)?;
426+ db.run(&query)
427+ .context("failed to drop up and down triggers")?;
344
428
345 Ok(())
429 Ok(())
346 }
430 }
347}
431}
432+
433+impl AlterColumn {
434+ fn temporary_column_name(&self, ctx: &MigrationContext) -> String {
435+ format!("{}_new_{}", ctx.prefix(), self.column)
436+ }
437+
438+ fn up_trigger_name(&self, ctx: &MigrationContext) -> String {
439+ format!("{}_alter_column_up_trigger", ctx.prefix())
440+ }
441+
442+ fn down_trigger_name(&self, ctx: &MigrationContext) -> String {
443+ format!("{}_alter_column_down_trigger", ctx.prefix_inverse())
444+ }
445+
446+ fn not_null_constraint_name(&self, ctx: &MigrationContext) -> String {
447+ format!("{}_alter_column_temporary", ctx.prefix())
448+ }
449+
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 {
455+ self.changes.name.is_some()
456+ && self.changes.data_type.is_none()
457+ && self.changes.nullable.is_none()
458+ && self.changes.default.is_none()
459+ }
460+}
src/migrations/common.rs+137−37
@@ -1,20 +1,17 @@
1+use anyhow::anyhow;
1use postgres::types::{FromSql, ToSql};
2use postgres::types::{FromSql, ToSql};
2use serde::{Deserialize, Serialize};
3use serde::{Deserialize, Serialize};
3
4
4use crate::db::Conn;
5use crate::db::Conn;
5
6
6−#[derive(Serialize, Deserialize, Debug)]
7+#[derive(Serialize, Deserialize, Clone, Debug)]
7pub struct Column {
8pub struct Column {
8 pub name: String,
9 pub name: String,
9−
10 #[serde(rename = "type")]
10 #[serde(rename = "type")]
11 pub data_type: String,
11 pub data_type: String,
12−
13 #[serde(default = "nullable_default")]
12 #[serde(default = "nullable_default")]
14 pub nullable: bool,
13 pub nullable: bool,
15−
16 pub default: Option<String>,
14 pub default: Option<String>,
17−
18 pub generated: Option<String>,
15 pub generated: Option<String>,
19}
16}
20
17
@@ -22,6 +19,13 @@ fn nullable_default() -> bool {
22 true
19 true
23}
20}
24
21
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+
25#[derive(Debug)]
29#[derive(Debug)]
26struct PostgresRawValue {
30struct PostgresRawValue {
27 bytes: Vec<u8>,
31 bytes: Vec<u8>,
@@ -65,24 +69,35 @@ impl ToSql for PostgresRawValue {
65 postgres::types::to_sql_checked!();
69 postgres::types::to_sql_checked!();
66}
70}
67
71
68−pub fn batch_touch_rows(db: &mut dyn Conn, table: &str, column: &str) -> anyhow::Result<()> {
72+pub fn batch_touch_rows(
73+ db: &mut dyn Conn,
74+ table: &str,
75+ column: Option<&str>,
76+) -> anyhow::Result<()> {
69 const BATCH_SIZE: u16 = 1000;
77 const BATCH_SIZE: u16 = 1000;
70
78
71− db.query("SET reshape.is_old_schema = 'YES'")?;
72−
73 let mut cursor: Option<PostgresRawValue> = None;
79 let mut cursor: Option<PostgresRawValue> = None;
74
80
75 loop {
81 loop {
76 let mut params: Vec<&(dyn ToSql + Sync)> = Vec::new();
82 let mut params: Vec<&(dyn ToSql + Sync)> = Vec::new();
77
83
78− let primary_key = get_primary_key_columns_for_table(db, &table)?;
84+ 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+
79 let primary_key_columns = primary_key.join(", ");
92 let primary_key_columns = primary_key.join(", ");
80
93
81 let primary_key_where = primary_key
94 let primary_key_where = primary_key
82 .iter()
95 .iter()
83 .map(|column| {
96 .map(|column| {
84 format!(
97 format!(
98+ r#"
85− "{table}.{column} = rows.{column}",
99+ "{table}"."{column}" = rows."{column}"
100+ "#,
86 table = table,
101 table = table,
87 column = column,
102 column = column,
88 )
103 )
@@ -92,7 +107,7 @@ pub fn batch_touch_rows(db: &mut dyn Conn, table: &str, column: &str) -> anyhow:
92
107
93 let returning_columns = primary_key
108 let returning_columns = primary_key
94 .iter()
109 .iter()
95− .map(|column| format!("rows.{}", column))
110+ .map(|column| format!("rows.\"{}\"", column))
96 .collect::<Vec<String>>()
111 .collect::<Vec<String>>()
97 .join(", ");
112 .join(", ");
98
113
@@ -108,31 +123,25 @@ pub fn batch_touch_rows(db: &mut dyn Conn, table: &str, column: &str) -> anyhow:
108 };
123 };
109
124
110 let query = format!(
125 let query = format!(
111− "
126+ r#"
112− WITH rows AS (
127+ WITH rows AS (
113− SELECT {primary_key_columns}
128+ SELECT {primary_key_columns}
114− FROM public.{table}
129+ FROM public."{table}"
115− {cursor_where}
130+ {cursor_where}
116− ORDER BY {primary_key_columns}
131+ ORDER BY {primary_key_columns}
117− LIMIT {batch_size}
132+ LIMIT {batch_size}
118− ), update AS (
133+ ), update AS (
119− UPDATE public.{table}
134+ UPDATE public."{table}" "{table}"
120− SET {column} = {column}
135+ SET "{touched_column}" = "{table}"."{touched_column}"
121− FROM rows
136+ FROM rows
122− WHERE {primary_key_where}
137+ WHERE {primary_key_where}
123− RETURNING {returning_columns}
138+ RETURNING {returning_columns}
124− )
139+ )
125− SELECT LAST_VALUE(({primary_key_columns})) OVER () AS last_value
140+ SELECT LAST_VALUE(({primary_key_columns})) OVER () AS last_value
126− FROM update
141+ FROM update
127− LIMIT 1
142+ LIMIT 1
128− ",
143+ "#,
129− table = table,
130− primary_key_columns = primary_key_columns,
131− cursor_where = cursor_where,
132 batch_size = BATCH_SIZE,
144 batch_size = BATCH_SIZE,
133− column = column,
134− primary_key_where = primary_key_where,
135− returning_columns = returning_columns,
136 );
145 );
137 let last_value = db
146 let last_value = db
138 .query_with_params(&query, &params)?
147 .query_with_params(&query, &params)?
@@ -146,8 +155,6 @@ pub fn batch_touch_rows(db: &mut dyn Conn, table: &str, column: &str) -> anyhow:
146 cursor = last_value
155 cursor = last_value
147 }
156 }
148
157
149− db.query("SET reshape.is_old_schema = ''")?;
150−
151 Ok(())
158 Ok(())
152}
159}
153
160
@@ -173,3 +180,96 @@ fn get_primary_key_columns_for_table(
173
180
174 Ok(primary_key_columns)
181 Ok(primary_key_columns)
175}
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.rsnew file+83
@@ -0,0 +1,83 @@
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+177−29
@@ -1,5 +1,12 @@
1+use std::collections::HashMap;
2+
1−use super::{Action, Column, Context};
3+use super::{common::ForeignKey, Action, Column, MigrationContext};
4+use crate::{
5+ db::{Conn, Transaction},
6+ migrations::common,
2−use crate::{db::Conn, schema::Schema};
7+ schema::Schema,
8+};
9+use anyhow::Context;
3use serde::{Deserialize, Serialize};
10use serde::{Deserialize, Serialize};
4
11
5#[derive(Serialize, Deserialize, Debug)]
12#[derive(Serialize, Deserialize, Debug)]
@@ -7,14 +14,24 @@ pub struct CreateTable {
7 pub name: String,
14 pub name: String,
8 pub columns: Vec<Column>,
15 pub columns: Vec<Column>,
9 pub primary_key: Vec<String>,
16 pub primary_key: Vec<String>,
17+
18+ #[serde(default)]
10 pub foreign_keys: Vec<ForeignKey>,
19 pub foreign_keys: Vec<ForeignKey>,
20+
21+ pub up: Option<Transformation>,
11}
22}
12
23
13#[derive(Serialize, Deserialize, Debug)]
24#[derive(Serialize, Deserialize, Debug)]
14−pub struct ForeignKey {
25+pub struct Transformation {
15− pub columns: Vec<String>,
26+ table: String,
16− pub referenced_table: String,
27+ values: HashMap<String, String>,
17− pub referenced_columns: Vec<String>,
28+ upsert_constraint: Option<String>,
29+}
30+
31+impl CreateTable {
32+ fn trigger_name(&self, ctx: &MigrationContext) -> String {
33+ format!("{}_create_table_{}", ctx.prefix(), self.name)
34+ }
18}
35}
19
36
20#[typetag::serde(name = "create_table")]
37#[typetag::serde(name = "create_table")]
@@ -23,12 +40,17 @@ impl Action for CreateTable {
23 format!("Creating table \"{}\"", self.name)
40 format!("Creating table \"{}\"", self.name)
24 }
41 }
25
42
26− fn run(&self, _ctx: &Context, db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
43+ fn run(
44+ &self,
45+ ctx: &MigrationContext,
46+ db: &mut dyn Conn,
47+ schema: &Schema,
48+ ) -> anyhow::Result<()> {
27 let mut definition_rows: Vec<String> = self
49 let mut definition_rows: Vec<String> = self
28 .columns
50 .columns
29 .iter()
51 .iter()
30 .map(|column| {
52 .map(|column| {
31− let mut parts = vec![column.name.to_string(), column.data_type.to_string()];
53+ let mut parts = vec![format!("\"{}\"", column.name), column.data_type.to_string()];
32
54
33 if let Some(default) = &column.default {
55 if let Some(default) = &column.default {
34 parts.push("DEFAULT".to_string());
56 parts.push("DEFAULT".to_string());
@@ -48,40 +70,166 @@ impl Action for CreateTable {
48 })
70 })
49 .collect();
71 .collect();
50
72
51− let primary_key_columns = self.primary_key.join(", ");
73+ let primary_key_columns = self
74+ .primary_key
75+ .iter()
76+ // Add quotes around all column names
77+ .map(|col| format!("\"{}\"", col))
78+ .collect::<Vec<String>>()
79+ .join(", ");
52 definition_rows.push(format!("PRIMARY KEY ({})", primary_key_columns));
80 definition_rows.push(format!("PRIMARY KEY ({})", primary_key_columns));
53
81
54 for foreign_key in &self.foreign_keys {
82 for foreign_key in &self.foreign_keys {
83+ // Add quotes around all column names
84+ let columns: Vec<String> = foreign_key
85+ .columns
86+ .iter()
87+ .map(|col| format!("\"{}\"", col))
88+ .collect();
89+
90+ let referenced_table = schema.get_table(db, &foreign_key.referenced_table)?;
91+ let referenced_columns: Vec<String> = referenced_table
92+ .real_column_names(&foreign_key.referenced_columns)
93+ .map(|col| format!("\"{}\"", col))
94+ .collect();
95+
55 definition_rows.push(format!(
96 definition_rows.push(format!(
97+ r#"
56− "FOREIGN KEY ({columns}) REFERENCES {table} ({referenced_columns})",
98+ FOREIGN KEY ({columns}) REFERENCES "{table}" ({referenced_columns})
99+ "#,
57− columns = foreign_key.columns.join(", "),
100+ columns = columns.join(", "),
58− table = foreign_key.referenced_table,
101+ table = referenced_table.real_name,
59− referenced_columns = foreign_key.referenced_columns.join(", "),
102+ referenced_columns = referenced_columns.join(", "),
60 ));
103 ));
61 }
104 }
62
105
63− db.run(&format!(
106+ let query = &format!(
107+ r#"
64− "CREATE TABLE {} (
108+ CREATE TABLE "{name}" (
65− {}
109+ {definition}
110+ )
66− )",
111+ "#,
67− self.name,
112+ name = self.name,
68− definition_rows.join(",\n"),
113+ definition = definition_rows.join(",\n"),
69− ))?;
114+ );
70− Ok(())
115+ db.run(query).context("failed to create table")?;
116+
117+ if let Some(Transformation {
118+ table: from_table,
119+ values,
120+ upsert_constraint,
121+ }) = &self.up
122+ {
123+ let from_table = schema.get_table(db, &from_table)?;
124+
125+ let declarations: Vec<String> = from_table
126+ .columns
127+ .iter()
128+ .map(|column| {
129+ format!(
130+ "{alias} public.{table}.{real_name}%TYPE := NEW.{real_name};",
131+ table = from_table.real_name,
132+ alias = column.name,
133+ real_name = column.real_name,
134+ )
135+ })
136+ .collect();
137+
138+ let (insert_columns, insert_values): (Vec<&str>, Vec<&str>) = values
139+ .iter()
140+ .map(|(k, v)| -> (&str, &str) { (k, v) }) // Force &String to &str
141+ .unzip();
142+
143+ let update_set: Vec<String> = values
144+ .iter()
145+ .map(|(field, value)| format!("\"{field}\" = {value}"))
146+ .collect();
147+
148+ // Constraint to check for conflicts. Defaults to the primary key constraint.
149+ let conflict_constraint_name = match upsert_constraint {
150+ Some(custom_constraint) => custom_constraint.clone(),
151+ _ => format!("{table}_pkey", table = self.name),
152+ };
153+
154+ // Add triggers to fill in values as they are inserted/updated
155+ let query = format!(
156+ r#"
157+ CREATE OR REPLACE FUNCTION {trigger_name}()
158+ RETURNS TRIGGER AS $$
159+ #variable_conflict use_variable
160+ BEGIN
161+ IF NOT reshape.is_new_schema() THEN
162+ DECLARE
163+ {declarations}
164+ BEGIN
165+ INSERT INTO public."{changed_table_real}" ({columns})
166+ VALUES ({values})
167+ ON CONFLICT ON CONSTRAINT "{conflict_constraint_name}"
168+ DO UPDATE SET
169+ {updates};
170+ END;
171+ END IF;
172+ RETURN NEW;
173+ END
174+ $$ language 'plpgsql';
175+
176+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{from_table_real}";
177+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{from_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
178+ "#,
179+ changed_table_real = self.name,
180+ from_table_real = from_table.real_name,
181+ trigger_name = self.trigger_name(ctx),
182+ declarations = declarations.join("\n"),
183+ columns = insert_columns.join(", "),
184+ values = insert_values.join(", "),
185+ updates = update_set.join(",\n"),
186+ );
187+ db.run(&query).context("failed to create up trigger")?;
188+
189+ // Backfill values in batches by touching the from table
190+ common::batch_touch_rows(db, &from_table.real_name, None)
191+ .context("failed to batch update existing rows")?;
71− }
192+ }
72
193
73− fn complete(&self, _ctx: &Context, _db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
74− // Do nothing
75 Ok(())
194 Ok(())
76 }
195 }
77
196
78− fn update_schema(&self, _ctx: &Context, _schema: &mut Schema) -> anyhow::Result<()> {
197+ fn complete<'a>(
198+ &self,
199+ ctx: &MigrationContext,
200+ db: &'a mut dyn Conn,
201+ ) -> anyhow::Result<Option<Transaction<'a>>> {
202+ // Remove triggers and procedures
203+ let query = format!(
204+ r#"
205+ DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
206+ "#,
207+ trigger_name = self.trigger_name(ctx),
208+ );
209+ db.run(&query).context("failed to drop up trigger")?;
210+
79− Ok(())
211+ Ok(None)
80 }
212 }
81
213
214+ fn update_schema(&self, _ctx: &MigrationContext, _schema: &mut Schema) {}
215+
82− fn abort(&self, _ctx: &Context, db: &mut dyn Conn) -> anyhow::Result<()> {
216+ fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()> {
217+ // Remove triggers and procedures
218+ let query = format!(
219+ r#"
220+ DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
221+ "#,
222+ trigger_name = self.trigger_name(ctx),
223+ );
224+ db.run(&query).context("failed to drop up trigger")?;
225+
226+ db.run(&format!(
227+ r#"
83− let query = format!("DROP TABLE IF EXISTS {table}", table = self.name,);
228+ DROP TABLE IF EXISTS "{name}"
84− db.run(&query)?;
229+ "#,
230+ name = self.name,
231+ ))
232+ .context("failed to drop table")?;
85
233
86 Ok(())
234 Ok(())
87 }
235 }
src/migrations/custom.rsnew file+61
@@ -0,0 +1,61 @@
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+43−11
@@ -1,4 +1,7 @@
1+use crate::{
2+ db::{Conn, Transaction},
1−use crate::{db::Conn, schema::Schema};
3+ schema::Schema,
4+};
2use core::fmt::Debug;
5use core::fmt::Debug;
3use serde::{Deserialize, Serialize};
6use serde::{Deserialize, Serialize};
4
7
@@ -7,7 +10,7 @@ mod common;
7pub use common::Column;
10pub use common::Column;
8
11
9mod create_table;
12mod create_table;
10−pub use create_table::{CreateTable, ForeignKey};
13+pub use create_table::CreateTable;
11
14
12mod alter_column;
15mod alter_column;
13pub use alter_column::{AlterColumn, ColumnChanges};
16pub use alter_column::{AlterColumn, ColumnChanges};
@@ -19,7 +22,10 @@ mod remove_column;
19pub use remove_column::RemoveColumn;
22pub use remove_column::RemoveColumn;
20
23
21mod add_index;
24mod add_index;
22−pub use add_index::AddIndex;
25+pub use add_index::{AddIndex, Index};
26+
27+mod remove_index;
28+pub use remove_index::RemoveIndex;
23
29
24mod remove_table;
30mod remove_table;
25pub use remove_table::RemoveTable;
31pub use remove_table::RemoveTable;
@@ -27,6 +33,21 @@ pub use remove_table::RemoveTable;
27mod rename_table;
33mod rename_table;
28pub use rename_table::RenameTable;
34pub use rename_table::RenameTable;
29
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+
30#[derive(Serialize, Deserialize, Debug)]
51#[derive(Serialize, Deserialize, Debug)]
31pub struct Migration {
52pub struct Migration {
32 pub name: String,
53 pub name: String,
@@ -64,16 +85,22 @@ impl Clone for Migration {
64 }
85 }
65}
86}
66
87
67−pub struct Context {
88+pub struct MigrationContext {
68 migration_index: usize,
89 migration_index: usize,
69 action_index: usize,
90 action_index: usize,
91+ existing_schema_name: Option<String>,
70}
92}
71
93
72−impl Context {
94+impl MigrationContext {
95+ pub fn new(
73− pub fn new(migration_index: usize, action_index: usize) -> Self {
96+ migration_index: usize,
74− Context {
97+ action_index: usize,
98+ existing_schema_name: Option<String>,
99+ ) -> Self {
100+ MigrationContext {
75 migration_index,
101 migration_index,
76 action_index,
102 action_index,
103+ existing_schema_name,
77 }
104 }
78 }
105 }
79
106
@@ -96,8 +123,13 @@ impl Context {
96#[typetag::serde(tag = "type")]
123#[typetag::serde(tag = "type")]
97pub trait Action: Debug {
124pub trait Action: Debug {
98 fn describe(&self) -> String;
125 fn describe(&self) -> String;
99− fn run(&self, ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()>;
126+ fn run(&self, ctx: &MigrationContext, db: &mut dyn Conn, schema: &Schema)
100− fn complete(&self, ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()>;
127+ -> anyhow::Result<()>;
128+ fn complete<'a>(
129+ &self,
130+ ctx: &MigrationContext,
131+ db: &'a mut dyn Conn,
132+ ) -> anyhow::Result<Option<Transaction<'a>>>;
101− fn update_schema(&self, ctx: &Context, schema: &mut Schema) -> anyhow::Result<()>;
133+ fn update_schema(&self, ctx: &MigrationContext, schema: &mut Schema);
102− fn abort(&self, ctx: &Context, db: &mut dyn Conn) -> anyhow::Result<()>;
134+ fn abort(&self, ctx: &MigrationContext, db: &mut dyn Conn) -> anyhow::Result<()>;
103}
135}
src/migrations/remove_column.rs+390−55
@@ -1,16 +1,31 @@
1−use super::{Action, Context};
1+use super::{common, Action, MigrationContext};
2+use crate::{
3+ db::{Conn, Transaction},
2−use crate::{db::Conn, schema::Schema};
4+ schema::Schema,
5+};
6+use anyhow::{anyhow, bail, Context};
3use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
4
8
5#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
6pub struct RemoveColumn {
10pub struct RemoveColumn {
7 pub table: String,
11 pub table: String,
8 pub column: String,
12 pub column: String,
9− pub down: Option<String>,
13+ pub down: Option<Transformation>,
14+}
15+
16+#[derive(Serialize, Deserialize, Debug)]
17+#[serde(untagged)]
18+pub enum Transformation {
19+ Simple(String),
20+ Update {
21+ table: String,
22+ value: String,
23+ r#where: String,
24+ },
10}
25}
11
26
12impl RemoveColumn {
27impl RemoveColumn {
13− fn trigger_name(&self, ctx: &Context) -> String {
28+ fn trigger_name(&self, ctx: &MigrationContext) -> String {
14 format!(
29 format!(
15 "{}_remove_column_{}_{}",
30 "{}_remove_column_{}_{}",
16 ctx.prefix(),
31 ctx.prefix(),
@@ -18,6 +33,33 @@ impl RemoveColumn {
18 self.column
33 self.column
19 )
34 )
20 }
35 }
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+ }
21}
63}
22
64
23#[typetag::serde(name = "remove_column")]
65#[typetag::serde(name = "remove_column")]
@@ -29,11 +71,19 @@ impl Action for RemoveColumn {
29 )
71 )
30 }
72 }
31
73
32− fn run(&self, ctx: &Context, db: &mut dyn Conn, schema: &Schema) -> anyhow::Result<()> {
74+ fn run(
75+ &self,
76+ ctx: &MigrationContext,
77+ db: &mut dyn Conn,
78+ schema: &Schema,
79+ ) -> 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+
33 // Add down trigger
85 // Add down trigger
34 if let Some(down) = &self.down {
86 if let Some(down) = &self.down {
35− let table = schema.get_table(db, &self.table)?;
36−
37 let declarations: Vec<String> = table
87 let declarations: Vec<String> = table
38 .columns
88 .columns
39 .iter()
89 .iter()
@@ -47,72 +97,357 @@ impl Action for RemoveColumn {
47 })
97 })
48 .collect();
98 .collect();
49
99
100+ if let Transformation::Simple(down) = down {
50− let query = format!(
101+ let query = format!(
51− "
102+ r#"
52− CREATE OR REPLACE FUNCTION {trigger_name}()
103+ CREATE OR REPLACE FUNCTION {trigger_name}()
53− RETURNS TRIGGER AS $$
104+ RETURNS TRIGGER AS $$
54− BEGIN
105+ BEGIN
55− IF NEW.{column_name} IS NULL THEN
106+ IF reshape.is_new_schema() THEN
56− DECLARE
107+ DECLARE
108+ {declarations}
109+ BEGIN
110+ NEW.{column_name} = {down};
111+ END;
112+ END IF;
113+ RETURN NEW;
114+ END
115+ $$ language 'plpgsql';
116+
117+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
118+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{table}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
119+ "#,
120+ column_name = self.column,
121+ trigger_name = self.trigger_name(ctx),
122+ down = down,
123+ table = self.table,
57− {declarations}
124+ declarations = declarations.join("\n"),
125+ );
126+ db.run(&query).context("failed to create down trigger")?;
127+ }
128+
129+ if let Transformation::Update {
130+ table: from_table,
131+ value,
132+ r#where,
133+ } = down
134+ {
135+ let existing_schema_name = match &ctx.existing_schema_name {
136+ Some(name) => name,
137+ None => bail!("can't use update without previous migration"),
138+ };
139+
140+ let from_table = schema.get_table(db, &from_table)?;
141+
142+ let maybe_null_check = if !column.nullable {
143+ // Replace NOT NULL constraint with a constraint trigger that only triggers on the old schema.
144+ // We will add a null check to the down function on the new schema below as well to cover both cases.
145+ // As we are using a complex down function, we must remove the NOT NULL check for the new schema.
146+ // NOT NULL is not checked at the end of a transaction, but immediately upon update.
147+ let query = format!(
148+ r#"
149+ CREATE OR REPLACE FUNCTION {trigger_name}()
150+ RETURNS TRIGGER AS $$
58 BEGIN
151 BEGIN
59− NEW.{column_name} = {down};
152+ IF NOT reshape.is_new_schema() THEN
153+ IF NEW.{column} IS NULL THEN
154+ RAISE EXCEPTION '{column} can not be null';
60− END;
155+ END IF;
61− END IF;
156+ END IF;
62− RETURN NEW;
157+ RETURN NEW;
63− END
158+ END
64− $$ language 'plpgsql';
159+ $$ language 'plpgsql';
65−
160+
66− DROP TRIGGER IF EXISTS {trigger_name} ON {table};
161+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{table}";
162+
163+ CREATE CONSTRAINT TRIGGER "{trigger_name}"
164+ AFTER INSERT OR UPDATE
165+ ON "{table}"
166+ FOR EACH ROW
67− CREATE TRIGGER {trigger_name} BEFORE UPDATE OR INSERT ON {table} FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
167+ EXECUTE PROCEDURE {trigger_name}();
68− ",
168+ "#,
69− column_name = self.column,
169+ table = self.table,
70− trigger_name = self.trigger_name(&ctx),
170+ trigger_name = self.not_null_constraint_trigger_name(ctx),
71− down = down,
171+ column = self.column,
172+ );
173+ db.run(&query)
174+ .context("failed to create null constraint trigger")?;
175+
176+ db.run(&format!(
177+ r#"
178+ ALTER TABLE {table}
179+ ALTER COLUMN {column}
180+ DROP NOT NULL
181+ "#,
72− table = self.table,
182+ table = self.table,
183+ column = self.column
184+ ))
185+ .context("failed to remove column not null constraint")?;
186+
187+ format!(
188+ r#"
189+ IF {value} IS NULL THEN
190+ RAISE EXCEPTION '{column_name} can not be null';
191+ END IF;
192+ "#,
193+ column_name = self.column,
194+ )
195+ } else {
196+ "".to_string()
197+ };
198+
199+ let into_variables = from_table
200+ .columns
201+ .iter()
202+ .map(|column| {
203+ format!(
204+ "NEW.{real_name} AS {alias}",
205+ alias = column.name,
206+ real_name = column.real_name,
207+ )
208+ })
209+ .collect::<Vec<String>>()
210+ .join(", ");
211+
212+ let query = format!(
213+ r#"
214+ CREATE OR REPLACE FUNCTION {trigger_name}()
215+ RETURNS TRIGGER AS $$
216+ #variable_conflict use_variable
217+ BEGIN
218+ IF reshape.is_new_schema() THEN
219+ DECLARE
220+ {from_table} record;
221+ BEGIN
222+ SELECT {into_variables}
223+ INTO {from_table};
224+
225+ {maybe_null_check}
226+
227+ -- Don't trigger reverse trigger when making this update
228+ perform set_config('reshape.disable_triggers', 'TRUE', TRUE);
229+
230+ UPDATE "migration_{existing_schema_name}"."{changed_table}" "{changed_table}"
231+ SET "{column_name}" = {value}
232+ WHERE {where};
233+
234+ perform set_config('reshape.disable_triggers', '', TRUE);
235+ END;
236+ END IF;
237+ RETURN NEW;
238+ END
239+ $$ language 'plpgsql';
240+
241+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{from_table_real}";
242+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{from_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
243+ "#,
244+ changed_table = self.table,
245+ from_table = from_table.name,
246+ from_table_real = from_table.real_name,
247+ column_name = self.column,
248+ trigger_name = self.trigger_name(ctx),
249+ );
250+ db.run(&query).context("failed to create down trigger")?;
251+
252+ let changed_into_variables = table
253+ .columns
254+ .iter()
255+ .map(|column| {
256+ format!(
257+ "NEW.{real_name} AS {alias}",
258+ alias = column.name,
259+ real_name = column.real_name,
260+ )
261+ })
262+ .collect::<Vec<String>>()
263+ .join(", ");
264+
265+ let from_table_columns = from_table
266+ .columns
267+ .iter()
268+ .map(|column| format!("{} as {}", column.real_name, column.name))
269+ .collect::<Vec<String>>()
270+ .join(", ");
271+
272+ let query = format!(
273+ r#"
274+ CREATE OR REPLACE FUNCTION {trigger_name}()
275+ RETURNS TRIGGER AS $$
276+ #variable_conflict use_variable
277+ BEGIN
278+ IF reshape.is_new_schema() AND NOT current_setting('reshape.disable_triggers', TRUE) = 'TRUE' THEN
279+ DECLARE
280+ {changed_table} record;
281+ __temp_row record;
282+ BEGIN
283+ SELECT {changed_into_variables}
284+ INTO {changed_table};
285+
286+ SELECT *
287+ INTO __temp_row
288+ FROM (
289+ SELECT {from_table_columns}
290+ FROM public.{from_table_real}
291+ ) {from_table}
292+ WHERE {where};
293+
294+ DECLARE
295+ {from_table} record;
296+ BEGIN
297+ {from_table} := __temp_row;
298+ NEW.{column_name_real} = {value};
299+ END;
300+ END;
301+ END IF;
302+ RETURN NEW;
303+ END
304+ $$ language 'plpgsql';
305+
306+ DROP TRIGGER IF EXISTS "{trigger_name}" ON "{changed_table_real}";
307+ CREATE TRIGGER "{trigger_name}" BEFORE UPDATE OR INSERT ON "{changed_table_real}" FOR EACH ROW EXECUTE PROCEDURE {trigger_name}();
308+ "#,
309+ changed_table = table.name,
310+ changed_table_real = table.real_name,
311+ from_table = from_table.name,
312+ from_table_real = from_table.real_name,
313+ column_name_real = column.real_name,
314+ trigger_name = self.reverse_trigger_name(ctx),
73− declarations = declarations.join("\n"),
315+ // declarations = declarations.join("\n"),
74− );
316+ );
75− db.run(&query)?;
317+ db.run(&query)
318+ .context("failed to create reverse down trigger")?;
319+ }
76 }
320 }
77
321
78 Ok(())
322 Ok(())
79 }
323 }
80
324
81− fn complete(&self, ctx: &Context, db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
325+ fn complete<'a>(
326+ &self,
327+ ctx: &MigrationContext,
328+ db: &'a mut dyn Conn,
329+ ) -> 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+
82 // Remove column, function and trigger
343 // Remove column, function and trigger
83 let query = format!(
344 let query = format!(
84− "
345+ r#"
85− ALTER TABLE {table}
346+ ALTER TABLE "{table}"
86− DROP COLUMN {column};
347+ DROP COLUMN IF EXISTS "{column}";
87
348
88− DROP TRIGGER IF EXISTS {trigger_name} ON {table};
349+ DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
350+ DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
89− DROP FUNCTION IF EXISTS {trigger_name};
351+ DROP FUNCTION IF EXISTS "{null_trigger_name}" CASCADE;
90− ",
352+ "#,
91 table = self.table,
353 table = self.table,
92 column = self.column,
354 column = self.column,
93− trigger_name = self.trigger_name(&ctx),
355+ 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),
94 );
358 );
95− db.run(&query)?;
359+ db.run(&query)
360+ .context("failed to drop column and down trigger")?;
96
361
97− Ok(())
362+ Ok(None)
98 }
363 }
99
364
100− fn update_schema(&self, _ctx: &Context, schema: &mut Schema) -> anyhow::Result<()> {
365+ fn update_schema(&self, _ctx: &MigrationContext, schema: &mut Schema) {
101− schema.set_column_hidden(&self.table, &self.column);
366+ schema.change_table(&self.table, |table_changes| {
102−
367+ table_changes.change_column(&self.column, |column_changes| {
103− Ok(())
368+ column_changes.set_removed();
369+ })
370+ });
104 }
371 }
105
372
106− fn abort(&self, ctx: &Context, db: &mut dyn Conn) -> anyhow::Result<()> {
373+ 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+
107 // Remove function and trigger
439 // Remove function and trigger
108− db.query(&format!(
440+ db.run(&format!(
109− "
441+ r#"
110− DROP TRIGGER IF EXISTS {trigger_name} ON {table};
442+ DROP FUNCTION IF EXISTS "{trigger_name}" CASCADE;
443+ DROP FUNCTION IF EXISTS "{reverse_trigger_name}" CASCADE;
111− DROP FUNCTION IF EXISTS {trigger_name};
444+ DROP FUNCTION IF EXISTS "{null_trigger_name}" CASCADE;
112− ",
445+ "#,
113− table = self.table,
446+ trigger_name = self.trigger_name(ctx),
114− 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),
115− ))?;
449+ ))
450+ .context("failed to drop down trigger")?;
116
451
117 Ok(())
452 Ok(())
118 }
453 }
src/migrations/remove_enum.rsnew file+51
@@ -0,0 +1,51 @@
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.rsnew file+91
@@ -0,0 +1,91 @@
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/migrations/remove_index.rsnew file+51
@@ -0,0 +1,51 @@
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 RemoveIndex {
11+ pub index: String,
12+}
13+
14+#[typetag::serde(name = "remove_index")]
15+impl Action for RemoveIndex {
16+ fn describe(&self) -> String {
17+ format!("Removing index \"{}\"", self.index)
18+ }
19+
20+ fn run(
21+ &self,
22+ _ctx: &MigrationContext,
23+ _db: &mut dyn Conn,
24+ _schema: &Schema,
25+ ) -> anyhow::Result<()> {
26+ // Do nothing, the index isn't removed until completion
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 INDEX CONCURRENTLY IF EXISTS "{name}"
38+ "#,
39+ name = self.index
40+ ))
41+ .context("failed to drop index")?;
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_table.rs+27−14
@@ -1,5 +1,9 @@
1−use super::{Action, Context};
1+use super::{Action, MigrationContext};
2+use crate::{
3+ db::{Conn, Transaction},
2−use crate::{db::Conn, schema::Schema};
4+ schema::Schema,
5+};
6+use anyhow::Context;
3use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
4
8
5#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
@@ -13,30 +17,39 @@ impl Action for RemoveTable {
13 format!("Removing table \"{}\"", self.table)
17 format!("Removing table \"{}\"", self.table)
14 }
18 }
15
19
16− fn run(&self, _ctx: &Context, _db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
20+ fn run(
21+ &self,
22+ _ctx: &MigrationContext,
23+ _db: &mut dyn Conn,
24+ _schema: &Schema,
25+ ) -> anyhow::Result<()> {
17 Ok(())
26 Ok(())
18 }
27 }
19
28
20− fn complete(&self, _ctx: &Context, db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
29+ fn complete<'a>(
30+ &self,
31+ _ctx: &MigrationContext,
32+ db: &'a mut dyn Conn,
33+ ) -> anyhow::Result<Option<Transaction<'a>>> {
21 // Remove table
34 // Remove table
22 let query = format!(
35 let query = format!(
23− "
36+ r#"
24− DROP TABLE {table};
37+ DROP TABLE IF EXISTS "{table}";
25− ",
38+ "#,
26 table = self.table,
39 table = self.table,
27 );
40 );
28− db.run(&query)?;
41+ db.run(&query).context("failed to drop table")?;
29
42
30− Ok(())
43+ Ok(None)
31 }
44 }
32
45
33− fn update_schema(&self, _ctx: &Context, schema: &mut Schema) -> anyhow::Result<()> {
46+ fn update_schema(&self, _ctx: &MigrationContext, schema: &mut Schema) {
34− schema.set_table_hidden(&self.table);
47+ schema.change_table(&self.table, |table_changes| {
35−
48+ table_changes.set_removed();
36− Ok(())
49+ });
37 }
50 }
38
51
39− fn abort(&self, _ctx: &Context, _db: &mut dyn Conn) -> anyhow::Result<()> {
52+ fn abort(&self, _ctx: &MigrationContext, _db: &mut dyn Conn) -> anyhow::Result<()> {
40 Ok(())
53 Ok(())
41 }
54 }
42}
55}
src/migrations/rename_table.rs+28−15
@@ -1,5 +1,9 @@
1−use super::{Action, Context};
1+use super::{Action, MigrationContext};
2+use crate::{
3+ db::{Conn, Transaction},
2−use crate::{db::Conn, schema::Schema};
4+ schema::Schema,
5+};
6+use anyhow::Context;
3use serde::{Deserialize, Serialize};
7use serde::{Deserialize, Serialize};
4
8
5#[derive(Serialize, Deserialize, Debug)]
9#[derive(Serialize, Deserialize, Debug)]
@@ -14,32 +18,41 @@ impl Action for RenameTable {
14 format!("Renaming table \"{}\" to \"{}\"", self.table, self.new_name)
18 format!("Renaming table \"{}\" to \"{}\"", self.table, self.new_name)
15 }
19 }
16
20
17− fn run(&self, _ctx: &Context, _db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
21+ fn run(
22+ &self,
23+ _ctx: &MigrationContext,
24+ _db: &mut dyn Conn,
25+ _schema: &Schema,
26+ ) -> anyhow::Result<()> {
18 Ok(())
27 Ok(())
19 }
28 }
20
29
21− fn complete(&self, _ctx: &Context, db: &mut dyn Conn, _schema: &Schema) -> anyhow::Result<()> {
30+ fn complete<'a>(
31+ &self,
32+ _ctx: &MigrationContext,
33+ db: &'a mut dyn Conn,
34+ ) -> anyhow::Result<Option<Transaction<'a>>> {
22 // Rename table
35 // Rename table
23 let query = format!(
36 let query = format!(
24− "
37+ r#"
25− ALTER TABLE {table}
38+ ALTER TABLE IF EXISTS "{table}"
26− RENAME TO {new_name}
39+ RENAME TO "{new_name}"
27− ",
40+ "#,
28 table = self.table,
41 table = self.table,
29 new_name = self.new_name,
42 new_name = self.new_name,
30 );
43 );
31− db.run(&query)?;
44+ db.run(&query).context("failed to rename table")?;
32
45
33− Ok(())
46+ Ok(None)
34 }
47 }
35
48
36− fn update_schema(&self, _ctx: &Context, schema: &mut Schema) -> anyhow::Result<()> {
49+ fn update_schema(&self, _ctx: &MigrationContext, schema: &mut Schema) {
37− schema.set_table_alias(&self.table, &self.new_name);
50+ schema.change_table(&self.table, |table_changes| {
38−
51+ table_changes.set_name(&self.new_name);
39− Ok(())
52+ });
40 }
53 }
41
54
42− fn abort(&self, _ctx: &Context, _db: &mut dyn Conn) -> anyhow::Result<()> {
55+ fn abort(&self, _ctx: &MigrationContext, _db: &mut dyn Conn) -> anyhow::Result<()> {
43 Ok(())
56 Ok(())
44 }
57 }
45}
58}
src/schema.rs+186−139
@@ -1,144 +1,140 @@
1use crate::db::Conn;
1use crate::db::Conn;
2−use anyhow::anyhow;
3−use bimap::BiMap;
4−use std::collections::{hash_map::Entry, HashMap, HashSet};
2+use std::collections::{HashMap, HashSet};
5−
3+
4+// Schema tracks changes made to tables and columns during a migration.
5+// These changes are not applied until the migration is completed but
6+// need to be taken into consideration when creating views for a migration
7+// and when a user references a table or column in a migration.
8+//
9+// The changes to a table are tracked by a `TableChanges` struct. The possible
10+// changes are:
11+// - Changing the name which updates `current_name`.
12+// - Removing which sets the `removed` flag.
13+//
14+// Changes to a column are tracked by a `ColumnChanges` struct which reside in
15+// the corresponding `TableChanges`. The possible changes are:
16+// - Changing the name which updates `current_name`.
17+// - Changing the backing column which will add the new column to the end of
18+// `intermediate_columns`. This is used when temporary columns are
19+// introduced which will eventually replace the current column.
20+// - Removing which sets the `removed` flag.
21+//
22+// Schema provides some schema introspection methods, `get_tables` and `get_table`,
23+// which will retrieve the current schema from the database and apply the changes.
6#[derive(Debug)]
24#[derive(Debug)]
7pub struct Schema {
25pub struct Schema {
8− table_alias_to_name: BiMap<String, String>,
26+ table_changes: Vec<TableChanges>,
9− hidden_tables: HashSet<String>,
10− table_schemas_by_name: HashMap<String, TableSchema>,
11}
27}
12
28
13impl Schema {
29impl Schema {
14 pub fn new() -> Schema {
30 pub fn new() -> Schema {
15 Schema {
31 Schema {
16− table_alias_to_name: BiMap::new(),
32+ table_changes: Vec::new(),
17− hidden_tables: HashSet::new(),
18− table_schemas_by_name: HashMap::new(),
19 }
33 }
20 }
34 }
21
35
22− pub fn set_table_alias(&mut self, current_name: &str, alias: &str) {
36+ pub fn change_table<F>(&mut self, current_name: &str, f: F)
23− self.table_alias_to_name
37+ where
24− .insert(alias.to_string(), current_name.to_string());
38+ F: FnOnce(&mut TableChanges),
25− }
39+ {
26−
40+ let table_change_index = self
27− pub fn set_table_hidden(&mut self, table: &str) {
41+ .table_changes
28− let real_name = self
42+ .iter()
29− .get_table_real_name(table)
43+ .position(|table| table.current_name == current_name)
30− .unwrap_or_else(|| table.to_string());
31− self.hidden_tables.insert(real_name);
32− }
33−
34− pub fn set_column_alias(&mut self, table: &str, current_name: &str, alias: &str) {
35− let table_real_name = self
36− .get_table_real_name(table)
37− .unwrap_or_else(|| table.to_string());
44+ .unwrap_or_else(|| {
38−
39− let column = match self.table_schemas_by_name.entry(table_real_name) {
40− Entry::Occupied(o) => o.into_mut(),
41− Entry::Vacant(v) => v.insert(TableSchema::new()),
42− };
43−
44− column
45− .column_alias_to_name
46− .insert(alias.to_string(), current_name.to_string());
45+ let new_changes = TableChanges::new(current_name.to_string());
47− }
46+ self.table_changes.push(new_changes);
48−
47+ self.table_changes.len() - 1
49− pub fn set_column_hidden(&mut self, table: &str, name: &str) {
50− let table_real_name = self
51− .get_table_real_name(table)
52− .unwrap_or_else(|| table.to_string());
53− let column = match self.table_schemas_by_name.entry(table_real_name) {
54− Entry::Occupied(o) => o.into_mut(),
55− Entry::Vacant(v) => v.insert(TableSchema::new()),
56− };
48+ });
57
49
58− column.hidden_columns.insert(name.to_string());
50+ let table_changes = &mut self.table_changes[table_change_index];
51+ f(table_changes)
59 }
52 }
53+}
60
54
61− fn get_table_real_name(&self, name: &str) -> Option<String> {
55+impl Default for Schema {
62− self.table_alias_to_name
56+ fn default() -> Self {
63− .get_by_left(name)
57+ Self::new()
64− .map(|real_name| real_name.to_string())
65 }
58 }
59+}
66
60
67− fn get_table_alias_from_real_name<'a>(&'a self, real_name: &'a str) -> Option<String> {
61+#[derive(Debug)]
68− self.table_alias_to_name
62+pub struct TableChanges {
63+ current_name: String,
69− .get_by_right(real_name)
64+ real_name: String,
70− .map(|name| name.to_string())
65+ column_changes: Vec<ColumnChanges>,
66+ removed: bool,
71− }
67+}
72
68
73− fn is_table_hidden(&self, table: &str) -> bool {
69+impl TableChanges {
74− let table_real_name = self
70+ fn new(name: String) -> Self {
75− .get_table_real_name(table)
71+ Self {
76− .unwrap_or_else(|| table.to_string());
72+ current_name: name.to_string(),
77− self.hidden_tables.contains(&table_real_name)
73+ real_name: name,
74+ column_changes: Vec::new(),
75+ removed: false,
76+ }
78 }
77 }
79
78
80− fn get_column_real_name<'a>(&'a self, table: &'a str, name: &'a str) -> Option<&'a str> {
79+ pub fn set_name(&mut self, name: &str) {
81− let table_real_name = self
80+ self.current_name = name.to_string();
82− .get_table_real_name(table)
83− .unwrap_or_else(|| table.to_string());
84−
85− self.table_schemas_by_name
86− .get(&table_real_name)
87− .map(|column| column.get_column_real_name(name))
88 }
81 }
89
82
90− fn get_column_alias_from_real_name(&self, table: &str, real_name: &str) -> Option<String> {
83+ pub fn change_column<F>(&mut self, current_name: &str, f: F)
91− let table_real_name = self
84+ where
92− .get_table_real_name(table)
85+ F: FnOnce(&mut ColumnChanges),
86+ {
87+ let column_change_index = self
88+ .column_changes
89+ .iter()
90+ .position(|column| column.current_name == current_name)
93− .unwrap_or_else(|| table.to_string());
91+ .unwrap_or_else(|| {
92+ let new_changes = ColumnChanges::new(current_name.to_string());
93+ self.column_changes.push(new_changes);
94+ self.column_changes.len() - 1
95+ });
94
96
95− self.table_schemas_by_name
97+ let column_changes = &mut self.column_changes[column_change_index];
96− .get(&table_real_name)
98+ f(column_changes)
97− .and_then(|column| column.get_column_alias_from_real_name(real_name))
98 }
99 }
99
100
100− fn is_column_hidden(&self, table: &str, name: &str) -> bool {
101+ pub fn set_removed(&mut self) {
101− let table_real_name = self
102+ self.removed = true;
102− .get_table_real_name(table)
103− .unwrap_or_else(|| table.to_string());
104− self.table_schemas_by_name
105− .get(&table_real_name)
106− .map(|column| {
107− let alias = column
108− .get_column_alias_from_real_name(name)
109− .unwrap_or_else(|| name.to_string());
110− column.hidden_columns.contains(&alias)
111− })
112− .unwrap_or(false)
113 }
103 }
114}
104}
115
105
116#[derive(Debug)]
106#[derive(Debug)]
117−struct TableSchema {
107+pub struct ColumnChanges {
118− column_alias_to_name: BiMap<String, String>,
108+ current_name: String,
119− hidden_columns: HashSet<String>,
109+ backing_columns: Vec<String>,
110+ removed: bool,
120}
111}
121
112
122−impl TableSchema {
113+impl ColumnChanges {
123− fn new() -> TableSchema {
114+ fn new(name: String) -> Self {
124− TableSchema {
115+ Self {
125− column_alias_to_name: BiMap::new(),
116+ current_name: name.to_string(),
126− hidden_columns: HashSet::new(),
117+ backing_columns: vec![name],
118+ removed: false,
127 }
119 }
128 }
120 }
129
121
130− fn get_column_real_name<'a>(&'a self, name: &'a str) -> &'a str {
122+ pub fn set_name(&mut self, name: &str) {
131− if let Some(real_name) = self.column_alias_to_name.get_by_left(name) {
123+ self.current_name = name.to_string();
132− real_name
124+ }
133− } else {
125+
134− name
126+ pub fn set_column(&mut self, column_name: &str) {
135− }
127+ self.backing_columns.push(column_name.to_string())
128+ }
129+
130+ pub fn set_removed(&mut self) {
131+ self.removed = true;
136 }
132 }
137
133
138− fn get_column_alias_from_real_name(&self, real_name: &str) -> Option<String> {
134+ fn real_name(&self) -> &str {
139− self.column_alias_to_name
135+ self.backing_columns
140− .get_by_right(real_name)
136+ .last()
141− .map(|name| name.to_string())
137+ .expect("backing_columns should never be empty")
142 }
138 }
143}
139}
144
140
@@ -155,6 +151,7 @@ pub struct Column {
155 pub real_name: String,
151 pub real_name: String,
156 pub data_type: String,
152 pub data_type: String,
157 pub nullable: bool,
153 pub nullable: bool,
154+ pub default: Option<String>,
158}
155}
159
156
160impl Schema {
157impl Schema {
@@ -168,31 +165,51 @@ impl Schema {
168 )?
165 )?
169 .iter()
166 .iter()
170 .map(|row| row.get::<'_, _, String>("table_name"))
167 .map(|row| row.get::<'_, _, String>("table_name"))
171− .filter(|real_name| !self.is_table_hidden(real_name))
168+ .filter_map(|real_name| {
169+ let table_changes = self
170+ .table_changes
171+ .iter()
172+ .find(|changes| changes.real_name == real_name);
173+
174+ // Skip table if it has been removed
175+ if let Some(changes) = table_changes {
176+ if changes.removed {
177+ return None;
178+ }
179+ }
180+
172− .map(|real_name| self.get_table_by_real_name(db, &real_name))
181+ Some(self.get_table_by_real_name(db, &real_name))
182+ })
173 .collect()
183 .collect()
174 }
184 }
175
185
176 pub fn get_table(&self, db: &mut dyn Conn, table_name: &str) -> anyhow::Result<Table> {
186 pub fn get_table(&self, db: &mut dyn Conn, table_name: &str) -> anyhow::Result<Table> {
177− let real_table_name = self
187+ let table_changes = self
178− .get_table_real_name(table_name)
188+ .table_changes
189+ .iter()
190+ .find(|changes| changes.current_name == table_name);
191+
192+ let real_table_name = table_changes
193+ .map(|changes| changes.real_name.to_string())
179 .unwrap_or_else(|| table_name.to_string());
194 .unwrap_or_else(|| table_name.to_string());
195+
180 self.get_table_by_real_name(db, &real_table_name)
196 self.get_table_by_real_name(db, &real_table_name)
181 }
197 }
182
198
183− pub fn get_table_by_real_name(
199+ fn get_table_by_real_name(
184 &self,
200 &self,
185 db: &mut dyn Conn,
201 db: &mut dyn Conn,
186 real_table_name: &str,
202 real_table_name: &str,
187 ) -> anyhow::Result<Table> {
203 ) -> anyhow::Result<Table> {
188− if self.is_table_hidden(real_table_name) {
204+ let table_changes = self
189− return Err(anyhow!("no table named {}", real_table_name));
205+ .table_changes
190− }
206+ .iter()
207+ .find(|changes| changes.real_name == real_table_name);
191
208
192− let real_columns: Vec<(String, String, bool)> = db
209+ let real_columns: Vec<(String, String, bool, Option<String>)> = db
193 .query(&format!(
210 .query(&format!(
194 "
211 "
195− SELECT column_name, data_type, is_nullable
212+ SELECT column_name, CASE WHEN data_type = 'USER-DEFINED' THEN udt_name ELSE data_type END, is_nullable, column_default
196 FROM information_schema.columns
213 FROM information_schema.columns
197 WHERE table_name = '{table}' AND table_schema = 'public'
214 WHERE table_name = '{table}' AND table_schema = 'public'
198 ORDER BY ordinal_position
215 ORDER BY ordinal_position
@@ -205,54 +222,84 @@ impl Schema {
205 row.get("column_name"),
222 row.get("column_name"),
206 row.get("data_type"),
223 row.get("data_type"),
207 row.get::<'_, _, String>("is_nullable") == "YES",
224 row.get::<'_, _, String>("is_nullable") == "YES",
225+ row.get("column_default"),
208 )
226 )
209 })
227 })
210 .collect();
228 .collect();
211
229
212− let mut columns: Vec<Column> = Vec::new();
230+ let mut ignore_columns: HashSet<String> = HashSet::new();
213−
231+ let mut aliases: HashMap<String, &str> = HashMap::new();
214− for (column_name, data_type, nullable) in real_columns {
232+
215− if self.is_column_hidden(real_table_name, &column_name) {
233+ if let Some(changes) = table_changes {
216− continue;
234+ for column_changes in &changes.column_changes {
235+ if column_changes.removed {
236+ ignore_columns.insert(column_changes.real_name().to_string());
237+ } else {
238+ aliases.insert(
239+ column_changes.real_name().to_string(),
240+ &column_changes.current_name,
241+ );
242+ }
243+
244+ let (_, rest) = column_changes
245+ .backing_columns
246+ .split_last()
247+ .expect("backing_columns should never be empty");
248+
249+ for column in rest {
250+ ignore_columns.insert(column.to_string());
251+ }
217 }
252 }
253+ }
218
254
219− if is_column_temporary(&column_name) {
255+ let mut columns: Vec<Column> = Vec::new();
256+
257+ for (real_name, data_type, nullable, default) in real_columns {
258+ if ignore_columns.contains(&*real_name) {
220 continue;
259 continue;
221 }
260 }
222
261
223− let (name, real_name) = if let Some(alias) =
262+ let name = aliases
224− self.get_column_alias_from_real_name(real_table_name, &column_name)
263+ .get(&real_name)
225− {
264+ .map(|alias| alias.to_string())
226− (alias, column_name)
227− } else {
228− let real_name = self
229− .get_column_real_name(real_table_name, &column_name)
230− .unwrap_or(&column_name);
231− (column_name.to_string(), real_name.to_string())
265+ .unwrap_or_else(|| real_name.to_string());
232− };
233
266
234 columns.push(Column {
267 columns.push(Column {
235 name,
268 name,
236 real_name,
269 real_name,
237 data_type,
270 data_type,
238 nullable,
271 nullable,
272+ default,
239 });
273 });
240 }
274 }
241
275
242− let table_name = self
276+ let current_table_name = table_changes
243− .get_table_alias_from_real_name(real_table_name)
277+ .map(|changes| changes.current_name.as_ref())
244− .unwrap_or_else(|| real_table_name.to_string());
278+ .unwrap_or_else(|| real_table_name);
245
279
246 let table = Table {
280 let table = Table {
247− name: table_name,
281+ name: current_table_name.to_string(),
248 real_name: real_table_name.to_string(),
282 real_name: real_table_name.to_string(),
249− columns: columns,
283+ columns,
250 };
284 };
251
285
252 Ok(table)
286 Ok(table)
253 }
287 }
254}
288}
255
289
256−fn is_column_temporary(name: &str) -> bool {
290+impl Table {
257− name.starts_with("__reshape_")
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+ }
258}
305}
src/state.rs+200−88
@@ -4,43 +4,51 @@ use anyhow::anyhow;
4use serde::{Deserialize, Serialize};
4use serde::{Deserialize, Serialize};
5use version::version;
5use version::version;
6
6
7−#[derive(Serialize, Deserialize, Debug)]
7+#[derive(Serialize, Deserialize, Clone, 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−
15−#[derive(Serialize, Deserialize, Debug)]
16−#[serde(tag = "status")]
8+#[serde(tag = "state")]
17−pub enum Status {
9+pub enum State {
18 #[serde(rename = "idle")]
10 #[serde(rename = "idle")]
19 Idle,
11 Idle,
20
12
13+ #[serde(rename = "applying")]
14+ Applying { migrations: Vec<Migration> },
15+
21 #[serde(rename = "in_progress")]
16 #[serde(rename = "in_progress")]
22 InProgress { migrations: Vec<Migration> },
17 InProgress { migrations: Vec<Migration> },
18+
19+ #[serde(rename = "completing")]
20+ Completing {
21+ migrations: Vec<Migration>,
22+ current_migration_index: usize,
23+ current_action_index: usize,
24+ },
25+
26+ #[serde(rename = "aborting")]
27+ Aborting {
28+ migrations: Vec<Migration>,
29+ last_migration_index: usize,
30+ last_action_index: usize,
31+ },
23}
32}
24
33
25impl State {
34impl State {
26− pub fn load(db: &mut impl Conn) -> State {
35+ pub fn load(db: &mut impl Conn) -> anyhow::Result<State> {
27− Self::ensure_schema_and_table(db);
36+ Self::ensure_schema_and_table(db)?;
28
37
29− let results = db
30− .query("SELECT value FROM reshape.data WHERE key = 'state'")
38+ let results = db.query("SELECT value FROM reshape.data WHERE key = 'state'")?;
31− .unwrap();
32
39
33− match results.first() {
40+ let state = match results.first() {
34 Some(row) => {
41 Some(row) => {
35 let json: serde_json::Value = row.get(0);
42 let json: serde_json::Value = row.get(0);
36− serde_json::from_value(json).unwrap()
43+ serde_json::from_value(json)?
37 }
44 }
38 None => Default::default(),
45 None => Default::default(),
39− }
46+ };
47+ Ok(state)
40 }
48 }
41
49
42 pub fn save(&self, db: &mut impl Conn) -> anyhow::Result<()> {
50 pub fn save(&self, db: &mut impl Conn) -> anyhow::Result<()> {
43− Self::ensure_schema_and_table(db);
51+ Self::ensure_schema_and_table(db)?;
44
52
45 let json = serde_json::to_value(self)?;
53 let json = serde_json::to_value(self)?;
46 db.query_with_params(
54 db.query_with_params(
@@ -53,108 +61,212 @@ impl State {
53 pub fn clear(&mut self, db: &mut impl Conn) -> anyhow::Result<()> {
61 pub fn clear(&mut self, db: &mut impl Conn) -> anyhow::Result<()> {
54 db.run("DROP SCHEMA reshape CASCADE")?;
62 db.run("DROP SCHEMA reshape CASCADE")?;
55
63
56− let default = Self::default();
64+ *self = Self::default();
57− self.status = default.status;
58− self.current_migration = default.current_migration;
59− self.migrations = default.migrations;
60
65
61 Ok(())
66 Ok(())
62 }
67 }
63
68
64− pub fn set_migrations<T>(&mut self, migrations: T) -> Result<(), anyhow::Error>
69+ // Complete will change the state from Completing to Idle
65− where
70+ pub fn complete(&mut self, db: &mut impl Conn) -> anyhow::Result<()> {
66− T: IntoIterator<Item = Migration>,
71+ let current_state = std::mem::replace(self, Self::Idle);
67− {
72+
68− let mut new_iter = migrations.into_iter();
73+ match current_state {
74+ Self::Completing { migrations, .. } => {
75+ // Add migrations and update state in a transaction to ensure atomicity
76+ let mut transaction = db.transaction()?;
77+ save_migrations(&mut transaction, &migrations)?;
78+ self.save(&mut transaction)?;
79+ transaction.commit()?;
80+ }
81+ _ => {
82+ // Move old state back
83+ *self = current_state;
69
84
70− // Ensure the new migration match up with the existing ones
71− for pair in self.migrations.iter().zip(new_iter.by_ref()) {
72− let (existing, ref new) = pair;
73− if existing != new {
74 return Err(anyhow!(
85 return Err(anyhow!(
75− "existing migration {} does not match new migration {}",
86+ "couldn't update state to be completed, not in Completing state"
76− existing.name,
77− new.name
78 ));
87 ));
79 }
88 }
80 }
89 }
81
90
82− // Add any new migrations
83− self.migrations.extend(new_iter);
84 Ok(())
91 Ok(())
85 }
92 }
86
93
87− pub fn add_migrations<'a>(&mut self, new_migrations: impl IntoIterator<Item = &'a Migration>) {
94+ pub fn applying(&mut self, new_migrations: Vec<Migration>) {
88− for migration in new_migrations.into_iter() {
95+ *self = Self::Applying {
89− self.migrations.push(migration.clone());
96+ migrations: new_migrations,
90− }
97+ };
91 }
98 }
92
99
93− // Complete will change the status from InProgress to Idle
100+ pub fn in_progress(&mut self, new_migrations: Vec<Migration>) {
94− pub fn complete(&mut self) -> anyhow::Result<()> {
101+ *self = Self::InProgress {
95− let current_status = std::mem::replace(&mut self.status, Status::Idle);
102+ migrations: new_migrations,
103+ };
104+ }
96
105
97− match current_status {
106+ pub fn completing(
98− Status::Idle => {
107+ &mut self,
99− // Move old status back
108+ migrations: Vec<Migration>,
100− self.status = current_status;
109+ current_migration_index: usize,
101− return Err(anyhow!("status is not in progress"));
110+ current_action_index: usize,
102− }
111+ ) {
103− Status::InProgress { mut migrations } => {
112+ *self = Self::Completing {
104− let target_migration = migrations.last().unwrap().name.to_string();
113+ migrations,
105− self.migrations.append(&mut migrations);
114+ current_migration_index,
106− self.current_migration = Some(target_migration);
115+ current_action_index,
107− }
116+ }
117+ }
118+
119+ pub fn aborting(
120+ &mut self,
121+ migrations: Vec<Migration>,
122+ last_migration_index: usize,
123+ last_action_index: usize,
124+ ) {
125+ *self = Self::Aborting {
126+ migrations,
127+ last_migration_index,
128+ last_action_index,
108 }
129 }
130+ }
131+
132+ fn ensure_schema_and_table(db: &mut impl Conn) -> anyhow::Result<()> {
133+ db.run("CREATE SCHEMA IF NOT EXISTS reshape")?;
134+
135+ // Create data table which will be a key-value table containing
136+ // the version and current state.
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+ )?;
109
162
110 Ok(())
163 Ok(())
111 }
164 }
165+}
112
166
113− pub fn in_progress(&mut self, new_migrations: Vec<Migration>) {
167+impl Default for State {
114− self.status = Status::InProgress {
168+ fn default() -> Self {
115− migrations: new_migrations,
169+ Self::Idle
116− };
117 }
170 }
171+}
172+
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
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 {
203+ highest_index = Some(index);
118
204
119− pub fn get_remaining_migrations(
205+ let new = match new_iter.next() {
120− &self,
206+ Some(migration) => migration,
121− new_migrations: impl IntoIterator<Item = Migration>,
207+ None => {
122− ) -> anyhow::Result<Vec<Migration>> {
208+ return Err(anyhow!(
123− let mut new_iter = new_migrations.into_iter();
209+ "existing migration {} doesn't exist in local migrations",
210+ existing
211+ ))
212+ }
213+ };
124
214
125− // Ensure the new migration match up with the existing ones
126− for pair in self.migrations.iter().zip(new_iter.by_ref()) {
127− let (existing, ref new) = pair;
128− if existing != new {
215+ if existing != new.name {
129 return Err(anyhow!(
216 return Err(anyhow!(
130 "existing migration {} does not match new migration {}",
217 "existing migration {} does not match new migration {}",
131− existing.name,
218+ existing,
132 new.name
219 new.name
133 ));
220 ));
134 }
221 }
135 }
222 }
136−
137− let items: Vec<Migration> = new_iter.collect();
138−
139− // Return the remaining migrations
140− Ok(items)
141 }
223 }
142
224
143− fn ensure_schema_and_table(db: &mut impl Conn) {
225+ // Return the remaining migrations
144− db.run("CREATE SCHEMA IF NOT EXISTS reshape").unwrap();
226+ let items: Vec<Migration> = new_iter.collect();
227+ Ok(items)
228+}
145
229
146− db.run("CREATE TABLE IF NOT EXISTS reshape.data (key TEXT PRIMARY KEY, value JSONB)")
230+fn get_migrations(
147− .unwrap();
231+ db: &mut impl Conn,
148− }
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
250+ LIMIT 100
251+ ",
252+ )?
253+ };
254+
255+ let migrations = rows
256+ .iter()
257+ .map(|row| (row.get("index"), row.get("name")))
258+ .collect();
259+ Ok(migrations)
149}
260}
150
261
151−impl Default for State {
262+fn save_migrations(db: &mut impl Conn, migrations: &[Migration]) -> anyhow::Result<()> {
152− fn default() -> Self {
263+ for migration in migrations {
153− State {
264+ let encoded_actions = serde_json::to_value(&migration.actions)?;
154− version: version!().to_string(),
265+ db.query_with_params(
155− status: Status::Idle,
266+ "INSERT INTO reshape.migrations(name, description, actions) VALUES ($1, $2, $3)",
156− current_migration: None,
267+ &[&migration.name, &migration.description, &encoded_actions],
157− migrations: vec![],
268+ )?;
158− }
159 }
269 }
270+
271+ Ok(())
160}
272}
tests/add_column.rs+316−262
@@ -1,86 +1,60 @@
1−use reshape::migrations::{AddColumn, Column, CreateTable, Migration};
2−use reshape::Status;
3−
4mod common;
1mod common;
2+use common::Test;
5
3
6#[test]
4#[test]
7fn add_column() {
5fn add_column() {
8− let (mut reshape, mut old_db, mut new_db) = common::setup();
6+ let mut test = Test::new("Add column");
9−
7+
10− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
8+ test.first_migration(
9+ r#"
10+ name = "create_user_table"
11+
12+ [[actions]]
13+ type = "create_table"
11− name: "users".to_string(),
14+ name = "users"
12− primary_key: vec!["id".to_string()],
15+ primary_key = ["id"]
13− foreign_keys: vec![],
16+
14− columns: vec![
17+ [[actions.columns]]
15− Column {
18+ name = "id"
16− name: "id".to_string(),
19+ type = "INTEGER"
17− data_type: "SERIAL".to_string(),
20+
18− nullable: true,
21+ [[actions.columns]]
19− default: None,
22+ name = "name"
20− generated: None,
23+ type = "TEXT"
21− },
24+ "#,
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_last_name_columns = Migration::new("add_first_and_last_name_columns", None)
32− .with_action(AddColumn {
33− table: "users".to_string(),
34− column: Column {
35− name: "first".to_string(),
36− data_type: "TEXT".to_string(),
37− nullable: false,
38− default: None,
39− generated: None,
40− },
41− up: Some("(STRING_TO_ARRAY(name, ' '))[1]".to_string()),
42− })
43− .with_action(AddColumn {
44− table: "users".to_string(),
45− column: Column {
46− name: "last".to_string(),
47− data_type: "TEXT".to_string(),
48− nullable: false,
49− default: None,
50− generated: None,
51− },
52− up: Some("(STRING_TO_ARRAY(name, ' '))[2]".to_string()),
53− });
54−
55− let first_migrations = vec![create_users_table.clone()];
56− let second_migrations = vec![
57− create_users_table.clone(),
58− add_first_last_name_columns.clone(),
59− ];
60−
61− // Run first migration, should automatically finish
62− reshape.migrate(first_migrations.clone()).unwrap();
63− assert!(matches!(reshape.state.status, Status::Idle));
64− assert_eq!(
65− Some(&create_users_table.name),
66− reshape.state.current_migration.as_ref()
67 );
25 );
68
26
69− // Update search paths
27+ test.second_migration(
70− old_db
28+ r#"
71− .simple_query(&reshape::schema_query_for_migration(
29+ name = "add_first_and_last_name_columns"
72− &first_migrations.last().unwrap().name,
30+
73− ))
31+ [[actions]]
74− .unwrap();
32+ type = "add_column"
75− new_db
33+ table = "users"
76− .simple_query(&reshape::schema_query_for_migration(
77− &first_migrations.last().unwrap().name,
78− ))
79− .unwrap();
80
34
35+ up = "(STRING_TO_ARRAY(name, ' '))[1]"
36+
37+ [actions.column]
38+ name = "first"
39+ type = "TEXT"
40+ nullable = false
41+
42+ [[actions]]
43+ type = "add_column"
44+ table = "users"
45+
46+ up = "(STRING_TO_ARRAY(name, ' '))[2]"
47+
48+ [actions.column]
49+ name = "last"
50+ type = "TEXT"
51+ nullable = false
52+ "#,
53+ );
54+
55+ test.after_first(|db| {
81− // Insert some test users
56+ // Insert some test users
82− new_db
83− .simple_query(
57+ db.simple_query(
84 "
58 "
85 INSERT INTO users (id, name) VALUES
59 INSERT INTO users (id, name) VALUES
86 (1, 'John Doe'),
60 (1, 'John Doe'),
@@ -88,220 +62,300 @@ fn add_column() {
88 ",
62 ",
89 )
63 )
90 .unwrap();
64 .unwrap();
65+ });
91
66
92− // Run second migration
67+ test.intermediate(|old_db, new_db| {
93− reshape.migrate(second_migrations.clone()).unwrap();
68+ // Check that the existing users have the new columns populated
94− new_db
69+ let expected = vec![("John", "Doe"), ("Jane", "Doe")];
95− .simple_query(&reshape::schema_query_for_migration(
70+ assert!(new_db
96− &second_migrations.last().unwrap().name,
71+ .query("SELECT first, last FROM users ORDER BY id", &[],)
97− ))
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")))
98− .unwrap();
84+ .unwrap();
85+ assert_eq!(
86+ ("Test", "Testsson"),
87+ (first_name.as_ref(), last_name.as_ref())
88+ );
89+ });
99
90
100− // Check that the existing users have the new columns populated
91+ test.after_completion(|db| {
101− let expected = vec![("John", "Doe"), ("Jane", "Doe")];
92+ let expected = vec![("John", "Doe"), ("Jane", "Doe"), ("Test", "Testsson")];
102− assert!(new_db
93+ assert!(db
103− .query("SELECT first, last FROM users ORDER BY id", &[],)
94+ .query("SELECT first, last FROM users ORDER BY id", &[],)
104− .unwrap()
95+ .unwrap()
105− .iter()
96+ .iter()
106− .map(|row| (row.get("first"), row.get("last")))
97+ .map(|row| (row.get("first"), row.get("last")))
107− .eq(expected));
98+ .eq(expected));
108−
99+ });
109− // Insert data using old schema and make sure the new columns are populated
100+
110− old_db
101+ test.after_abort(|db| {
111− .simple_query("INSERT INTO users (id, name) VALUES (3, 'Test Testsson')")
102+ let expected = vec![("John Doe"), ("Jane Doe"), ("Test Testsson")];
112− .unwrap();
103+ assert!(db
113− let (first_name, last_name): (String, String) = new_db
104+ .query("SELECT name FROM users ORDER BY id", &[],)
114− .query_one("SELECT first, last from users WHERE id = 3", &[])
105+ .unwrap()
106+ .iter()
115− .map(|row| (row.get("first"), row.get("last")))
107+ .map(|row| row.get::<'_, _, String>("name"))
116− .unwrap();
108+ .eq(expected));
117− assert_eq!(
118− ("Test", "Testsson"),
119− (first_name.as_ref(), last_name.as_ref())
120− );
109+ });
121
110
122− reshape.complete_migration().unwrap();
111+ test.run()
123}
112}
124
113
125#[test]
114#[test]
126fn add_column_nullable() {
115fn add_column_nullable() {
127− let (mut reshape, mut old_db, mut new_db) = common::setup();
116+ let mut test = Test::new("Add nullable column");
128−
117+
129− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
118+ test.first_migration(
130− name: "users".to_string(),
119+ r#"
131− primary_key: vec!["id".to_string()],
120+ name = "create_users_table"
132− foreign_keys: vec![],
133− columns: vec![Column {
134− name: "id".to_string(),
135− data_type: "INTEGER".to_string(),
136− nullable: true,
137− default: None,
138− generated: None,
139− }],
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− });
152
121
153− let first_migrations = vec![create_users_table.clone()];
122+ [[actions]]
154− let second_migrations = vec![create_users_table.clone(), add_name_column.clone()];
123+ type = "create_table"
124+ name = "users"
125+ primary_key = ["id"]
155
126
156− // Run first migration, should automatically finish
127+ [[actions.columns]]
157− reshape.migrate(first_migrations.clone()).unwrap();
128+ name = "id"
158− assert!(matches!(reshape.state.status, Status::Idle));
129+ type = "INTEGER"
159− assert_eq!(
130+ "#,
160− Some(&create_users_table.name),
161− reshape.state.current_migration.as_ref()
162 );
131 );
163
132
164− // Update search paths
133+ test.second_migration(
165− old_db
134+ r#"
166− .simple_query(&reshape::schema_query_for_migration(
135+ name = "add_nullable_name_column"
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
136
137+ [[actions]]
138+ type = "add_column"
139+ table = "users"
140+
141+ [actions.column]
142+ name = "name"
143+ type = "TEXT"
144+ "#,
145+ );
146+
147+ test.after_first(|db| {
176− // Insert some test values
148+ // Insert some test values
177− new_db
178− .simple_query(
149+ db.simple_query(
179 "
150 "
180− INSERT INTO users (id) VALUES
151+ INSERT INTO users (id) VALUES (1), (2);
181− (1),
182− (2);
183 ",
152 ",
184 )
153 )
185 .unwrap();
154 .unwrap();
155+ });
186
156
187− // Run second migration
157+ test.intermediate(|old_db, new_db| {
188− reshape.migrate(second_migrations.clone()).unwrap();
189− new_db
190− .simple_query(&reshape::schema_query_for_migration(
191− &second_migrations.last().unwrap().name,
192− ))
193− .unwrap();
194−
195− // Ensure existing data got updated
158+ // Ensure existing data got updated
196− let expected: Vec<Option<String>> = vec![None, None];
159+ let expected: Vec<Option<String>> = vec![None, None];
197− assert!(new_db
160+ assert!(new_db
198− .query("SELECT name FROM users ORDER BY id", &[],)
161+ .query("SELECT name FROM users ORDER BY id", &[],)
199− .unwrap()
162+ .unwrap()
200− .iter()
163+ .iter()
201− .map(|row| row.get::<_, Option<String>>("name"))
164+ .map(|row| row.get::<_, Option<String>>("name"))
202− .eq(expected));
165+ .eq(expected));
203−
166+
204− // Insert data using old schema and ensure new column is NULL
167+ // Insert data using old schema and ensure new column is NULL
205− old_db
168+ old_db
206− .simple_query("INSERT INTO users (id) VALUES (3)")
169+ .simple_query("INSERT INTO users (id) VALUES (3)")
207− .unwrap();
170+ .unwrap();
208− let name: Option<String> = new_db
171+ let name: Option<String> = new_db
209− .query_one("SELECT name from users WHERE id = 3", &[])
172+ .query_one("SELECT name from users WHERE id = 3", &[])
210− .map(|row| (row.get("name")))
173+ .map(|row| (row.get("name")))
211− .unwrap();
174+ .unwrap();
212− assert_eq!(None, name);
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();
181+ });
213
182
214− // Ensure data can be inserted against new schema
183+ test.after_completion(|db| {
215− new_db
184+ let expected: Vec<Option<String>> =
216− .simple_query("INSERT INTO users (id, name) VALUES (4, 'Test Testsson'), (5, NULL)")
185+ vec![None, None, None, Some("Test Testsson".to_string()), None];
186+ let result: Vec<Option<String>> = db
187+ .query("SELECT id, name FROM users ORDER BY id", &[])
217− .unwrap();
188+ .unwrap()
189+ .iter()
190+ .map(|row| row.get("name"))
191+ .collect();
192+
193+ assert_eq!(result, expected);
194+ });
218
195
219− reshape.complete_migration().unwrap();
196+ test.run();
220}
197}
221
198
222#[test]
199#[test]
223fn add_column_with_default() {
200fn add_column_with_default() {
224− let (mut reshape, mut old_db, mut new_db) = common::setup();
201+ let mut test = Test::new("Add column with default value");
225−
202+
226− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
203+ test.first_migration(
204+ r#"
205+ name = "create_users_table"
206+
207+ [[actions]]
208+ type = "create_table"
227− name: "users".to_string(),
209+ name = "users"
228− primary_key: vec!["id".to_string()],
210+ primary_key = ["id"]
229− foreign_keys: vec![],
211+
230− columns: vec![Column {
212+ [[actions.columns]]
231− name: "id".to_string(),
213+ name = "id"
232− data_type: "INTEGER".to_string(),
214+ type = "INTEGER"
215+ "#,
216+ );
217+
218+ test.second_migration(
219+ r#"
220+ name = "add_name_column_with_default"
221+
222+ [[actions]]
223+ type = "add_column"
224+ table = "users"
225+
226+ [actions.column]
227+ name = "name"
228+ type = "TEXT"
233− nullable: true,
229+ nullable = false
234− default: None,
230+ default = "'DEFAULT'"
235− generated: None,
231+ "#,
236− }],
232+ );
233+
234+ test.after_first(|db| {
235+ // Insert some test values
236+ db.simple_query("INSERT INTO users (id) VALUES (1), (2)")
237+ .unwrap();
237 });
238 });
238− let add_name_column =
239+
239− Migration::new("add_name_column_with_default", None).with_action(AddColumn {
240+ test.intermediate(|old_db, new_db| {
240− table: "users".to_string(),
241+ // Ensure existing data got updated with defaults
241− column: Column {
242+ let expected = vec!["DEFAULT".to_string(), "DEFAULT".to_string()];
242− name: "name".to_string(),
243+ assert!(new_db
243− data_type: "TEXT".to_string(),
244+ .query("SELECT name FROM users ORDER BY id", &[],)
244− nullable: false,
245+ .unwrap()
245− default: Some("'DEFAULT'".to_string()),
246+ .iter()
246− generated: None,
247+ .map(|row| row.get::<_, String>("name"))
247− },
248+ .eq(expected));
248− up: None,
249+
249− });
250+ // Insert data using old schema and ensure new column gets the default value
250−
251+ old_db
251− let first_migrations = vec![create_users_table.clone()];
252+ .simple_query("INSERT INTO users (id) VALUES (3)")
252− let second_migrations = vec![create_users_table.clone(), add_name_column.clone()];
253+ .unwrap();
253−
254+ let name: String = new_db
254− // Run first migration, should automatically finish
255+ .query_one("SELECT name from users WHERE id = 3", &[])
255− reshape.migrate(first_migrations.clone()).unwrap();
256+ .map(|row| row.get("name"))
256− assert!(matches!(reshape.state.status, Status::Idle));
257+ .unwrap();
257− assert_eq!(
258+ assert_eq!("DEFAULT", name);
258− Some(&create_users_table.name),
259+ });
259− reshape.state.current_migration.as_ref()
260+
261+ test.run();
262+}
263+
264+#[test]
265+fn add_column_with_complex_up() {
266+ let mut test = Test::new("Add column complex");
267+
268+ test.first_migration(
269+ r#"
270+ name = "create_tables"
271+
272+ [[actions]]
273+ type = "create_table"
274+ name = "users"
275+ primary_key = ["id"]
276+
277+ [[actions.columns]]
278+ name = "id"
279+ type = "INTEGER"
280+
281+ [[actions.columns]]
282+ name = "email"
283+ type = "TEXT"
284+
285+ [[actions]]
286+ type = "create_table"
287+ name = "profiles"
288+ primary_key = ["user_id"]
289+
290+ [[actions.columns]]
291+ name = "user_id"
292+ type = "INTEGER"
293+ "#,
260 );
294 );
261
295
262− // Update search paths
296+ test.second_migration(
263− old_db
297+ r#"
264− .simple_query(&reshape::schema_query_for_migration(
298+ name = "add_profiles_email_column"
265− &first_migrations.last().unwrap().name,
266− ))
267− .unwrap();
268− new_db
269− .simple_query(&reshape::schema_query_for_migration(
270− &first_migrations.last().unwrap().name,
271− ))
272− .unwrap();
273
299
274− // Insert some test values
300+ [[actions]]
275− new_db
301+ type = "add_column"
276− .simple_query("INSERT INTO users (id) VALUES (1), (2)")
302+ table = "profiles"
277− .unwrap();
278
303
279− // Run second migration
304+ [actions.column]
280− reshape.migrate(second_migrations.clone()).unwrap();
305+ name = "email"
281− new_db
306+ type = "TEXT"
282− .simple_query(&reshape::schema_query_for_migration(
307+ nullable = false
283− &second_migrations.last().unwrap().name,
284− ))
285− .unwrap();
286
308
287− // Ensure existing data got updated with defaults
309+ [actions.up]
288− let expected = vec!["DEFAULT".to_string(), "DEFAULT".to_string()];
310+ table = "users"
289− assert!(new_db
311+ value = "users.email"
290− .query("SELECT name FROM users ORDER BY id", &[],)
312+ where = "profiles.user_id = users.id"
313+ "#,
314+ );
315+
316+ test.after_first(|db| {
317+ db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test@example.com')")
318+ .unwrap();
319+ db.simple_query("INSERT INTO profiles (user_id) VALUES (1)")
320+ .unwrap();
321+ });
322+
323+ test.intermediate(|old_db, new_db| {
324+ // Ensure email was backfilled on profiles
325+ let email: String = new_db
326+ .query(
327+ "
328+ SELECT email
329+ FROM profiles
330+ WHERE user_id = 1
331+ ",
332+ &[],
333+ )
291− .unwrap()
334+ .unwrap()
292− .iter()
335+ .first()
293− .map(|row| row.get::<_, String>("name"))
336+ .map(|row| row.get("email"))
294− .eq(expected));
337+ .unwrap();
295−
338+ assert_eq!("test@example.com", email);
296− // Insert data using old schema and ensure new column gets the default value
339+
340+ // Ensure email change in old schema is propagated to profiles table in new schema
297− old_db
341+ old_db
298− .simple_query("INSERT INTO users (id) VALUES (3)")
342+ .simple_query("UPDATE users SET email = 'test2@example.com' WHERE id = 1")
299− .unwrap();
343+ .unwrap();
300− let name: String = new_db
344+ let email: String = new_db
301− .query_one("SELECT name from users WHERE id = 3", &[])
345+ .query(
346+ "
347+ SELECT email
348+ FROM profiles
349+ WHERE user_id = 1
350+ ",
351+ &[],
352+ )
353+ .unwrap()
354+ .first()
302− .map(|row| row.get("name"))
355+ .map(|row| row.get("email"))
303− .unwrap();
356+ .unwrap();
304− assert_eq!("DEFAULT", name);
357+ assert_eq!("test2@example.com", email);
358+ });
305
359
306− reshape.complete_migration().unwrap();
360+ test.run();
307}
361}
tests/add_foreign_key.rsnew file+166
@@ -0,0 +1,166 @@
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+216−65
@@ -1,72 +1,223 @@
1−use reshape::migrations::{AddIndex, Column, CreateTable, Migration};
2−
3mod common;
1mod common;
2+use common::Test;
4
3
5#[test]
4#[test]
6fn add_index() {
5fn add_index() {
7− let (mut reshape, mut old_db, mut new_db) = common::setup();
6+ let mut test = Test::new("Add index");
8−
7+
9− let create_table_migration =
8+ test.first_migration(
9+ r#"
10+ name = "create_users_table"
11+
12+ [[actions]]
13+ type = "create_table"
14+ name = "users"
15+ primary_key = ["id"]
16+
17+ [[actions.columns]]
18+ name = "id"
19+ type = "INTEGER"
20+
21+ [[actions.columns]]
22+ name = "name"
23+ type = "TEXT"
24+ "#,
25+ );
26+
27+ test.second_migration(
28+ r#"
29+ name = "add_users_name_index"
30+
31+ [[actions]]
32+ type = "add_index"
33+ table = "users"
34+
35+ [actions.index]
36+ name = "name_idx"
37+ columns = ["name"]
38+ "#,
39+ );
40+
41+ test.intermediate(|db, _| {
42+ // Ensure index is valid and ready
43+ let (is_ready, is_valid): (bool, bool) = db
44+ .query(
45+ "
46+ SELECT pg_index.indisready, pg_index.indisvalid
47+ FROM pg_catalog.pg_index
48+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
49+ WHERE pg_class.relname = 'name_idx'
50+ ",
51+ &[],
52+ )
53+ .unwrap()
54+ .first()
55+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
56+ .unwrap();
57+
58+ assert!(is_ready, "expected index to be ready");
59+ assert!(is_valid, "expected index to be valid");
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#"
10− Migration::new("create_users_table", None).with_action(CreateTable {
92+ name = "create_users_table"
93+
94+ [[actions]]
95+ type = "create_table"
11− name: "users".to_string(),
96+ name = "users"
12− primary_key: vec!["id".to_string()],
97+ primary_key = ["id"]
13− foreign_keys: vec![],
98+
14− columns: vec![
99+ [[actions.columns]]
15− Column {
100+ name = "id"
16− name: "id".to_string(),
101+ type = "INTEGER"
17− data_type: "INTEGER".to_string(),
102+
18− nullable: true,
103+ [[actions.columns]]
19− default: None,
104+ name = "name"
20− generated: None,
105+ type = "TEXT"
21− },
106+ "#,
22− Column {
107+ );
23− name: "name".to_string(),
108+
24− data_type: "TEXT".to_string(),
109+ test.second_migration(
25− nullable: false,
110+ r#"
26− default: None,
111+ name = "add_name_index"
27− generated: None,
112+
28− },
113+ [[actions]]
29− ],
114+ type = "add_index"
30− });
115+ table = "users"
31− let add_index_migration = Migration::new("add_name_index", None).with_action(AddIndex {
116+
32− table: "users".to_string(),
117+ [actions.index]
33− name: "name_idx".to_string(),
118+ name = "name_idx"
34− columns: vec!["name".to_string()],
119+ columns = ["name"]
120+ unique = true
121+ "#,
122+ );
123+
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"
185+
186+ [actions.index]
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");
35 });
220 });
36
221
37− let first_migrations = vec![create_table_migration.clone()];
222+ test.run();
38− let second_migrations = vec![create_table_migration.clone(), add_index_migration.clone()];
39−
40− // Run migrations
41− reshape.migrate(first_migrations.clone()).unwrap();
42− reshape.migrate(second_migrations.clone()).unwrap();
43−
44− // Update schemas of Postgres connections
45− let old_schema_query =
46− reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
47− let new_schema_query =
48− reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
49− println!("{}", new_schema_query);
50− old_db.simple_query(&old_schema_query).unwrap();
51− new_db.simple_query(&new_schema_query).unwrap();
52−
53− // Ensure index is valid and ready
54− let result: Vec<(bool, bool)> = new_db
55− .query(
56− "
57− SELECT pg_index.indisready, pg_index.indisvalid
58− FROM pg_catalog.pg_index
59− JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
60− WHERE pg_class.relname = 'name_idx'
61− ",
62− &[],
63− )
64− .unwrap()
65− .iter()
66− .map(|row| (row.get("indisready"), row.get("indisvalid")))
67− .collect();
68−
69− assert_eq!(vec![(true, true)], result);
70−
71− reshape.complete_migration().unwrap();
72}
223}
tests/alter_column.rs+661−323
@@ -1,66 +1,45 @@
1−use reshape::migrations::{AlterColumn, Column, ColumnChanges, CreateTable, Migration};
2−use reshape::Status;
3−
4mod common;
1mod common;
2+use common::Test;
5
3
6#[test]
4#[test]
7fn alter_column_data() {
5fn alter_column_data() {
8− let (mut reshape, mut old_db, mut new_db) = common::setup();
6+ let mut test = Test::new("Alter column");
9−
7+
10− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
8+ test.first_migration(
11− name: "users".to_string(),
9+ r#"
12− primary_key: vec!["id".to_string()],
10+ name = "create_user_table"
13− foreign_keys: vec![],
14− columns: vec![
15− Column {
16− name: "id".to_string(),
17− data_type: "INTEGER".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 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− },
41− });
42
11
43− let first_migrations = vec![create_users_table.clone()];
12+ [[actions]]
44− let second_migrations = vec![create_users_table.clone(), uppercase_name.clone()];
13+ type = "create_table"
14+ name = "users"
15+ primary_key = ["id"]
45
16
46− // Run first migration, should automatically finish
17+ [[actions.columns]]
47− reshape.migrate(first_migrations.clone()).unwrap();
18+ name = "id"
48− assert!(matches!(reshape.state.status, Status::Idle));
19+ type = "INTEGER"
49− assert_eq!(
20+
50− Some(&create_users_table.name),
21+ [[actions.columns]]
51− reshape.state.current_migration.as_ref()
22+ name = "name"
23+ type = "TEXT"
24+ "#,
52 );
25 );
53
26
54− // Update search paths
27+ test.second_migration(
55− old_db
28+ r#"
56− .simple_query(&reshape::schema_query_for_migration(
29+ name = "uppercase_name"
57− &first_migrations.last().unwrap().name,
30+
58− ))
31+ [[actions]]
59− .unwrap();
32+ type = "alter_column"
33+ table = "users"
34+ column = "name"
35+ up = "UPPER(name)"
36+ down = "LOWER(name)"
37+ "#,
38+ );
60
39
40+ test.after_first(|db| {
61− // Insert some test users
41+ // Insert some test users
62− old_db
63− .simple_query(
42+ db.simple_query(
64 "
43 "
65 INSERT INTO users (id, name) VALUES
44 INSERT INTO users (id, name) VALUES
66 (1, 'john Doe'),
45 (1, 'john Doe'),
@@ -68,103 +47,81 @@ fn alter_column_data() {
68 ",
47 ",
69 )
48 )
70 .unwrap();
49 .unwrap();
50+ });
71
51
72− // Run second migration
52+ test.intermediate(|old_db, new_db| {
73− reshape.migrate(second_migrations.clone()).unwrap();
74− new_db
75− .simple_query(&reshape::schema_query_for_migration(
76− &second_migrations.last().unwrap().name,
77− ))
78− .unwrap();
79−
80− // Check that the existing users has the altered data
53+ // Check that the existing users has the altered data
81− let expected = vec!["JOHN DOE", "JANE DOE"];
54+ let expected = vec!["JOHN DOE", "JANE DOE"];
82− assert!(new_db
55+ assert!(new_db
83− .query("SELECT name FROM users ORDER BY id", &[],)
56+ .query("SELECT name FROM users ORDER BY id", &[],)
84− .unwrap()
57+ .unwrap()
85− .iter()
58+ .iter()
86− .map(|row| row.get::<_, String>("name"))
59+ .map(|row| row.get::<_, String>("name"))
87− .eq(expected));
60+ .eq(expected));
88−
61+
89− // Insert data using old schema and make sure the new schema gets correct values
62+ // Insert data using old schema and make sure the new schema gets correct values
90− old_db
63+ old_db
91− .simple_query("INSERT INTO users (id, name) VALUES (3, 'test testsson')")
64+ .simple_query("INSERT INTO users (id, name) VALUES (3, 'test testsson')")
92− .unwrap();
65+ .unwrap();
93− let result = new_db
66+ let result = new_db
94− .query_one("SELECT name from users WHERE id = 3", &[])
67+ .query_one("SELECT name from users WHERE id = 3", &[])
95− .unwrap();
68+ .unwrap();
96− assert_eq!("TEST TESTSSON", result.get::<_, &str>("name"));
69+ assert_eq!("TEST TESTSSON", result.get::<_, &str>("name"));
97−
70+
98− // Insert data using new schema and make sure the old schema gets correct values
71+ // Insert data using new schema and make sure the old schema gets correct values
99− new_db
72+ new_db
100− .simple_query("INSERT INTO users (id, name) VALUES (4, 'TEST TESTSSON')")
73+ .simple_query("INSERT INTO users (id, name) VALUES (4, 'TEST TESTSSON')")
101− .unwrap();
74+ .unwrap();
102− let result = old_db
75+ let result = old_db
103− .query_one("SELECT name from users WHERE id = 4", &[])
76+ .query_one("SELECT name from users WHERE id = 4", &[])
104− .unwrap();
77+ .unwrap();
105− assert_eq!("test testsson", result.get::<_, &str>("name"));
78+ assert_eq!("test testsson", result.get::<_, &str>("name"));
79+ });
106
80
107− reshape.complete_migration().unwrap();
81+ test.run();
108}
82}
109
83
110#[test]
84#[test]
111fn alter_column_set_not_null() {
85fn alter_column_set_not_null() {
112− let (mut reshape, mut old_db, mut new_db) = common::setup();
86+ let mut test = Test::new("Set column not null");
113−
87+
114− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
88+ test.first_migration(
115− name: "users".to_string(),
89+ r#"
116− primary_key: vec!["id".to_string()],
90+ name = "create_user_table"
117− foreign_keys: vec![],
118− columns: vec![
119− Column {
120− name: "id".to_string(),
121− data_type: "INTEGER".to_string(),
122− nullable: true,
123− default: None,
124− generated: None,
125− },
126− Column {
127− name: "name".to_string(),
128− data_type: "TEXT".to_string(),
129− nullable: true,
130− default: None,
131− generated: None,
132− },
133− ],
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− },
145− });
146
91
147− let first_migrations = vec![create_users_table.clone()];
92+ [[actions]]
148− let second_migrations = vec![create_users_table.clone(), set_name_not_null.clone()];
93+ type = "create_table"
94+ name = "users"
95+ primary_key = ["id"]
149
96
150− // Run first migration, should automatically finish
97+ [[actions.columns]]
151− reshape.migrate(first_migrations.clone()).unwrap();
98+ name = "id"
152− assert!(matches!(reshape.state.status, Status::Idle));
99+ type = "INTEGER"
153− assert_eq!(
100+
154− Some(&create_users_table.name),
101+ [[actions.columns]]
155− reshape.state.current_migration.as_ref()
102+ name = "name"
103+ type = "TEXT"
104+ "#,
156 );
105 );
157
106
158− // Update search paths
107+ test.second_migration(
159− old_db
108+ r#"
160− .simple_query(&reshape::schema_query_for_migration(
109+ name = "set_name_not_null"
161− &first_migrations.last().unwrap().name,
162− ))
163− .unwrap();
164
110
111+ [[actions]]
112+ type = "alter_column"
113+ table = "users"
114+ column = "name"
115+ up = "COALESCE(name, 'TEST_DEFAULT_VALUE')"
116+
117+ [actions.changes]
118+ nullable = false
119+ "#,
120+ );
121+
122+ test.after_first(|db| {
165− // Insert some test users
123+ // Insert some test users
166− old_db
167− .simple_query(
124+ db.simple_query(
168 "
125 "
169 INSERT INTO users (id, name) VALUES
126 INSERT INTO users (id, name) VALUES
170 (1, 'John Doe'),
127 (1, 'John Doe'),
@@ -172,104 +129,180 @@ fn alter_column_set_not_null() {
172 ",
129 ",
173 )
130 )
174 .unwrap();
131 .unwrap();
132+ });
175
133
176− // Run second migration
134+ test.intermediate(|old_db, new_db| {
177− reshape.migrate(second_migrations.clone()).unwrap();
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();
178− new_db
148+ let result = new_db
179− .simple_query(&reshape::schema_query_for_migration(
149+ .query_one("SELECT name from users WHERE id = 3", &[])
180− &second_migrations.last().unwrap().name,
150+ .unwrap();
181− ))
151+ assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
182− .unwrap();
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+ });
183
166
184− // Check that existing users got the correct values
167+ test.after_completion(|db| {
185− let expected = vec!["John Doe", "TEST_DEFAULT_VALUE"];
168+ // Ensure NULL can't be inserted
186− assert!(new_db
187− .query("SELECT name FROM users ORDER BY id", &[],)
188− .unwrap()
189− .iter()
190− .map(|row| row.get::<_, String>("name"))
191− .eq(expected));
192−
193− // Insert data using old schema and make sure the new schema gets correct values
194− old_db
195− .simple_query("INSERT INTO users (id, name) VALUES (3, NULL)")
169+ let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
196− .unwrap();
170+ assert!(result.is_err(), "expected insert to fail");
197− let result = new_db
171+ });
198− .query_one("SELECT name from users WHERE id = 3", &[])
199− .unwrap();
200− assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
201
172
202− // Insert data using new schema and make sure the old schema gets correct values
173+ test.after_abort(|db| {
203− new_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+ "
204− .simple_query("INSERT INTO users (id, name) VALUES (4, 'Jane Doe')")
225+ INSERT INTO users (id, name) VALUES
205− .unwrap();
226+ (1, 'John Doe')
206− let result = old_db
227+ ",
207− .query_one("SELECT name from users WHERE id = 4", &[])
228+ )
208 .unwrap();
229 .unwrap();
230+ });
231+
232+ test.intermediate(|old_db, new_db| {
233+ // Insert data using new schema and make sure the old schema gets correct values
234+ new_db
235+ .simple_query("INSERT INTO users (id, name) VALUES (2, NULL)")
236+ .unwrap();
237+ let result = old_db
238+ .query_one("SELECT name from users WHERE id = 2", &[])
239+ .unwrap();
209− assert_eq!("Jane Doe", result.get::<_, &str>("name"));
240+ assert_eq!("TEST_DEFAULT_VALUE", result.get::<_, &str>("name"));
241+
242+ // Ensure NULL can't be inserted using the old schema
243+ let result = old_db.simple_query("INSERT INTO users (id, name) VALUES (3, NULL)");
244+ assert!(result.is_err(), "expected insert to fail");
245+
246+ // Ensure NULL can be inserted using the new schema
247+ let result = new_db.simple_query("INSERT INTO users (id, name) VALUES (4, NULL)");
248+ assert!(result.is_ok(), "expected insert to succeed");
249+ });
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+
257+ test.after_abort(|db| {
258+ // Ensure NULL can't be inserted
259+ let result = db.simple_query("INSERT INTO users (id, name) VALUES (5, NULL)");
260+ assert!(result.is_err(), "expected insert to fail");
261+ });
210
262
211− reshape.complete_migration().unwrap();
263+ test.run();
212}
264}
213
265
214#[test]
266#[test]
215fn alter_column_rename() {
267fn alter_column_rename() {
216− let (mut reshape, mut old_db, mut new_db) = common::setup();
268+ let mut test = Test::new("Rename column");
217−
269+
218− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
270+ test.first_migration(
271+ r#"
272+ name = "create_user_table"
273+
274+ [[actions]]
275+ type = "create_table"
219− name: "users".to_string(),
276+ name = "users"
220− primary_key: vec!["id".to_string()],
277+ primary_key = ["id"]
221− foreign_keys: vec![],
278+
222− columns: vec![
279+ [[actions.columns]]
223− Column {
280+ name = "id"
224− name: "id".to_string(),
281+ type = "INTEGER"
225− data_type: "INTEGER".to_string(),
282+
226− nullable: true,
283+ [[actions.columns]]
227− default: None,
228− generated: None,
229− },
230− Column {
231− name: "name".to_string(),
284+ name = "name"
232− data_type: "TEXT".to_string(),
285+ type = "TEXT"
233− nullable: true,
234− default: None,
235− generated: None,
236− },
237− ],
238− });
239− let rename_to_full_name =
240− Migration::new("rename_to_full_name", None).with_action(AlterColumn {
241− table: "users".to_string(),
242− column: "name".to_string(),
243− up: None, // up and down are not required when only renaming a column
244− down: None,
245− changes: ColumnChanges {
246− data_type: None,
247− nullable: None,
248− name: Some("full_name".to_string()),
249− },
286+ "#,
250− });
251−
252− let first_migrations = vec![create_users_table.clone()];
253− let second_migrations = vec![create_users_table.clone(), rename_to_full_name.clone()];
254−
255− // Run first migration, should automatically finish
256− reshape.migrate(first_migrations.clone()).unwrap();
257− assert!(matches!(reshape.state.status, Status::Idle));
258− assert_eq!(
259− Some(&create_users_table.name),
260− reshape.state.current_migration.as_ref()
261 );
287 );
262
288
263− // Update search paths
289+ test.second_migration(
264− old_db
290+ r#"
265− .simple_query(&reshape::schema_query_for_migration(
291+ name = "set_name_not_null"
266− &first_migrations.last().unwrap().name,
267− ))
268− .unwrap();
269
292
293+ [[actions]]
294+ type = "alter_column"
295+ table = "users"
296+ column = "name"
297+
298+ [actions.changes]
299+ name = "full_name"
300+ "#,
301+ );
302+
303+ test.after_first(|db| {
270− // Insert some test data
304+ // Insert some test data
271− old_db
272− .simple_query(
305+ db.simple_query(
273 "
306 "
274 INSERT INTO users (id, name) VALUES
307 INSERT INTO users (id, name) VALUES
275 (1, 'John Doe'),
308 (1, 'John Doe'),
@@ -277,97 +310,69 @@ fn alter_column_rename() {
277 ",
310 ",
278 )
311 )
279 .unwrap();
312 .unwrap();
313+ });
280
314
281− // Run second migration
282− reshape.migrate(second_migrations.clone()).unwrap();
283− new_db
315+ test.intermediate(|_, new_db| {
284− .simple_query(&reshape::schema_query_for_migration(
285− &second_migrations.last().unwrap().name,
286− ))
287− .unwrap();
288−
289− // Check that existing values can be queried using new column name
316+ // Check that existing values can be queried using new column name
290− let expected = vec!["John Doe", "Jane Doe"];
317+ let expected = vec!["John Doe", "Jane Doe"];
291− assert!(new_db
318+ assert!(new_db
292− .query("SELECT full_name FROM users ORDER BY id", &[],)
319+ .query("SELECT full_name FROM users ORDER BY id", &[],)
293− .unwrap()
320+ .unwrap()
294− .iter()
321+ .iter()
295− .map(|row| row.get::<_, String>("full_name"))
322+ .map(|row| row.get::<_, String>("full_name"))
296− .eq(expected));
323+ .eq(expected));
324+ });
297
325
298− reshape.complete_migration().unwrap();
326+ test.run();
299}
327}
300
328
301#[test]
329#[test]
302fn alter_column_multiple() {
330fn alter_column_multiple() {
303− let (mut reshape, mut old_db, mut new_db) = common::setup();
331+ let mut test = Test::new("Alter column value multiple times");
304−
332+
305− let create_users_table = Migration::new("create_users_table", None).with_action(CreateTable {
333+ test.first_migration(
334+ r#"
335+ name = "create_user_table"
336+
337+ [[actions]]
338+ type = "create_table"
306− name: "users".to_string(),
339+ name = "users"
307− primary_key: vec!["id".to_string()],
340+ primary_key = ["id"]
308− foreign_keys: vec![],
341+
309− columns: vec![
342+ [[actions.columns]]
310− Column {
311− name: "id".to_string(),
343+ name = "id"
312− data_type: "INTEGER".to_string(),
344+ type = "INTEGER"
313− nullable: true,
345+
314− default: None,
346+ [[actions.columns]]
315− generated: None,
316− },
317− Column {
318− name: "counter".to_string(),
347+ name = "counter"
319− data_type: "INTEGER".to_string(),
348+ type = "INTEGER"
320− nullable: false,
349+ nullable = false
321− default: None,
350+ "#,
322− generated: None,
323− },
324− ],
325− });
326− let increment_counter_twice = Migration::new("increment_counter_twice", None)
327− .with_action(AlterColumn {
328− table: "users".to_string(),
329− column: "counter".to_string(),
330− up: Some("counter + 1".to_string()),
331− down: Some("counter - 1".to_string()),
332− changes: ColumnChanges {
333− data_type: None,
334− nullable: None,
335− name: None,
336− },
337− })
338− .with_action(AlterColumn {
339− table: "users".to_string(),
340− column: "counter".to_string(),
341− up: Some("counter + 1".to_string()),
342− down: Some("counter - 1".to_string()),
343− changes: ColumnChanges {
344− data_type: None,
345− nullable: None,
346− name: None,
347− },
348− });
349−
350− let first_migrations = vec![create_users_table.clone()];
351− let second_migrations = vec![create_users_table.clone(), increment_counter_twice.clone()];
352−
353− // Run first migration, should automatically finish
354− reshape.migrate(first_migrations.clone()).unwrap();
355− assert!(matches!(reshape.state.status, Status::Idle));
356− assert_eq!(
357− Some(&create_users_table.name),
358− reshape.state.current_migration.as_ref()
359 );
351 );
360
352
361− // Update search paths
353+ test.second_migration(
362− old_db
354+ r#"
363− .simple_query(&reshape::schema_query_for_migration(
355+ name = "increment_counter_twice"
364− &first_migrations.last().unwrap().name,
356+
365− ))
357+ [[actions]]
366− .unwrap();
358+ type = "alter_column"
359+ table = "users"
360+ column = "counter"
361+ up = "counter + 1"
362+ down = "counter - 1"
363+
364+ [[actions]]
365+ type = "alter_column"
366+ table = "users"
367+ column = "counter"
368+ up = "counter + 1"
369+ down = "counter - 1"
370+ "#,
371+ );
367
372
373+ test.after_first(|db| {
368− // Insert some test data
374+ // Insert some test data
369− old_db
370− .simple_query(
375+ db.simple_query(
371 "
376 "
372 INSERT INTO users (id, counter) VALUES
377 INSERT INTO users (id, counter) VALUES
373 (1, 0),
378 (1, 0),
@@ -375,22 +380,355 @@ fn alter_column_multiple() {
375 ",
380 ",
376 )
381 )
377 .unwrap();
382 .unwrap();
383+ });
384+
385+ test.intermediate(|old_db, new_db| {
386+ // Check that the existing data has been updated
387+ let expected = vec![2, 102];
388+ let results: Vec<i32> = new_db
389+ .query("SELECT counter FROM users ORDER BY id", &[])
390+ .unwrap()
391+ .iter()
392+ .map(|row| row.get::<_, i32>("counter"))
393+ .collect();
394+ assert_eq!(expected, results);
395+
396+ // Update data using old schema and make sure it was updated for the new schema
397+ old_db
398+ .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
399+ .unwrap();
400+ let result: i32 = new_db
401+ .query("SELECT counter FROM users WHERE id = 1", &[])
402+ .unwrap()
403+ .iter()
404+ .map(|row| row.get("counter"))
405+ .nth(0)
406+ .unwrap();
407+ assert_eq!(52, result);
408+
409+ // Update data using new schema and make sure it was updated for the old schema
410+ new_db
411+ .query("UPDATE users SET counter = 50 WHERE id = 1", &[])
412+ .unwrap();
413+ let result: i32 = old_db
414+ .query("SELECT counter FROM users WHERE id = 1", &[])
415+ .unwrap()
416+ .iter()
417+ .map(|row| row.get("counter"))
418+ .nth(0)
419+ .unwrap();
420+ assert_eq!(48, result);
421+ });
422+
423+ test.run();
424+}
378
425
379− // Run second migration
426+#[test]
380− reshape.migrate(second_migrations.clone()).unwrap();
427+fn alter_column_default() {
381− new_db
428+ let mut test = Test::new("Change default value for column");
429+
430+ test.first_migration(
431+ r#"
432+ name = "create_user_table"
433+
434+ [[actions]]
435+ type = "create_table"
436+ name = "users"
437+ primary_key = ["id"]
438+
439+ [[actions.columns]]
440+ name = "id"
441+ type = "INTEGER"
442+
443+ [[actions.columns]]
444+ name = "name"
445+ type = "TEXT"
446+ nullable = false
447+ default = "'DEFAULT'"
448+ "#,
449+ );
450+
451+ test.second_migration(
452+ r#"
453+ name = "change_name_default"
454+
455+ [[actions]]
456+ type = "alter_column"
457+ table = "users"
458+ column = "name"
459+
460+ [actions.changes]
461+ default = "'NEW DEFAULT'"
462+ "#,
463+ );
464+
465+ test.after_first(|db| {
466+ // Insert a test user
382− .simple_query(&reshape::schema_query_for_migration(
467+ db.simple_query(
383− &second_migrations.last().unwrap().name,
468+ "
469+ INSERT INTO users (id) VALUES (1)
470+ ",
384− ))
471+ )
385 .unwrap();
472 .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+
504+ test.run();
505+}
506+
507+#[test]
508+fn alter_column_with_index() {
509+ let mut test = Test::new("Alter column with index");
510+
511+ test.first_migration(
512+ r#"
513+ name = "create_user_table"
514+
515+ [[actions]]
516+ type = "create_table"
517+ name = "users"
518+ primary_key = ["id"]
519+
520+ [[actions.columns]]
521+ name = "id"
522+ type = "INTEGER"
523+
524+ [[actions.columns]]
525+ name = "first_name"
526+ type = "TEXT"
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+ );
644+ });
645+
646+ test.after_completion(|db| {
647+ // Make sure index still exists
648+ let is_unique: bool = db
649+ .query(
650+ "
651+ SELECT pg_index.indisunique
652+ FROM pg_catalog.pg_index
653+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
654+ WHERE pg_class.relname = 'name_idx'
655+ ",
656+ &[],
657+ )
658+ .unwrap()
659+ .first()
660+ .map(|row| row.get("indisunique"))
661+ .unwrap();
662+ assert!(is_unique, "expected index to still be unique");
663+ });
664+
665+ test.run();
666+}
667+
668+#[test]
669+fn alter_column_with_hash_index() {
670+ let mut test = Test::new("Alter column with custom index type");
671+
672+ test.first_migration(
673+ r#"
674+ name = "create_user_table"
675+
676+ [[actions]]
677+ type = "create_table"
678+ name = "users"
679+ primary_key = ["id"]
680+
681+ [[actions.columns]]
682+ name = "id"
683+ type = "INTEGER"
684+
685+ [[actions.columns]]
686+ name = "name"
687+ type = "TEXT"
688+
689+ [[actions]]
690+ type = "add_index"
691+ table = "users"
692+
693+ [actions.index]
694+ name = "name_idx"
695+ columns = ["name"]
696+ type = "hash"
697+ "#,
698+ );
699+
700+ test.second_migration(
701+ r#"
702+ name = "uppercase_name"
703+
704+ [[actions]]
705+ type = "alter_column"
706+ table = "users"
707+ column = "name"
708+ up = "UPPER(name)"
709+ down = "LOWER(name)"
710+ "#,
711+ );
712+
713+ test.after_completion(|db| {
714+ // Make sure index still has type GIN
715+ let index_type: String = db
716+ .query(
717+ "
718+ SELECT pg_am.amname
719+ FROM pg_catalog.pg_index
720+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
721+ JOIN pg_catalog.pg_am ON pg_class.relam = pg_am.oid
722+ WHERE pg_class.relname = 'name_idx'
723+ ",
724+ &[],
725+ )
726+ .unwrap()
727+ .first()
728+ .map(|row| row.get("amname"))
729+ .unwrap();
730+ assert_eq!("hash", index_type);
731+ });
386
732
387− // Check that the existing data has been updated
733+ test.run();
388− let expected = vec![2, 102];
389− let results: Vec<i32> = new_db
390− .query("SELECT counter FROM users ORDER BY id", &[])
391− .unwrap()
392− .iter()
393− .map(|row| row.get::<_, i32>("counter"))
394− .collect();
395− assert_eq!(expected, results);
396}
734}
tests/common.rs+304−9
@@ -1,15 +1,310 @@
1+use colored::Colorize;
1use postgres::{Client, NoTls};
2use postgres::{Client, NoTls};
2−use reshape::Reshape;
3+use reshape::{migrations::Migration, Reshape};
3
4
4−pub fn setup() -> (Reshape, Client, Client) {
5+pub struct Test<'a> {
5− let connection_string = std::env::var("POSTGRES_CONNECTION_STRING")
6+ name: &'a str,
6− .unwrap_or("postgres://postgres:postgres@localhost/reshape_test".to_string());
7+ reshape: Reshape,
8+ old_db: Client,
9+ new_db: Client,
7
10
8− let old_db = Client::connect(&connection_string, NoTls).unwrap();
11+ first_migration: Option<Migration>,
9− let new_db = Client::connect(&connection_string, NoTls).unwrap();
12+ second_migration: Option<Migration>,
13+ expect_failure: bool,
10
14
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+
11− let mut reshape = Reshape::new(&connection_string).unwrap();
30+ let 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");
12− reshape.remove().unwrap();
124+ self.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+
241+ format!("{spacer} {text} {spacer}{extra}", spacer = spacer)
242+}
243+
244+pub fn assert_cleaned_up(db: &mut Client) {
245+ // Make sure no temporary columns remain
246+ let temp_columns: Vec<String> = db
247+ .query(
248+ "
249+ SELECT column_name
250+ FROM information_schema.columns
251+ WHERE table_schema = 'public'
252+ AND column_name LIKE '__reshape%'
253+ ",
254+ &[],
255+ )
256+ .unwrap()
257+ .iter()
258+ .map(|row| row.get(0))
259+ .collect();
260+
261+ assert!(
262+ temp_columns.is_empty(),
263+ "expected no temporary columns to exist, found: {}",
264+ temp_columns.join(", ")
265+ );
266+
267+ // Make sure no triggers remain
268+ let triggers: Vec<String> = db
269+ .query(
270+ "
271+ SELECT trigger_name
272+ FROM information_schema.triggers
273+ WHERE trigger_schema = 'public'
274+ AND trigger_name LIKE '__reshape%'
275+ ",
276+ &[],
277+ )
278+ .unwrap()
279+ .iter()
280+ .map(|row| row.get(0))
281+ .collect();
282+
283+ assert!(
284+ triggers.is_empty(),
285+ "expected no triggers to exist, found: {}",
286+ triggers.join(", ")
287+ );
288+
289+ // Make sure no functions remain
290+ let functions: Vec<String> = db
291+ .query(
292+ "
293+ SELECT routine_name
294+ FROM information_schema.routines
295+ WHERE routine_schema = 'public'
296+ AND routine_name LIKE '__reshape%'
297+ ",
298+ &[],
299+ )
300+ .unwrap()
301+ .iter()
302+ .map(|row| row.get(0))
303+ .collect();
13
304
14− (reshape, old_db, new_db)
305+ assert!(
306+ functions.is_empty(),
307+ "expected no functions to exist, found: {}",
308+ functions.join(", ")
309+ );
15}
310}
tests/complex.rsnew file+379
@@ -0,0 +1,379 @@
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.rsnew file+41
@@ -0,0 +1,41 @@
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+187−198
@@ -1,211 +1,200 @@
1−use reshape::{
2− migrations::{Column, CreateTable, ForeignKey, Migration},
3− Status,
4−};
5−
6mod common;
1mod common;
2+use common::Test;
7
3
8#[test]
4#[test]
9fn create_table() {
5fn create_table() {
10− let (mut reshape, mut db, _) = common::setup();
6+ let mut test = Test::new("Create table");
11−
7+
12− let create_table_migration =
8+ test.first_migration(
9+ r#"
13− Migration::new("create_users_table", None).with_action(CreateTable {
10+ name = "create_users_table"
11+
12+ [[actions]]
13+ type = "create_table"
14− name: "users".to_string(),
14+ name = "users"
15− primary_key: vec!["id".to_string()],
15+ primary_key = ["id"]
16− foreign_keys: vec![],
16+
17− columns: vec![
17+ [[actions.columns]]
18− Column {
18+ name = "id"
19− name: "id".to_string(),
19+ type = "INTEGER"
20− data_type: "INTEGER".to_string(),
21− nullable: true,
22− default: None,
23− generated: Some("ALWAYS AS IDENTITY".to_string()),
20+ generated = "ALWAYS AS IDENTITY"
24− },
21+
25− Column {
22+ [[actions.columns]]
26− name: "name".to_string(),
23+ name = "name"
27− data_type: "TEXT".to_string(),
24+ type = "TEXT"
28− nullable: true,
25+
29− default: None,
26+ [[actions.columns]]
30− generated: None,
31− },
32− Column {
33− name: "created_at".to_string(),
27+ name = "created_at"
34− data_type: "TIMESTAMP".to_string(),
28+ type = "TIMESTAMP"
35− nullable: false,
29+ nullable = false
36− default: Some("NOW()".to_string()),
30+ default = "NOW()"
37− generated: None,
31+ "#,
38− },
39− ],
40− });
41−
42− reshape
43− .migrate(vec![create_table_migration.clone()])
44− .unwrap();
45− assert!(matches!(reshape.state.status, Status::Idle));
46− assert_eq!(
47− Some(&create_table_migration.name),
48− reshape.state.current_migration.as_ref()
49 );
32 );
50
33
34+ test.after_first(|db| {
51− // Ensure table was created
35+ // Ensure table was created
52− let result = db
36+ let result = db
53− .query_opt(
37+ .query_opt(
54− "
38+ "
55− SELECT table_name
39+ SELECT table_name
56− FROM information_schema.tables
40+ FROM information_schema.tables
57− WHERE table_name = 'users' AND table_schema = 'public'",
41+ WHERE table_name = 'users' AND table_schema = 'public'",
58− &[],
42+ &[],
59− )
43+ )
60− .unwrap();
44+ .unwrap();
61− assert!(result.is_some());
45+ assert!(result.is_some());
62−
46+
63− // Ensure table has the right columns
47+ // Ensure table has the right columns
64− let result = db
48+ let result = db
65− .query(
49+ .query(
66− "
50+ "
67− SELECT column_name, column_default, is_nullable, data_type
51+ SELECT column_name, column_default, is_nullable, data_type
68− FROM information_schema.columns
52+ FROM information_schema.columns
69− WHERE table_name = 'users' AND table_schema = 'public'
53+ WHERE table_name = 'users' AND table_schema = 'public'
70− ORDER BY ordinal_position",
54+ ORDER BY ordinal_position",
71− &[],
55+ &[],
72− )
56+ )
73− .unwrap();
57+ .unwrap();
74−
58+
75− // id column
59+ // id column
76− let id_row = &result[0];
60+ let id_row = &result[0];
77− assert_eq!("id", id_row.get::<_, String>("column_name"));
61+ assert_eq!("id", id_row.get::<_, String>("column_name"));
78− assert!(id_row.get::<_, Option<String>>("column_default").is_none());
62+ assert!(id_row.get::<_, Option<String>>("column_default").is_none());
79− assert_eq!("NO", id_row.get::<_, String>("is_nullable"));
63+ assert_eq!("NO", id_row.get::<_, String>("is_nullable"));
80− assert_eq!("integer", id_row.get::<_, String>("data_type"));
64+ assert_eq!("integer", id_row.get::<_, String>("data_type"));
81−
65+
82− // name column
66+ // name column
83− let name_row = &result[1];
67+ let name_row = &result[1];
84− assert_eq!("name", name_row.get::<_, String>("column_name"));
68+ assert_eq!("name", name_row.get::<_, String>("column_name"));
85− assert!(name_row
69+ assert!(name_row
86− .get::<_, Option<String>>("column_default")
70+ .get::<_, Option<String>>("column_default")
87− .is_none());
71+ .is_none());
88− assert_eq!("YES", name_row.get::<_, String>("is_nullable"));
72+ assert_eq!("YES", name_row.get::<_, String>("is_nullable"));
89− assert_eq!("text", name_row.get::<_, String>("data_type"));
73+ assert_eq!("text", name_row.get::<_, String>("data_type"));
90−
74+
91− // created_at column
75+ // created_at column
92− let created_at_column = &result[2];
76+ let created_at_column = &result[2];
93− assert_eq!(
77+ assert_eq!(
94− "created_at",
78+ "created_at",
95− created_at_column.get::<_, String>("column_name")
79+ created_at_column.get::<_, String>("column_name")
96− );
80+ );
97− assert!(created_at_column
81+ assert!(created_at_column
98− .get::<_, Option<String>>("column_default")
82+ .get::<_, Option<String>>("column_default")
99− .is_some());
83+ .is_some());
100− assert_eq!("NO", created_at_column.get::<_, String>("is_nullable"));
84+ assert_eq!("NO", created_at_column.get::<_, String>("is_nullable"));
101− assert_eq!(
85+ assert_eq!(
102− "timestamp without time zone",
86+ "timestamp without time zone",
103− created_at_column.get::<_, String>("data_type")
87+ created_at_column.get::<_, String>("data_type")
104− );
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();
105
106
106− // Ensure the primary key has the right columns
107− let primary_key_columns: Vec<String> = db
108− .query(
109− "
110− SELECT a.attname AS column
111− FROM pg_index i
112− JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = ANY(i.indkey)
113− WHERE i.indrelid = 'users'::regclass AND i.indisprimary
114− ",
115− &[],
116− )
117− .unwrap()
118− .iter()
119− .map(|row| row.get("column"))
120− .collect();
121−
122− assert_eq!(vec!["id"], primary_key_columns);
107+ assert_eq!(vec!["id"], primary_key_columns);
108+ });
109+
110+ test.run();
123}
111}
124
112
125#[test]
113#[test]
126fn create_table_with_foreign_keys() {
114fn create_table_with_foreign_keys() {
127− let (mut reshape, mut db, _) = common::setup();
115+ let mut test = Test::new("Create table");
128−
116+
129− let create_table_migration =
117+ test.first_migration(
118+ r#"
130− Migration::new("create_users_table", None).with_action(CreateTable {
119+ name = "create_users_table"
120+
121+ [[actions]]
122+ type = "create_table"
131− name: "users".to_string(),
123+ name = "users"
132− primary_key: vec!["id".to_string()],
124+ primary_key = ["id"]
133− foreign_keys: vec![],
125+
134− columns: vec![Column {
126+ [[actions.columns]]
135− name: "id".to_string(),
127+ name = "id"
136− data_type: "SERIAL".to_string(),
128+ type = "INTEGER"
137− nullable: true, // Will be ignored by Postgres as the column is a SERIAL
129+ generated = "ALWAYS AS IDENTITY"
130+
131+ [[actions.columns]]
132+ name = "name"
133+ type = "TEXT"
134+
135+ [[actions.columns]]
136+ name = "created_at"
137+ type = "TIMESTAMP"
138+ nullable = false
138− default: None,
139+ default = "NOW()"
139− generated: None,
140+
140− }],
141+ [[actions]]
141− });
142+ type = "create_table"
142−
143+ name = "items"
143− let create_second_table_migration =
144+ primary_key = ["id"]
144− Migration::new("create_items_table", None).with_action(CreateTable {
145+
145− name: "items".to_string(),
146+ [[actions.columns]]
146− primary_key: vec!["id".to_string()],
147+ name = "id"
147− foreign_keys: vec![ForeignKey {
148+ type = "INTEGER"
149+
150+ [[actions.columns]]
151+ name = "user_id"
152+ type = "INTEGER"
153+ nullable = false
154+
155+ [[actions.foreign_keys]]
148− columns: vec!["user_id".to_string()],
156+ columns = ["user_id"]
149− referenced_table: "users".to_string(),
157+ referenced_table = "users"
150− referenced_columns: vec!["id".to_string()],
158+ referenced_columns = ["id"]
151− }],
152− columns: vec![
153− Column {
154− name: "id".to_string(),
155− data_type: "SERIAL".to_string(),
156− nullable: true,
157− default: None,
158− generated: None,
159− },
160− Column {
161− name: "user_id".to_string(),
162− data_type: "INTEGER".to_string(),
163− nullable: false,
164− default: None,
165− generated: None,
166− },
167− ],
168− });
169−
170− reshape
171− .migrate(vec![
172− create_table_migration.clone(),
173− create_second_table_migration.clone(),
174− ])
175− .unwrap();
176−
177− let foreign_key_columns: Vec<(String, String, String)> = db
178− .query(
179− "
159+ "#,
180− SELECT
181− kcu.column_name,
182− ccu.table_name AS foreign_table_name,
183− ccu.column_name AS foreign_column_name
184− FROM
185− information_schema.table_constraints AS tc
186− JOIN information_schema.key_column_usage AS kcu
187− ON tc.constraint_name = kcu.constraint_name
188− AND tc.table_schema = kcu.table_schema
189− JOIN information_schema.constraint_column_usage AS ccu
190− ON ccu.constraint_name = tc.constraint_name
191− AND ccu.table_schema = tc.table_schema
192− WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
193− ",
194− &[],
195− )
196− .unwrap()
197− .iter()
198− .map(|row| {
199− (
200− row.get("column_name"),
201− row.get("foreign_table_name"),
202− row.get("foreign_column_name"),
203− )
204− })
205− .collect();
206−
207− assert_eq!(
208− vec![("user_id".to_string(), "users".to_string(), "id".to_string())],
209− foreign_key_columns
210 );
160 );
161+
162+ test.after_first(|db| {
163+ let foreign_key_columns: Vec<(String, String, String)> = db
164+ .query(
165+ "
166+ SELECT
167+ kcu.column_name,
168+ ccu.table_name AS foreign_table_name,
169+ ccu.column_name AS foreign_column_name
170+ FROM
171+ information_schema.table_constraints AS tc
172+ JOIN information_schema.key_column_usage AS kcu
173+ ON tc.constraint_name = kcu.constraint_name
174+ AND tc.table_schema = kcu.table_schema
175+ JOIN information_schema.constraint_column_usage AS ccu
176+ ON ccu.constraint_name = tc.constraint_name
177+ AND ccu.table_schema = tc.table_schema
178+ WHERE tc.constraint_type = 'FOREIGN KEY' AND tc.table_name='items';
179+ ",
180+ &[],
181+ )
182+ .unwrap()
183+ .iter()
184+ .map(|row| {
185+ (
186+ row.get("column_name"),
187+ row.get("foreign_table_name"),
188+ row.get("foreign_column_name"),
189+ )
190+ })
191+ .collect();
192+
193+ assert_eq!(
194+ vec![("user_id".to_string(), "users".to_string(), "id".to_string())],
195+ foreign_key_columns
196+ );
197+ });
198+
199+ test.run();
211}
200}
tests/custom.rsnew file+128
@@ -0,0 +1,128 @@
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.rsnew file+51
@@ -0,0 +1,51 @@
1+mod common;
2+use common::Test;
3+
4+#[test]
5+fn invalid_migration() {
6+ let mut test = Test::new("Invalid migration");
7+
8+ test.first_migration(
9+ r#"
10+ name = "invalid_migration"
11+
12+ [[actions]]
13+ type = "create_table"
14+ name = "users"
15+ primary_key = ["id"]
16+
17+ [[actions.columns]]
18+ name = "id"
19+ type = "INTEGER"
20+ "#,
21+ );
22+
23+ test.second_migration(
24+ r#"
25+ name = "add_invalid_column"
26+
27+ [[actions]]
28+ type = "add_column"
29+ table = "users"
30+
31+ up = "INVALID SQL"
32+
33+ [actions.column]
34+ name = "first"
35+ type = "TEXT"
36+ "#,
37+ );
38+
39+ // Insert a test user
40+ test.after_first(|db| {
41+ db.simple_query(
42+ "
43+ INSERT INTO users (id) VALUES (1)
44+ ",
45+ )
46+ .unwrap();
47+ });
48+
49+ test.expect_failure();
50+ test.run();
51+}
tests/remove_column.rs+210−75
@@ -1,82 +1,217 @@
1−use reshape::migrations::{Column, CreateTable, Migration, RemoveColumn};
2−
3mod common;
1mod common;
2+use common::Test;
4
3
5#[test]
4#[test]
6fn remove_column() {
5fn remove_column() {
7− let (mut reshape, mut old_db, mut new_db) = common::setup();
6+ let mut test = Test::new("Remove column");
8−
7+
9− let create_table_migration =
8+ test.first_migration(
10− Migration::new("create_users_table", None).with_action(CreateTable {
9+ r#"
10+ name = "create_user_table"
11+
12+ [[actions]]
13+ type = "create_table"
11− name: "users".to_string(),
14+ name = "users"
12− primary_key: vec!["id".to_string()],
15+ primary_key = ["id"]
13− foreign_keys: vec![],
16+
14− columns: vec![
17+ [[actions.columns]]
15− Column {
18+ name = "id"
16− name: "id".to_string(),
19+ type = "INTEGER"
17− data_type: "INTEGER".to_string(),
20+
18− nullable: true,
21+ [[actions.columns]]
19− default: None,
22+ name = "name"
20− generated: None,
23+ type = "TEXT"
21− },
24+ "#,
22− Column {
25+ );
23− name: "name".to_string(),
26+
24− data_type: "TEXT".to_string(),
27+ test.second_migration(
25− nullable: false,
28+ r#"
26− default: None,
27− generated: None,
28− },
29− ],
30− });
31− let remove_column_migration =
32− Migration::new("remove_name_column", None).with_action(RemoveColumn {
29+ name = "remove_name_column"
33− table: "users".to_string(),
30+
34− column: "name".to_string(),
31+ [[actions]]
35− down: Some("'TEST_DOWN_VALUE'".to_string()),
32+ type = "remove_column"
36− });
33+ table = "users"
37−
34+ column = "name"
38− let first_migrations = vec![create_table_migration.clone()];
35+ down = "'TEST_DOWN_VALUE'"
39− let second_migrations = vec![
36+ "#,
40− create_table_migration.clone(),
41− remove_column_migration.clone(),
42− ];
43−
44− // Run migrations
45− reshape.migrate(first_migrations.clone()).unwrap();
46− reshape.migrate(second_migrations.clone()).unwrap();
47−
48− // Update schemas of Postgres connections
49− let old_schema_query =
50− reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
51− let new_schema_query =
52− reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
53− old_db.simple_query(&old_schema_query).unwrap();
54− new_db.simple_query(&new_schema_query).unwrap();
55−
56− // Insert using old schema and ensure it can be retrieved through new schema
57− old_db
58− .simple_query("INSERT INTO users(id, name) VALUES (1, 'John Doe')")
59− .unwrap();
60− let results = new_db
61− .query("SELECT id FROM users WHERE id = 1", &[])
62− .unwrap();
63− assert_eq!(1, results.len());
64− assert_eq!(1, results[0].get::<_, i32>("id"));
65−
66− // Ensure the name column is not accesible through the new schema
67− assert!(new_db.query("SELECT id, name FROM users", &[]).is_err());
68−
69− // Insert using new schema and ensure the down function is correctly applied
70− new_db
71− .simple_query("INSERT INTO users(id) VALUES (2)")
72− .unwrap();
73− let result = old_db
74− .query_opt("SELECT name FROM users WHERE id = 2", &[])
75− .unwrap();
76− assert_eq!(
77− Some("TEST_DOWN_VALUE"),
78− result.as_ref().map(|row| row.get("name"))
79 );
37 );
80
38
81− reshape.complete_migration().unwrap();
39+ test.intermediate(|old_db, new_db| {
40+ // Insert using old schema and ensure it can be retrieved through new schema
41+ old_db
42+ .simple_query("INSERT INTO users(id, name) VALUES (1, 'John Doe')")
43+ .unwrap();
44+ let results = new_db
45+ .query("SELECT id FROM users WHERE id = 1", &[])
46+ .unwrap();
47+ assert_eq!(1, results.len());
48+ assert_eq!(1, results[0].get::<_, i32>("id"));
49+
50+ // Ensure the name column is not accesible through the new schema
51+ assert!(new_db.query("SELECT id, name FROM users", &[]).is_err());
52+
53+ // Insert using new schema and ensure the down function is correctly applied
54+ new_db
55+ .simple_query("INSERT INTO users(id) VALUES (2)")
56+ .unwrap();
57+ let result = old_db
58+ .query_opt("SELECT name FROM users WHERE id = 2", &[])
59+ .unwrap();
60+ assert_eq!(
61+ Some("TEST_DOWN_VALUE"),
62+ result.as_ref().map(|row| row.get("name"))
63+ );
64+ });
65+
66+ test.run();
67+}
68+
69+#[test]
70+fn remove_column_with_index() {
71+ let mut test = Test::new("Remove column");
72+
73+ test.first_migration(
74+ r#"
75+ name = "create_user_table"
76+
77+ [[actions]]
78+ type = "create_table"
79+ name = "users"
80+ primary_key = ["id"]
81+
82+ [[actions.columns]]
83+ name = "id"
84+ type = "INTEGER"
85+
86+ [[actions.columns]]
87+ name = "name"
88+ type = "TEXT"
89+
90+ [[actions]]
91+ type = "add_index"
92+ table = "users"
93+
94+ [actions.index]
95+ name = "name_idx"
96+ columns = ["name"]
97+ "#,
98+ );
99+
100+ test.second_migration(
101+ r#"
102+ name = "remove_name_column"
103+
104+ [[actions]]
105+ type = "remove_column"
106+ table = "users"
107+ column = "name"
108+ down = "'TEST_DOWN_VALUE'"
109+ "#,
110+ );
111+
112+ test.after_completion(|db| {
113+ // Ensure index has been removed after the migration is complete
114+ let count: i64 = db
115+ .query(
116+ "
117+ SELECT COUNT(*)
118+ FROM pg_catalog.pg_index
119+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
120+ WHERE pg_class.relname = 'name_idx'
121+ ",
122+ &[],
123+ )
124+ .unwrap()
125+ .first()
126+ .map(|row| row.get(0))
127+ .unwrap();
128+
129+ assert_eq!(0, count, "expected index to not exist");
130+ });
131+
132+ test.run();
133+}
134+
135+#[test]
136+fn remove_column_with_complex_down() {
137+ let mut test = Test::new("Remove column complex");
138+
139+ test.first_migration(
140+ r#"
141+ name = "create_tables"
142+
143+ [[actions]]
144+ type = "create_table"
145+ name = "users"
146+ primary_key = ["id"]
147+
148+ [[actions.columns]]
149+ name = "id"
150+ type = "INTEGER"
151+
152+ [[actions.columns]]
153+ name = "email"
154+ type = "TEXT"
155+
156+ [[actions]]
157+ type = "create_table"
158+ name = "profiles"
159+ primary_key = ["user_id"]
160+
161+ [[actions.columns]]
162+ name = "user_id"
163+ type = "INTEGER"
164+
165+ [[actions.columns]]
166+ name = "email"
167+ type = "TEXT"
168+ "#,
169+ );
170+
171+ test.second_migration(
172+ r#"
173+ name = "remove_users_email_column"
174+
175+ [[actions]]
176+ type = "remove_column"
177+ table = "users"
178+ column = "email"
179+
180+ [actions.down]
181+ table = "profiles"
182+ value = "profiles.email"
183+ where = "users.id = profiles.user_id"
184+ "#,
185+ );
186+
187+ test.after_first(|db| {
188+ db.simple_query("INSERT INTO users (id, email) VALUES (1, 'test@example.com')")
189+ .unwrap();
190+ db.simple_query("INSERT INTO profiles (user_id, email) VALUES (1, 'test@example.com')")
191+ .unwrap();
192+ });
193+
194+ test.intermediate(|old_db, new_db| {
195+ new_db
196+ .simple_query("UPDATE profiles SET email = 'test2@example.com' WHERE user_id = 1")
197+ .unwrap();
198+
199+ // Ensure new email was propagated to users table in old schema
200+ let email: String = old_db
201+ .query(
202+ "
203+ SELECT email
204+ FROM users
205+ WHERE id = 1
206+ ",
207+ &[],
208+ )
209+ .unwrap()
210+ .first()
211+ .map(|row| row.get("email"))
212+ .unwrap();
213+ assert_eq!("test2@example.com", email);
214+ });
215+
216+ test.run();
82}
217}
tests/remove_enum.rsnew file+69
@@ -0,0 +1,69 @@
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.rsnew file+124
@@ -0,0 +1,124 @@
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.rsnew file+86
@@ -0,0 +1,86 @@
1+mod common;
2+use common::Test;
3+
4+#[test]
5+fn remove_index() {
6+ let mut test = Test::new("Remove index");
7+
8+ test.first_migration(
9+ r#"
10+ name = "create_users_table"
11+
12+ [[actions]]
13+ type = "create_table"
14+ name = "users"
15+ primary_key = ["id"]
16+
17+ [[actions.columns]]
18+ name = "id"
19+ type = "INTEGER"
20+
21+ [[actions.columns]]
22+ name = "name"
23+ type = "TEXT"
24+
25+ [[actions]]
26+ type = "add_index"
27+ table = "users"
28+
29+ [actions.index]
30+ name = "name_idx"
31+ columns = ["name"]
32+ "#,
33+ );
34+
35+ test.second_migration(
36+ r#"
37+ name = "remove_name_index"
38+
39+ [[actions]]
40+ type = "remove_index"
41+ index = "name_idx"
42+ "#,
43+ );
44+
45+ test.intermediate(|db, _| {
46+ // Ensure index is still valid and ready during the migration
47+ let result: Vec<(bool, bool)> = db
48+ .query(
49+ "
50+ SELECT pg_index.indisready, pg_index.indisvalid
51+ FROM pg_catalog.pg_index
52+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
53+ WHERE pg_class.relname = 'name_idx'
54+ ",
55+ &[],
56+ )
57+ .unwrap()
58+ .iter()
59+ .map(|row| (row.get("indisready"), row.get("indisvalid")))
60+ .collect();
61+
62+ assert_eq!(vec![(true, true)], result);
63+ });
64+
65+ test.after_completion(|db| {
66+ // Ensure index has been removed after the migration is complete
67+ let count: i64 = db
68+ .query(
69+ "
70+ SELECT COUNT(*)
71+ FROM pg_catalog.pg_index
72+ JOIN pg_catalog.pg_class ON pg_index.indexrelid = pg_class.oid
73+ WHERE pg_class.relname = 'name_idx'
74+ ",
75+ &[],
76+ )
77+ .unwrap()
78+ .first()
79+ .map(|row| row.get(0))
80+ .unwrap();
81+
82+ assert_eq!(0, count, "expected index to not exist");
83+ });
84+
85+ test.run();
86+}
tests/remove_table.rs+39−49
@@ -1,54 +1,44 @@
1−use reshape::migrations::{Column, CreateTable, Migration, RemoveTable};
2−
3mod common;
1mod common;
2+use common::Test;
4
3
5#[test]
4#[test]
6fn remove_table() {
5fn remove_table() {
7− let (mut reshape, mut old_db, mut new_db) = common::setup();
6+ let mut test = Test::new("Remove table");
8−
7+
9− let create_table_migration =
8+ test.first_migration(
9+ r#"
10− Migration::new("create_users_table", None).with_action(CreateTable {
10+ name = "create_users_table"
11+
12+ [[actions]]
13+ type = "create_table"
11− name: "users".to_string(),
14+ name = "users"
12− primary_key: vec!["id".to_string()],
15+ primary_key = ["id"]
13− foreign_keys: vec![],
16+
14− columns: vec![Column {
17+ [[actions.columns]]
15− name: "id".to_string(),
18+ name = "id"
16− data_type: "INTEGER".to_string(),
19+ type = "INTEGER"
17− nullable: false,
20+ "#,
18− default: None,
21+ );
19− generated: None,
22+
20− }],
23+ test.second_migration(
21− });
24+ r#"
22− let remove_table_migration =
23− Migration::new("remove_users_table", None).with_action(RemoveTable {
25+ name = "remove_users_table"
24− table: "users".to_string(),
26+
25− });
27+ [[actions]]
26−
28+ type = "remove_table"
27− let first_migrations = vec![create_table_migration.clone()];
29+ table = "users"
28− let second_migrations = vec![
30+ "#,
29− create_table_migration.clone(),
31+ );
30− remove_table_migration.clone(),
32+
31− ];
33+ test.intermediate(|old_db, new_db| {
32−
33− // Run migrations
34− reshape.migrate(first_migrations.clone()).unwrap();
35− reshape.migrate(second_migrations.clone()).unwrap();
36−
37− // Update schemas of Postgres connections
38− let old_schema_query =
39− reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
40− let new_schema_query =
41− reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
42− old_db.simple_query(&old_schema_query).unwrap();
43− new_db.simple_query(&new_schema_query).unwrap();
44−
45− // Make sure inserts work against the old schema
34+ // Make sure inserts work against the old schema
46− old_db
35+ old_db
47− .simple_query("INSERT INTO users(id) VALUES (1)")
36+ .simple_query("INSERT INTO users(id) VALUES (1)")
48− .unwrap();
37+ .unwrap();
49−
38+
50− // Ensure the table is not accessible through the new schema
39+ // Ensure the table is not accessible through the new schema
51− assert!(new_db.query("SELECT id FROM users", &[]).is_err());
40+ assert!(new_db.query("SELECT id FROM users", &[]).is_err());
52−
41+ });
53− reshape.complete_migration().unwrap();
42+
43+ test.run();
54}
44}
tests/rename_table.rs+56−66
@@ -1,80 +1,70 @@
1−use reshape::migrations::{Column, CreateTable, Migration, RenameTable};
2−
3mod common;
1mod common;
2+use common::Test;
4
3
5#[test]
4#[test]
6fn rename_table() {
5fn rename_table() {
7− let (mut reshape, mut old_db, mut new_db) = common::setup();
6+ let mut test = Test::new("Rename table");
8−
9− let create_table_migration =
10− Migration::new("create_users_table", None).with_action(CreateTable {
11− name: "users".to_string(),
12− primary_key: vec!["id".to_string()],
13− foreign_keys: vec![],
14− columns: vec![Column {
15− name: "id".to_string(),
16− data_type: "INTEGER".to_string(),
17− nullable: false,
18− default: None,
19− generated: None,
20− }],
21− });
22− let rename_table_migration = Migration::new("rename_users_table_to_customers", None)
23− .with_action(RenameTable {
24− table: "users".to_string(),
25− new_name: "customers".to_string(),
26− });
27
7
28− let first_migrations = vec![create_table_migration.clone()];
8+ test.first_migration(
29− let second_migrations = vec![
9+ r#"
30− create_table_migration.clone(),
10+ name = "create_users_table"
31− rename_table_migration.clone(),
11+
32− ];
12+ [[actions]]
13+ type = "create_table"
14+ name = "users"
15+ primary_key = ["id"]
33
16
34− // Run migrations
17+ [[actions.columns]]
35− reshape.migrate(first_migrations.clone()).unwrap();
18+ name = "id"
36− reshape.migrate(second_migrations.clone()).unwrap();
19+ type = "INTEGER"
20+ "#,
21+ );
37
22
38− // Update schemas of Postgres connections
23+ test.second_migration(
39− let old_schema_query =
24+ r#"
40− reshape::schema_query_for_migration(&first_migrations.last().unwrap().name);
25+ name = "rename_users_table_to_customers"
41− let new_schema_query =
42− reshape::schema_query_for_migration(&second_migrations.last().unwrap().name);
43− old_db.simple_query(&old_schema_query).unwrap();
44− new_db.simple_query(&new_schema_query).unwrap();
45
26
46− // Make sure inserts work using both the old and new name
27+ [[actions]]
47− old_db
28+ type = "rename_table"
48− .simple_query("INSERT INTO users(id) VALUES (1)")
29+ table = "users"
49− .unwrap();
30+ new_name = "customers"
50− new_db
31+ "#,
51− .simple_query("INSERT INTO customers(id) VALUES (2)")
32+ );
52− .unwrap();
53
33
34+ test.intermediate(|old_db, new_db| {
54− // Ensure the table can be queried using both the old and new name
35+ // Make sure inserts work using both the old and new name
55− let expected: Vec<i32> = vec![1, 2];
56− assert_eq!(
57− expected,
58 old_db
36 old_db
59− .query("SELECT id FROM users ORDER BY id", &[])
37+ .simple_query("INSERT INTO users(id) VALUES (1)")
60− .unwrap()
38+ .unwrap();
61− .iter()
62− .map(|row| row.get::<_, i32>("id"))
63− .collect::<Vec<i32>>()
64− );
65− assert_eq!(
66− expected,
67 new_db
39 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
68− .query("SELECT id FROM customers ORDER BY id", &[])
48+ .query("SELECT id FROM users ORDER BY id", &[])
69− .unwrap()
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()
70− .iter()
59+ .iter()
71− .map(|row| row.get::<_, i32>("id"))
60+ .map(|row| row.get::<_, i32>("id"))
72− .collect::<Vec<i32>>()
61+ .collect::<Vec<i32>>()
73− );
62+ );
74
63
75− // Ensure the table can't be queried using the wrong name for the schema
64+ // Ensure the table can't be queried using the wrong name for the schema
76− assert!(old_db.simple_query("SELECT id FROM customers").is_err());
65+ assert!(old_db.simple_query("SELECT id FROM customers").is_err());
77− assert!(new_db.simple_query("SELECT id FROM users").is_err());
66+ assert!(new_db.simple_query("SELECT id FROM users").is_err());
67+ });
78
68
79− reshape.complete_migration().unwrap();
69+ test.run();
80}
70}