@prisma/client

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

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

Major improvements and new features

We are working towards a stable release of MongoDB and are shipping lots of improvements. All the new features and changes in this release therefore only apply to the MongoDB connector. Take a closer look if you are using the Preview of MongoDB as some of the changes are breaking.

Embedded documents support is now in Preview

We're super excited to announce that Prisma version 3.10.0 supports reading and modifying embedded documents. Embedded documents will provide access to a new type keyword in your Prisma schema that you can use to define composite types.

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["mongoDb"]
}

model Product {
  id     String  @id @default(auto()) @map("_id") @db.ObjectId
  name   String
  photos Photo[]
}

type Photo {
  height Int
  width  Int
  url    String
}

Given the schema above, you can now read and write to the embedded photos array:

// Create a new product with an embedded list of photos
const product = await prisma.product.create({
  data: {
    name: "Forest Runners",
    // Create an embedded list of photos in the product
    photos: [
      { height: 100, width: 200, url: "1.jpg" },
      { height: 300, width: 400, url: "2.jpg" },
    ],
  },
})

Best of all, the query is entirely type-safe! This scratches the surface of what's possible with embedded documents. You can read further in our documentation.

If you run into anything, feel free to open an issue, and we’ll give you a hand!

Introspection of embedded documents is now enabled by default

We added Preview support for Introspection of embedded documents in version 3.4.0 and are now activating it for all users. Running prisma db pull against your MongoDB database will generate type definitions within your Prisma schema.

When introspecting your database, you can switch off the depth with --composite-type-depth=0, or limit it with, for example, --composite-type-depth=2.

Feel free to drop your feedback on the feature on GitHub.

@default(dbgenerated()) is now replaced with @default(auto())

The original purpose of dbgenerated is to support SQL expressions Prisma doesn’t understand yet. However, MongoDB doesn’t have a concept of default value expressions like SQL does. We took this opportunity to simplify how we handle the default values in MongoDB:

model Post {
-  id String @id @default(dbgenerated()) @map("_id") @db.ObjectId
+  id String @id @default(auto()) @map("_id") @db.ObjectId
}

Many-to-Many relations now require a references argument

Prisma version 3.10.0 now enforces all arguments in a MongoDB many-to-many relation. This means a @relation attribute must define fields and references arguments on both sides.

The fields argument must point to a scalar field in the same model, and this scalar field must be an array. The references arguments must point to a scalar field in the opposite model, and it must be a singular type of the same base type as the referencing array on the other side.

model Post {
  id           String     @id @map("_id") @default(auto()) @db.ObjectId
  category_ids String[]   @db.ObjectId
- categories   Category[] @relation(fields: [category_ids])
+ categories   Category[] @relation(fields: [category_ids], references: [id])
}
    
model Category {
  id       String   @id @map("_id") @default(auto()) @db.ObjectId
  post_ids String[] @db.ObjectId
- posts    Post[]   @relation(fields: [post_ids])
+ posts    Post[]   @relation(fields: [post_ids], references: [id])
}

@db.Array(ObjectId) is now updated to @db.ObjectId

We've adjusted the Prisma schema format for scalar lists with native types (like lists of Object IDs). This will likely affect those with many-to-many relationships in MongoDB. We made this change to align MongoDB with our existing SQL databases better:

model Post {
  id          String     @id @default(auto()) @map("_id") @db.ObjectId
- categoryIDs String[]   @db.Array(ObjectId)
+ categoryIDs String[]   @db.ObjectId
  categories  Category[] @relation(fields: [categoryIDs], references: [id])
}

model Category {
  id      String   @id @default(auto()) @map("_id") @db.ObjectId
- postIDs String[] @db.Array(ObjectId)
+ postIDs String[] @db.ObjectId
  posts   Post[]   @relation(fields: [postIDs], references: [id])
}

Fixes and improvements

Prisma Migrate

• Ability to create SQL table logic from schema without doing a "migrate"
• Improve error on default values when @db.ObjectId isn't present
• Validator accepts arbitrary properties in datasource blocks
• Programmatically create a MongoDB database
• prisma init --url does not like mongodb+srv://
• Test the error reporting backend with MongoDb
• Better Schema validation for MongoDB
• Code 19 and unformatted list output during Re-Introspection
• MongoDB Introspection Multiple Types warning message in CLI output does not differentiate models and embedded documents
• MongoDB Introspection Embedded Documents do not require id_ special case
• Introspection result Unsupported("Unknown") causes schema validation to crash
• Confidence Tooling run and result verification for embedded documents
• MongoDB Introspection connects to database even when failing with error message that should not require connection to database at all
• Change @db.Array(ObjectId) to @db.ObjectId
• Make sure Unsupported(...) fields are not rejected on composite types
• MongoDB PSL parsing should fail when using @default(autoincrement())
• Error: [/root/build/libs/mongodb-schema-describer/src/lib.rs:35:41] called Option::unwrap() on a None value
• MongoDB embedded documents Introspection does not give any names to fields with invalid names
• Embedded document _id of type ObjectId are introspected without native type @db.ObjectId
• "experimental feature, needs to be enabled"
• MongoDB: On ID fields, replace @default(dbgenerated()) with @default(auto())
• Implement datamodel parser validations for two-way embedded many-to-many relations on MongoDB
• MongoDB: The connection string format and parameters are defined by mongo-rust-driver
• prisma db pull doesn't read .env file and errors with Environment variable not found: DATABASE_URL
• [MDB] Do not hardcode _id to ObjectId during Introspection
• [MDB] Schema validation error on valid composite type
• Turn on embedded document Introspection by default
• Model "undefined", field: ...
• MongoDB Introspection does not output how many embedded documents were introspected
• Sharded MongoDB connection string is not supported by Prisma Client
• Add mongodb 4.2 to tested versions on migrate & introspection
• Confirm sharded MongoDB connection string is supported by MongoDB Rust Driver
• MongoDB: Error when no database name supplied in connection string
• Multiple data types found: Array(Array(Array(Double))): 86.2%, Array(Array(Array(Array(Double)))): 13.8% out of 195 sampled entries

Prisma Client

• Unable to use dbgenerated uuid_to_bin for ID field: "Could not figure out an ID in create"
• groupBy is not usable with $transaction
• InteractiveTransaction: Middleware param runInTransaction set to false
• MDBGA: Support MongoDB Atlas Serverless
• Incorrect Typescript type for QueryEvent.timestamp
• Using "then ()" in "interactive Transactions" initiates another transaction
• MDBE: Write usage guide on MongoDB Embedded Documents Support
• MongoDB first request takes ~45s on Windows
• Prisma Client: .count does not work with where
• interactiveTransactions feature breaks long running transactions
• Go through the existing iTX and explore what needs to be worked on
• Cannot extend PrismaClient class
• MongoDB: add test on TS side for ObjectId arrays a_ids String[] @db.ObjectId
• Prisma Client: Fluent API chaining not working for PascalCase columns in 3.9.1
• Interactive transaction: Sequential Prisma Client operations timeout but work when interactive transactions are disabled
• prisma v3.9.1: Get TypeError(read-only and non-configurable data property on the proxy target) when use jest.fn().mockReturnValue.
• Avoid shipping unused intermediary ESM files
• Unable to parse Connection String in Sharded MongoDB
• Prisma Client queries are executed multiple times in 3.9.1
• Send prisma as driverInfo to MongoDB
• Fluent API is no longer supported at runtime for mutations

Credits

Huge thanks to @andyrichardson, @xnerhu, @Josh-a-e, @dusandz, @hyochan, @cesconix, @benkroeger, @YassinEldeeb, @chenkie for helping!

📺 Join us for another "What's new in Prisma" livestream

Learn about the latest release and other news from the Prisma community by joining us for another "What's new in Prisma" livestream.

The stream takes place on YouTube on Thursday, February 03 at 5 pm Berlin | 8 am San Francisco.