Skip to content

Commit

Permalink
Fix diagram images (#543)
Browse files Browse the repository at this point in the history
This PR fixes the diagram images used in our docs.

---------

Co-authored-by: Elizabet Oliveira <[email protected]>
  • Loading branch information
elizabetdev and elizabetdev authored Dec 17, 2024
1 parent 92244d9 commit 52d3c95
Show file tree
Hide file tree
Showing 6 changed files with 2 additions and 1,238 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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[email protected])
![Multiple schema versions with pgroll](docs/img/schema-changes[email protected])


`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.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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[email protected])
![migration flow](img/schema-changes[email protected])

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.

Expand Down
Loading

0 comments on commit 52d3c95

Please sign in to comment.