Today, we are excited to share the 5.1.0 stable release 🎉

🌟 Help us spread the word about Prisma by starring the repo ☝️ or tweeting about the release.

Highlights

After two big releases where we released Client extensions for production usage (4.16.0) and made Prisma faster by default (5.0.0), we have focused on some smaller issues to make the experience with these new features even better.

Community contributions

Our community has been on the roll! We appreciate everyone who helps us by opening a GitHub issue or proposing a fix via Pull Requests. In this release, we're excited to highlight multiple community contributions:

• Fix IPv6 not working for relational databases: prisma/prisma-engines#4051 by @alula
• Middlewares: Add to PrismaAction type, missing findUniqueOrThrow and findFirstOrThrow #17471 by @mejiaej and missing groupBy #19985 by @iurylippo
• Better error message in currently non-supported runtimes like Browser or Vercel Edge Runtime #20163 by @andyjy
• Remove error messages for valid NixOS setups #20138 by @Gerschtli

Better performance: Fewer SQL queries on PostgreSQL & CockroachDB

In our continued and ongoing work to make Prisma faster, we identified some Prisma Client queries that led to multiple SQL statements being executed — although in specific databases, that was not necessary.

Hence we optimized our internal SQL generation for PostgreSQL and CockroachDB to generate more efficient SQL queries:

Simple create query

In a simple create query, RETURNING makes the second query and the transaction statements obsolete:

Prisma Client query

prisma.user.create({ 
  data: { name: "Original name" } 
})

Before v5.1.0

BEGIN
INSERT INTO "User" ("name") VALUES ($1) RETURNING "User"."id"
SELECT "User"."id", "User"."name" FROM "User" WHERE "User"."id" = $1;
COMMIT

5.1.0 and later

-- Sends 1 statement (instead of 2) and omits the transaction
INSERT INTO "User" ("name") VALUES ($1) RETURNING "User"."id", "User"."name"

Simple update query

For a simple update query, RETURNING makes both additional queries and the transaction statements obsolete:

Prisma Client query

prisma.user.update({ 
  where: { id: 1 }, 
  data: { name: "updated" } 
})

Before v5.1.0

BEGIN
SELECT id FROM "User" WHERE "User".id = 1;
UPDATE "User" SET name = 'updated' WHERE "User".id = 1;
SELECT id, name FROM "User" WHERE "User".id = 1;
COMMIT

5.1.0 and later

-- Sends 1 statement (instead of 3) and omits the transaction
UPDATE "User" SET name = 'updated' WHERE "User".id = 1 RETURNING "User".id, "User".name;

Simple update query, return with relation value

One SELECT query could easily be dropped in a simple update query that should return a relation value as well:

Prisma Client query

prisma.user.update({ 
  where: { id: 1 }, 
  data: { name: "updated" }, 
  includes: { posts: true }  
})

Before v5.1.0

BEGIN
SELECT id FROM "User" WHERE "User".id = 1;
UPDATE "User" SET name = 'updated' WHERE "User".id = 1;
SELECT id, name FROM "User" WHERE "User".id = 1;
SELECT id, title FROM "Post" WHERE "Post"."userId" = 1;
COMMIT

5.1.0 and later

-- Sends 3 statements (instead of 4)
BEGIN
UPDATE "User" SET name = 'updated' WHERE "User".id = 1 RETURNING "User".id;
SELECT id, name FROM "User" WHERE "User".id = 1;
SELECT id, title FROM "Post" WHERE "Post"."userId" = 1;
COMMIT

Empty update query

An empty update query can be optimized to skip the transaction and the second identical query by creating specific handling for this edge case in our code:

Prisma Client query

prisma.user.update({ 
  where: { id: 1 }, 
  data: {}, 
})

Before v5.1.0

BEGIN
SELECT id, name FROM "User" WHERE "User".id = 1;
SELECT id, name FROM "User" WHERE "User".id = 1;
COMMIT

5.1.0 and later

-- Sends 1 statement (instead of 2) and omits the transaction
SELECT id, name FROM "User" WHERE "User".id = 1;

Simple + relation update query (but do not return relation value)

An update of both the model and its relation, we could drop 2 SELECT queries that we did before without ever using their return values:

Prisma Client query

prisma.user.update({ 
  where: { id: 1 }, 
  data: {
    name: "updated",
    posts: {
      update: {
        where: { id: 1 },
        data: {
          title: "updated"
        }
      }
    }
  }
})

Before v5.1.0

BEGIN
SELECT id, name FROM "User" WHERE "User".id = 1;
UPDATE "User" SET name = 'updated' WHERE "User".id = 1 RETURNING "User".id;
SELECT "id", "postId" FROM "Post" WHERE "Post".id = 1;
UPDATE "Post" SET title = 'updated' WHERE "Post"."userId" = 1 AND "Post".id = 1;
SELECT id, name FROM "User" WHERE "User".id = 1;
COMMIT

5.1.0 and later

-- Sends 3 statements (instead of 5) 
BEGIN
UPDATE "User" SET name = 'updated' WHERE "User".id = 1 RETURNING "User".id, "User".name;
SELECT "id", "postId" FROM "Post" WHERE "Post".id = 1;
UPDATE "Post" SET title = 'updated' WHERE "Post"."userId" = 1 AND "Post".id = 1;
COMMIT

In the next releases, we will continue optimizing Prisma Client queries to only run the minimal amount of SQL queries necessary.

If you notice any Prisma Client queries that are affected right now, please check the issues under our performance/queries label. If you didn’t find one for what you’re seeing, please create a new issue. This will be super useful for us to understand all (edge) cases. Thank you!

Prisma Studio now supports directUrl

Our CLI command prisma studio that opens Prisma Studio now also can use the directUrl property of the datasource block so you can make it talk to a different database than defined in url. This makes it easier to use Studio alongside the Prisma Data Proxy and Accelerate.

Prisma Client: No more type clashes

We fixed (almost) all cases where using a specific term as a model name in your Prisma Schema would lead to a type clash due to Prisma’s generated typings. As a result of a type clash, it was not possible to use that model in your code (this was e.g. the case if you named a model Model or ModelUpdate).

We also deprecated the <ModelName>Args type as part of that fix. Going forward, <ModelName>DefaultArgs should be used instead.

Fixes and improvements

Prisma Client

• Reduce the number of generated SQL statements for Updates/Inserts
• [v2.17.0] Missing client TS types Aggregate*Args
• Reduce transactions for writes
• Incorrect Include typings when having models called X and XUpdate
• Model named "Check" is incorrectly typed
• Models named Query cause an internal GraphQL Parse Error
• Naming an entity "Query" leads to an error
• Type name clash when Model and ModelUpdate is defined in the schema
• Duplicate identifier 'CheckSelect'
• @prisma/internals (previously @prisma/sdk) uses deprecated dependencies uuid@3.4.0 via temp-write 4.0.0
• naming a model Datasource breaks generated return types
• Certain model names cause clashes in generated types
• Type error on query with select field (although query runs successfully)
• $extends TS error: "Inferred type of this node exceeds the maximum length the compiler will serialize" with "declaration": true in tsconfig
• Update operation includes multiple where statements for the same fields
• Type conflict when naming a table {something} and a second table {something}Result
• Type '"findUniqueOrThrow"' is not assignable to type 'PrismaAction'
• Naming a model Promise breaks types for PrismaPromise
• Prisma can't connect with an IPv6 host (on e.g. Fly.io)
• include not working on models ending with ...Update with unique compound index
• Prisma Client: fixing type name clashes from generated client
• Prisma Client: wrong type when using spread operator to set default values on query args
• The generated updateArgs have no update attribute
• 4.16.1 breaks type check
• LogLevel enum conflicts with built-in Prisma type
• Using Prisma.XyzFindManyArgs breaks findMany typing in v4.16.0+
• this.$on("beforeExit") doesn't work anymore on 5.0.0
• Wrong nullable types with fluent API in Prisma 5.0
• Error: Unknown value type on nested create
• Prisma 5.0 Migration findUnique on @unique columns that are enums
• <Tablename>UpsertArgs select field does not match type for db.<tablename>.upsert(item)
• TypeScript Error TS2322 when assigning JavaScript Date object to Prisma DateTime field
• npm install of Prisma CLI fails on preinstall with no logs when Node.js version is lower than minimum
• Types wrongly accept non-array parameter by in groupBy in 5.0.0
• CLI errors with TypeError [ERR_INVALID_URL]: Invalid URL when HTTP(S)_PROXY en var has is set to a URL without a protocol
• tsc --watch fails with JavaScript heap out of memory error
• Hovering over types (intellisense) shows confusing GetResult
• Internal query batching fails when the table name is 'stores'
• Client extensions: result extensions should be applied after query extensions

Prisma Studio

• Use directUrl in prisma studio

Language tools (e.g. VS Code)

• The extension for VS Code ignores the modern telemetry flag
• Prisma VS Code extension with mongodb provider crashes when a relation field/type is not defined
• Editing schema.prisma results in wasm panics

Credits

Huge thanks to @skyzh, @alula, @michaelpoellath, @RobertCraigie, @Gerschtli, @andyjy, @mejiaej, @iurylippo, @mrazauskas for helping!