Skip to content

Commit

Permalink
Merge pull request #742 from novuhq/preferences-data-migration
Browse files Browse the repository at this point in the history 
docs(migrations): Add preferences data migration
  • Loading branch information
@rifont
rifont authored Nov 29, 2024
2 parents b0e6960 + b17902a commit d2de7af
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions additional-resources/data-migrations.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,18 @@ Some features may have multiple migrations, in which case you will need to run e

Below you will find a list of migrations introduced in previous versions of Novu, alongside the migration path to use in the script above.

| Version | Feature | Migration Path(s) |
| ------------------------------------------------------------ | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [v0.23](https://github.com/novuhq/novu/releases/tag/v0.23.0) | API keys encryption | `./encrypt-api-keys/encrypt-api-keys-migration.ts` |
| [v0.18](https://github.com/novuhq/novu/releases/tag/v0.18.0) | Multi-Provider | `./integration-scheme-update/add-primary-priority-migration.ts`<br/>`./integration-scheme-update/add-integration-identifier-migration.ts` |
| | Integration Store | `./novu-integrations/novu-integrations.migration.ts` |
| [v0.16](https://github.com/novuhq/novu/releases/tag/v0.16.0) | In-App Integration | `./in-app-integration/in-app-integration.migration.ts` |
| | Secure Flag Fix | `./secure-to-boolean/secure-to-boolean-migration.ts` |
| [v0.15](https://github.com/novuhq/novu/releases/tag/v0.15.0) | Database TTL | `./expire-at/expire-at.migration.ts` |
| [v0.12](https://github.com/novuhq/novu/releases/tag/v0.12.0) | Organization Invite Fix | `./normalize-users-email/normalize-users-email.migration.ts` |
| [v0.9](https://github.com/novuhq/novu/releases/tag/v0.9.0) | Seen/Read Support | `./seen-read-support/seen-read-support.migration.ts` |
| [v0.8](https://github.com/novuhq/novu/releases/tag/v0.8.0) | Secure Credentials | `./fcm-credentials/fcm-credentials-migration.ts`<br/>`./encrypt-credentials/encrypt-credentials-migration.ts` |
| [v0.4](https://github.com/novuhq/novu/releases/tag/v0.4.0) | Change Promotion | `./changes-migration.ts` |
In some cases, it's necessary for Novu to remodel the data access layer to improve application performance as new data access patterns emerge. It is therefore important that each migration at the specified release tag commit is performed sequentially during version upgrades to ensure the necessary application code is available for the migration to succeed.

| Version | Feature | Migration Path(s) |
| ------------------------------------------------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [v2.1](https://github.com/novuhq/novu/releases/tag/v2.1.0) | Preference centralization | `./preference-centralization/preference-centralization-migration.ts` |
| [v0.23](https://github.com/novuhq/novu/releases/tag/v0.23.0) | API keys encryption | `./encrypt-api-keys/encrypt-api-keys-migration.ts` |
| [v0.18](https://github.com/novuhq/novu/releases/tag/v0.18.0) | Multi-Provider | `./integration-scheme-update/add-primary-priority-migration.ts`<br/>`./integration-scheme-update/add-integration-identifier-migration.ts` |
| | Integration Store | `./novu-integrations/novu-integrations.migration.ts` |
| [v0.16](https://github.com/novuhq/novu/releases/tag/v0.16.0) | In-App Integration | `./in-app-integration/in-app-integration.migration.ts` |
| | Secure Flag Fix | `./secure-to-boolean/secure-to-boolean-migration.ts` |
| [v0.15](https://github.com/novuhq/novu/releases/tag/v0.15.0) | Database TTL | `./expire-at/expire-at.migration.ts` |
| [v0.12](https://github.com/novuhq/novu/releases/tag/v0.12.0) | Organization Invite Fix | `./normalize-users-email/normalize-users-email.migration.ts` |
| [v0.9](https://github.com/novuhq/novu/releases/tag/v0.9.0) | Seen/Read Support | `./seen-read-support/seen-read-support.migration.ts` |
| [v0.8](https://github.com/novuhq/novu/releases/tag/v0.8.0) | Secure Credentials | `./fcm-credentials/fcm-credentials-migration.ts`<br/>`./encrypt-credentials/encrypt-credentials-migration.ts` |
| [v0.4](https://github.com/novuhq/novu/releases/tag/v0.4.0) | Change Promotion | `./changes-migration.ts` |

0 comments on commit d2de7af

Please sign in to comment.