tabshift/payload
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve migration guide for running db migrations

Browse Source
This commit is contained in:
Elliot DeNolf
2024-11-20 11:34:57 -05:00
parent 568e1a274b
commit ff0386f276
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/migration-guide/overview.mdx
View File

@@ -66,7 +66,14 @@ For more details, see the [Documentation](https://payloadcms.com/docs/getting-st
pnpm remove express nodemon @payloadcms/bundler-webpack @payloadcms/bundler-vite pnpm remove express nodemon @payloadcms/bundler-webpack @payloadcms/bundler-vite
``` ```
1. For Payload Cloud users, the plugin has changed. 1. Database Adapter Migrations
_If you have existing data_ and are using the MongoDB or Postgres adapters, you will need to run the database migrations to ensure your database schema is up-to-date.
- [postgres](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.39)
- [mongodb](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.131)
2. For Payload Cloud users, the plugin has changed.
Uninstall the old package: Uninstall the old package:
@@ -94,7 +101,7 @@ For more details, see the [Documentation](https://payloadcms.com/docs/getting-st
}) })
``` ```
1. **Optional** sharp dependency 3. **Optional** sharp dependency
If you have upload enabled collections that use `formatOptions`, `imageSizes`, or `resizeOptions`—payload expects to have `sharp` installed. In 2.0 this was a dependency was installed for you. Now it is only installed if needed. If you have any of these options set, you will need to install `sharp` and add it to your payload.config.ts: If you have upload enabled collections that use `formatOptions`, `imageSizes`, or `resizeOptions`—payload expects to have `sharp` installed. In 2.0 this was a dependency was installed for you. Now it is only installed if needed. If you have any of these options set, you will need to install `sharp` and add it to your payload.config.ts:
@@ -111,10 +118,6 @@ For more details, see the [Documentation](https://payloadcms.com/docs/getting-st
}) })
``` ```
1. Database Adapter Migrations
If you have existing data and are using the MongoDB or Postgres adapters, you will need to run the database migrations to ensure your database schema is up-to-date. Follow the instructions from the release notes for [postgres](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.39) or [mongodb](https://github.com/payloadcms/payload/releases/tag/v3.0.0-beta.131) depending on your chosen adapter.
## Breaking Changes ## Breaking Changes
1. Delete the `admin.bundler` property from your Payload Config. Payload no longer bundles the Admin Panel. Instead, we rely directly on Next.js for bundling. 1. Delete the `admin.bundler` property from your Payload Config. Payload no longer bundles the Admin Panel. Instead, we rely directly on Next.js for bundling.
@@ -979,7 +982,7 @@ export default buildConfig({
- If you have created a custom adapter, the type must now provide a `name` property. - If you have created a custom adapter, the type must now provide a `name` property.
| Service | Package | | Service | Package |
| -------------------- |------------------------------------------------------------------------------| | -------------------- | ---------------------------------------------------------------------------- |
| Vercel Blob | https://github.com/payloadcms/payload/tree/main/packages/storage-vercel-blob | | Vercel Blob | https://github.com/payloadcms/payload/tree/main/packages/storage-vercel-blob |
| AWS S3 | https://github.com/payloadcms/payload/tree/main/packages/storage-s3 | | AWS S3 | https://github.com/payloadcms/payload/tree/main/packages/storage-s3 |
| Azure | https://github.com/payloadcms/payload/tree/main/packages/storage-azure | | Azure | https://github.com/payloadcms/payload/tree/main/packages/storage-azure |