Add new group Guides and add a guide for writing up and down expresions
#775
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
353ce14 to
ab2b3d4
Compare
OysterKing
reviewed
Apr 2, 2025
docs/guides/updown.mdx
Outdated
| description: Guide to writing up and down migrations | ||
| --- | ||
|
|
||
| In this guide you will learn how to write `up` and `down` migrations in your pgroll operations. First, we are looking at how `up` and `down` migrations work. Then we are going through a few examples. |
There was a problem hiding this comment.
Suggestion:
In this guide, you will learn...
I suggest saying "we will learn", that's what I would expect in most guides.
Then we are going through a few examples.
Change to "then we'll look at a few examples".
OysterKing
reviewed
Apr 2, 2025
docs/guides/updown.mdx
Outdated
|
|
||
| ## What is an `up` and `down` migration of a pgroll operation? | ||
|
|
||
| Most pgroll migrations include `up` and `down` migrations. When `pgroll` is migrating tables, it creates `up` and `down` triggers. The `up` triggers backfill the records in the table. The `down` triggers are running during rollback. |
There was a problem hiding this comment.
When
pgrollis migrating tables...
Change to "When pgroll migrates tables..."
The
downtriggers are running during rollback.
Change to "The down triggers run during rollback."
richardgill
reviewed
Apr 2, 2025
Co-authored-by: Richard Gill <richardgill@users.noreply.github.com>
exekias
reviewed
Apr 2, 2025
docs/guides/updown.mdx
Outdated
|
|
||
| ## What is an `up` and `down` migration of a `pgroll` operation? | ||
|
|
||
| Most `pgroll` migrations include `up` and `down` migrations. When `pgroll` migrates tables, it creates `up` and `down` triggers. The `up` triggers backfill the records in the table. The `down` triggers run during rollback. |
There was a problem hiding this comment.
both up & down triggers are run when updating the table, depending on the version the table is being updated with:
upis always run to backfill new columns (if any), during the start processupis also run for any insert/update of rows in the old version of the schemadownis run for any insert/update of rows in the new version of the schema.
I believe it would be good to add some more explanations here
exekias
approved these changes
Apr 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new section to the sidebar dedicated to guides. In this part of the documentation we could add guides for using pgroll with ORMs, baselining, etc.
The first guide I am adding is about writing
upanddownexpressions in pgroll operations.