Skip to content

Commit

Permalink
Project grafting keyword
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbayly committed Jan 23, 2024
1 parent 8330340 commit d25cbde
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/build/project-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Project upgrades allow you to safely make changes to your project at a specified

It's particularly useful when you want to maintain the data of the previous project (e.g. when the previous project takes a long time to index from scratch), and you only want to add a new feature from a specific point in time.

Some other projects call this feature "Project Grafting".

## Requirements

- In order for this feature to work you need to have [automated historical state tracking](../run_publish/historical.md) enabled in case the project needs to rewind to a block where the upgrade happens.
Expand Down Expand Up @@ -59,6 +61,7 @@ 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 @@ -69,6 +72,7 @@ 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
Expand Down

0 comments on commit d25cbde

Please sign in to comment.