Skip to content

client-api-mapping.md

Latest commit

 

History

History
61 lines (46 loc) · 3.99 KB

client-api-mapping.md

File metadata and controls

61 lines (46 loc) · 3.99 KB
Raw

client-api-mapping

How v6 Prisma Client calls map to Prisma Next's Mongo client — names map, parity does not.

Priority

CRITICAL

Why It Matters

The v6 and Next client APIs look superficially similar, but none of the v6 MongoDB raw methods exist under their old names, aggregation moved to a different lane entirely, and transactions go through the driver rather than a façade wrapper. Assuming parity produces code that does not compile — or, in the transactions case, code that silently loses atomicity.

The mapping

v6 call Prisma Next equivalent Notes
prisma.user.findMany(...) db.orm.users.where(...).all() Fluent ORM lane; storage-name keys (see schema-contract-mapping.md)
prisma.user.findFirst(...) db.orm.users.where(...).first()
create / update / upsert / delete / updateMany / deleteMany create / update / upsert / delete / updateAll / deleteAll on db.orm.<collection> See Prisma Next's prisma-next-queries skill
prisma.user.aggregate(...), groupBy(...) No ORM equivalent. Use the typed aggregation-pipeline builder: db.query.from(...).match(...).group(...).build() Prisma Next's prisma-next-queries skill covers the builder lane
$runCommandRaw(...) (v6 docs) Name does not exist in Next. Raw lane is mongoRaw(...) → a raw collection with aggregate, insertOne/Many, updateOne/Many, deleteOne/Many, findOneAndUpdate/Delete. For arbitrary database commands, use the underlying mongodb driver directly — it is a user-supplied peer dependency and fully accessible Check the installed version's raw surface
<model>.findRaw(...) (v6 docs) mongoRaw(...) collection reads (e.g. aggregate with a $match stage) No direct findRaw name
<model>.aggregateRaw(...) (v6 docs) mongoRaw(...).aggregate(...) or the typed pipeline builder
$transaction(...) — works on v6 with a replica set (v6 docs) The façade does not wrap db.transaction(...) yet, but the underlying mongodb driver is directly available (user-supplied peer dependency): multi-document atomicity works today via driver sessions (client.startSession() / session.withTransaction(...)) on a replica set A façade wrapper is expected soon; this row will be updated when it merges
$connect / $disconnect connect() / close() on the Mongo façade client

Bad

// Assuming v6 names exist in Prisma Next:
await db.user.$runCommandRaw({ collStats: 'users' }); // no such method
await db.transaction(async (tx) => { ... });          // no such method on the Mongo façade

Good

// Raw lane under its Next name:
const raw = mongoRaw(db);
await raw.users.aggregate([{ $match: { status: 'active' } }]);

// Aggregation through the typed pipeline builder:
const stats = await db.query.from('users').group({ _id: '$role', n: { $count: {} } }).build();

// Multi-document atomicity today: the mongodb driver (a direct dependency of the
// project) exposes sessions and transactions as usual:
const session = mongoClient.startSession();
await session.withTransaction(async () => {
  // ...writes...
});

References