Skip to content

Commit

Permalink
update migration docs (#461)
Browse files Browse the repository at this point in the history
* update migration docs

* Update docs/build/project-upgrades.md

* Update docs/build/project-upgrades.md

---------

Co-authored-by: James Bayly <[email protected]>
  • Loading branch information
bz888 and jamesbayly authored Dec 22, 2023
1 parent 1b07eeb commit 4b1bce8
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/build/project-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ These are in addition to [Project Upgrade requirements](#requirements):
### Supported Migrations

Supported migrations:

- Adding new entities
- Removing entities (this is destructive)
- Adding new fields (however only [nullable fields](./graphql.md#entities) are supported)
Expand All @@ -70,9 +69,9 @@ Supported migrations:
- Please note: When field update is detected, the original field column will be dropped (with all existing data in that field), and a new column will be created with the new field types.

Other notes:

- Only supports PostgreSQL stores
- Does not support adding new [foreign key relations](./graphql.md#entity-relationships)
- Does not support enum creation or removal
- Migrations will not succeed `--unfinalizedBlocks` is enabled
- [GraphQL subscriptions](../run_publish/subscription.md) are not supported
- [Rewind](../run_publish/historical.md) will only be supported if the new schema does not drop any `fields` or `entity`. Note that [automated historical state tracking](../run_publish/historical.md) must be enabled to support rewind.

0 comments on commit 4b1bce8

Please sign in to comment.