diff --git a/README.md b/README.md index 6ef22b851..3a6edbdae 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ See the [introductory blog post](https://pgroll.com/blog/introducing-pgroll-zero `pgroll` works by creating virtual schemas by using views on top of the physical tables. This allows for performing all the necessary changes needed for a migration without affecting the existing clients. -![Multiple schema versions with pgroll](docs/img/migration-flow@2x.png) +![Multiple schema versions with pgroll](docs/img/schema-changes-flow@2x.png) `pgroll` follows a [expand/contract workflow](https://openpracticelibrary.com/practice/expand-and-contract-pattern/). On migration start, it will perform all the additive changes (create tables, add columns, etc) in the physical schema, without breaking it. diff --git a/docs/getting-started.md b/docs/getting-started.md index f3d2fa852..437dc5684 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -10,7 +10,7 @@ This guide covers the key concepts of `pgroll` and how to get started with it. `pgroll` migrations are applied in two steps, following an [expand/contract pattern](https://openpracticelibrary.com/practice/expand-and-contract-pattern/). -![migration flow](img/migration-flow@2x.png) +![migration flow](img/schema-changes-flow@2x.png) During the migration start phase, `pgroll` will perform only additive changes to the database schema. This includes: creating new tables, adding new columns, and creating new indexes. In the cases where a required change is not backwards compatible, `pgroll` will take the necessary steps to ensure that the current schema is still valid. For example, if a new column is added to a table with a `NOT NULL` constraint, `pgroll` will backfill the new column with a default value. diff --git a/docs/img/migration-flow.svg b/docs/img/migration-flow.svg deleted file mode 100644 index c0b7f0134..000000000 --- a/docs/img/migration-flow.svg +++ /dev/null @@ -1,1236 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - New schema - - - - - - ready - - - - - - - - - - - - - - - - - - - - Schema Change - - - - - - completed - - - - - - - - - - - - - - - - - - - - Schema change - - - - - - - - - - starts - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - new version available - - - - - - - - - - - - - - - - - - old version available - - - - - - - - - - - - - - - - - - active migration period - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Database - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - roll out - - - - - - - - - - - - - - - - - - - - - - - - - - - - using new schema - - - - - - - - - - - - - - - - - - using old schema - - - - - - - - - - - - - - - App/clients - - - - - - - - - - - - - - - - New version - - - - - - deploy - - - - - - - - - - - - - diff --git a/docs/img/migration-flow@2x.png b/docs/img/migration-flow@2x.png deleted file mode 100644 index f534afcef..000000000 Binary files a/docs/img/migration-flow@2x.png and /dev/null differ diff --git a/docs/img/migration-schemas@2x.png b/docs/img/migration-schemas@2x.png index 676ffa7f7..26bc0a10a 100644 Binary files a/docs/img/migration-schemas@2x.png and b/docs/img/migration-schemas@2x.png differ diff --git a/docs/img/schema-changes-flow@2x.png b/docs/img/schema-changes-flow@2x.png new file mode 100644 index 000000000..69399d5ad Binary files /dev/null and b/docs/img/schema-changes-flow@2x.png differ