docs(migrations): SNS-1977 update migrations doc to reflect new style #3584
Conversation
This file contains 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
dbanda
force-pushed
the
dbanda/update-migration-docs
branch
from
cdd0eba
to
6153764
Compare
dbanda
changed the title
dbanda
force-pushed
the
dbanda/update-migration-docs
branch
from
6153764
to
103f3b8
Compare
MeredithAnya
approved these changes
Jan 10, 2023
MIGRATIONS.md
Outdated
| @@ -105,9 +105,19 @@ The new migration should contain a class called `Migration` which inherits from | |||
|
|
|||
| ### Adding an SQL migration (ClickhouseNodeMigration) | |||
|
|
|||
| A ClickhouseNodeMigration is the most common type of migration and determines the SQL to be run on each ClickHouse node. You should define all four methods - `forwards_local`, `backwards_local`, `forwards_dist` and `backwards_dist` in order to provide the DDL for all ClickHouse layouts that a user may have. The operations provided in the `_local` methods will run on each local ClickHouse node and the `_dist` methods will run on each distributed ClickHouse nodes (if any). | |||
| A ClickhouseNodeMigration is the most common type of migration and determines the SQL to be run on each ClickHouse node. You should define all two methods - `forwards_ops` and `backwards_ops` in order to provide the DDL for all ClickHouse layouts that a user may have. These functions return a sequence of sql ops for the forwards and backwards (reverse) migrations. | |||
There was a problem hiding this comment.
You should define all two methods ... -> You must define two methods... (I know this changes a little bit of how it was written before but I think must is better than should here)
dbanda
force-pushed
the
dbanda/update-migration-docs
branch
from
103f3b8
to
8ccf3c0
Compare
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.
update migrations doc to reflect new style