This repository was archived by the owner on Jan 13, 2025. It is now read-only.
chore(deps): update prisma monorepo to v5 (major) #51
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.
This PR contains the following updates:
^4.16.2->^5.0.0^4.16.2->^5.0.0Release Notes
prisma/prisma (@prisma/client)
v5.0.0Compare Source
We’re excited to share the
5.0.0release today 🎉Prisma
5.0.0contains a lot of changes that improve Prisma’s performance, especially in serverless environments. If you want to learn more about the performance improvements, we wrote a blog post that sums up all the changes we made: Prisma 5: Faster by Default.As this is a major release, it includes a few breaking changes that might affect a small group of our users. Before upgrading, we recommend that you check out our upgrade guide to understand the impact on your application.
🌟 Help us spread the word about Prisma by starring the repo or tweeting about the release. 🌟
Highlights
Here’s a summary of the changes:
jsonProtocol: improves communication between Prisma Client and the query engine, makes Prisma faster by default.fieldReference: adds support for comparing columns of the same table.extendedWhereUnique: adds support for non-unique columns insidewhereclauses for queries that operate on unique records.rejectOnNotFoundpropertycockroachdbprovider is now required when connecting to a CockroachDB databaseruntime/index.jsfrom the generated Prisma ClientbeforeExithook from the library engineprisma2executableexperimentalFeaturesgenerator property in the Prisma schemamigration-enginetoschema-engineA JSON-based protocol that improves Prisma’s performance
We’re thrilled to announce that the
jsonProtocolPreview feature is now Generally Available. You can now remove the Preview feature flag from your schema after upgrading. We made the JSON-based wire protocol the default protocol used for communication between Prisma Client and the query engine.We introduced this feature in version 4.11.0 to improve Prisma’s performance. Previously, Prisma used a GraphQL-like protocol to communicate between Prisma Client and the query engine. Applications with larger schemas had higher CPU and memory consumption compared to smaller schemas which created a performance bottleneck.
The JSON-based wire protocol improves efficiency when Prisma Client is communicating with the query engine.
Removal of array shortcuts
We took the opportunity to remove some array shortcuts to make our typings more consistent and logical. These shortcuts were a way to add a single element as a value to an array-based operator instead of wrapping a single element in an array. We will now require array values for the following:
ORoperator shortcutsinandnotInoperator shortcutspathfield shortcutHere’s an example query using the
ORoperator shortcut for a single element;await prisma.user.findMany({ where: { - OR: { email: 'alice@prisma.io' } + OR: [{ email: 'alice@prisma.io' }] } })We recommend taking a look at the upgrade guide to learn how you can update your queries to work in Prisma 5.
Support for comparing multiple columns
We’re excited to announce that the
fieldReferencePreview feature is now stable and Generally Available. This means you can use this feature without the Preview feature flag in your Prisma schema.We first introduced this feature in 4.5.0 to add the ability to compare columns on the same table. For example, the following query returns records where the
quantityvalue is less than thewarnQuantityof a product:To learn more about this feature, refer to our documentation.
Support for filtering non-unique columns in queries for a unique record
We’re excited to announce the
extendedWhereUniquePreview feature is now Generally Available. This means you can use the feature without the Preview feature flag in the Prisma schema.We first introduced this feature in version 4.5.0 to add support for non-unique columns inside
whereclauses for queries that operate on unique records, such asfindUnique,update, anddelete, which was previously not possible.For example, consider the following model:
You can filter on non-unique columns such as the
versionfield as follows:To learn more about this feature, refer to our documentation.
Minimum Node.js version change to 16.13.0
The minimum version of Node.js Prisma supports is
16.13.0. If you're using an earlier version of Node.js, you will need to upgrade your Node.js version.Refer to our system requirements for the minimum versions Prisma requires.
Minimum TypeScript version change to 4.7
The minimum version of TypeScript Prisma supports is 4.7. If your project is using an earlier version of TypeScript, you will need to upgrade your TypeScript version.
Refer to our system requirements for the minimum versions Prisma requires.
Minimum PostgreSQL version change to 9.6
The minimum version of PostgreSQL Prisma supports is version 9.6. If you’re either using 9.4 or 9.5, you will need to update your PostgreSQL version to at least 9.6.
Refer to our system requirements for the minimum database versions Prisma requires.
Prisma Client embedded SQLite version upgrade
We upgraded the embedded version of SQLite from 3.35.4 to 3.41.2. We do not anticipate any breaking changes or changes needed in projects using SQLite. However, if you’re using SQLite, especially with raw queries that might go beyond Prisma's functionality, make sure to check the SQLite changelog.
Removal of
rejectOnNotFoundpropertyIn version 5.0.0, we removed the
rejectOnNotFoundparameter from Prisma Client that was deprecated in version 4.0.0. We removed this feature to provide better type-safety using thefindUniqueOrThrowandfindFirstOrThrowmethods as well have a consistent API.If you are using the
rejectOnNotFoundparameter we recommend either:findFirstOrThroworfindUniqueOrThrowmethods if enabled at a query-levelfindFirstOrThrowandfindUniqueOrThrowmodel methods with your custom error handling if enabled at the client-levelWe recommend taking a look at the upgrade guide for more information on how to adapt your application if you’re using
rejectOnNotFound.cockroachdbprovider is now required when connecting to a CockroachDB databasePrior to adding explicit support for CockroachDB with the
cockroachdbprovider in 3.9.0, it was possible to use the PostgreSQL provider when working with CockroachDB databases.We’re now making it mandatory to use the CockroachDB connector when working with CockroachDB databases. CockroachDB and PostgreSQL have a few differences such as the available native types which impact the generated migrations.
If you were using the PostgreSQL connector to work with CockroachDB, take a look at the upgrade guide to learn how you can update your connector.
Removal of the generated
runtime/index.jsfile from Prisma ClientWith Prisma 5, we removed the
runtime/index.jsfile from Prisma Client. If you were using APIs fromruntime/index.js, such asDecimal,PrismaClientKnownRequestError,NotFoundError,PrismaClientUnknownRequestError, we recommend updating your imports:We recommend taking a look at the upgrade guide to learn how you can migrate to Prisma 5
Removal of the
beforeExithook from thelibraryquery engineWe removed the
beforeExithook from the defaultlibraryQuery Engine. We recommend using the built-in Node.js exit events.-prisma.$on('beforeExit', () => { /* your code */ }) // Replacements process.on('beforeExit', () => { /* your code */ }) process.on('exit', exitHandler) process.on('SIGINT', exitHandler) process.on('SIGTERM', exitHandler) process.on('SIGUSR2', exitHandler)We recommend taking a look at the upgrade guide to learn how you can migrate to Prisma 5.
Removal of deprecated
prisma2executableWhen we released Prisma 2, the
prisma2executable was used to differentiate it from Prisma 1. In a later release, theprisma2CLI took over theprismaexecutable name.The
prisma2executable has been deprecated for a while and will now be removed. If you’re usingprisma2in your scripts, replace it withprisma.Removal of deprecated flags in the Prisma CLI
We removed the following deprecated flags in the Prisma CLI:
--preview-feature: used in theprisma db execute,prisma db seed, andprisma migrate diffcommands--experimentaland--early-access-feature: used in theprisma migratecommands such asprisma migrate dev--force: forprisma db push. The--forceflag was replaced by--accept-data-lossin version 2.17.0--experimental-reintrospectionand--clean: forprisma db pullIn the event you’re using one of these flags, we recommend removing the flags.
Removal of deprecated
experimentalFeaturesgenerator propertyIn this release, we removed the
experimentalFeaturesproperty that used to be in the generator property in the Prisma schema but has been renamed topreviewFeaturesfor a long time now. If you’re still using this property, you can either manually rename it topreviewFeaturesor use the VS Code action to rename it if you’re using the latest version of the Prisma VS Code extension.Renamed
migration-enginetoschema-engineIn this release, we renamed the
migration-engine, responsible for running introspection and migration commands, toschema-engine. For the majority of our users, no changes will be required. However, if you explicitly include or exclude the engine files you will need to update your code references. Refer to the upgrade guide for more information.Fixes and improvements
Prisma Client
createcall<Model>RelationFilterInputdoes not take nullability into accountORbroke after opting in tojsonProtocolfeature.jsonProtocol)jsonProtocolGAbinaries.prisma.sh/all_commits/rejectOnNotFoundruntime/index.jsbundle from clientprisma devcommandphotonResolverandprovider=photonjshandlingfieldReferenceGAextendedWhereUniqueGAprisma2"executable"$extendin factory function whencompilerOptions.compositeistruequerytype toneverThe package "path" wasn't found on the file system but is built into nodeundefinedexplicitly passed toselect/includePrisma Migrate
provider = "postgresql"an errorexperimentalFeaturesgenerator propertydb pull: Remove the version checker from introspectiondoctorcommandexperimentalFeaturesgenerator propertyexperimentalFeaturesLanguage tools (e.g. VS Code)
experimentalFeaturesas obsoleteCredits
Huge thanks to @michaelpoellath, @RobertCraigie, @Coder246, @RDIL, @oohwooh, @rqres, @zhiyan114, @spudly, @hayes, @boennemann, @DongGunYoon for helping!
📺 Join us for another "What's new in Prisma" live stream
Learn about the latest release and other news from the Prisma community by joining us for another "What's new in Prisma" live stream.
The stream takes place on YouTube on Thursday, July 13 at 5 pm Berlin | 8 am San Francisco.
Configuration
📅 Schedule: Branch creation - "before 12pm on Sunday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR has been generated by Mend Renovate. View repository job log here.