ilyakooo0/reshape
1
0
Fork 0
mirror of https://github.com/ilyakooo0/reshape.git synced 2024-11-25 23:13:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3 from barrywoolgar/patch-1

Browse Source 
Explain the new concept at the top of the README
This commit is contained in:
Fabian Lindfors 2022-01-13 14:27:24 +01:00 committed by GitHub
commit d76dbab5ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -8,6 +8,7 @@ Reshape is designed for Postgres 12 and later.
*Note: Reshape is **experimental** and should not be used in production. It can (and probably will) destroy your data and break your application.*
- [How it works](#how-it-works)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Creating your first migration](#creating-your-first-migration)
@ -33,9 +34,19 @@ Reshape is designed for Postgres 12 and later.
- [`reshape abort`](#reshape-abort)
- [`reshape generate-schema-query`](#reshape-generate-schema-query)
- [Connection options](#connection-options)
- [How it works](#how-it-works)
- [License](#license)
## How it works
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:
1. **Start migration** (`reshape migrate`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
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.
3. **Complete migration** (`reshape complete`): Removes the old schema and any intermediate data and triggers.
If the application deployment fails, you should run `reshape abort` which will roll back any changes made by `reshape migrate` without losing data.
## Getting started
### Installation
@ -460,16 +471,6 @@ The options below can be used with all commands that communicate with Postgres.
| `--username` | `postgres` | Postgres username |
| `--password` | `postgres` | Postgres password |
## How it works
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:
1. **Start migration** (`reshape migrate`): Sets up views and triggers to ensure both the new and old schema are usable at the same time.
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.
3. **Complete migration** (`reshape complete`): Removes the old schema and any intermediate data and triggers.
If the application deployment fails, you should run `reshape abort` which will roll back any changes made by `reshape migrate` without losing data.
## License
Reshape is released under the [MIT license](https://choosealicense.com/licenses/mit/).
Reshape is released under the [MIT license](https://choosealicense.com/licenses/mit/).