@prisma/client

What is @prisma/client?

The @prisma/client package is an auto-generated and type-safe query builder that's tailored to your data model. It's part of the Prisma ORM and is designed to make database access easy and intuitive in Node.js and TypeScript applications.

What are @prisma/client's main functionalities?

Fetching data

This feature allows you to fetch data from the database. The code sample demonstrates how to retrieve all records from the 'user' table.

const users = await prisma.user.findMany();

Creating data

This feature is used to create new records in the database. The code sample shows how to create a new user with a name and email.

const user = await prisma.user.create({ data: { name: 'Alice', email: '[e-mail]' } });

Updating data

This feature allows you to update existing records in the database. The code sample demonstrates updating the name of a user with a specific ID.

const updateUser = await prisma.user.update({ where: { id: 1 }, data: { name: 'Bob' } });

Deleting data

This feature enables you to delete records from the database. The code sample shows how to delete a user with a particular ID.

const deleteUser = await prisma.user.delete({ where: { id: 1 } });

Other packages similar to @prisma/client

sequelize

Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite, and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication, and more. Compared to @prisma/client, Sequelize has been around for longer and has a wider adoption, but Prisma offers a more modern approach with a focus on type safety and ease of use.

typeorm

TypeORM is an ORM that can run in Node.js, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms and can be used with TypeScript and JavaScript (ES5, ES6, ES7, ES8). It's heavily influenced by other ORMs, such as Hibernate, Doctrine, and Entity Framework. TypeORM provides a similar level of abstraction as @prisma/client but with a different API and philosophy, focusing more on the data-mapper pattern.

knex

Knex.js is a 'batteries included' SQL query builder for Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift designed to be flexible, portable, and fun to use. It provides the building blocks for setting up a database schema and writing queries. While Knex doesn't offer the same level of abstraction or type safety as @prisma/client, it is a powerful query builder that's been widely used in the Node.js community.

README

Prisma Client ·

Prisma Client JS is an auto-generated query builder that enables type-safe database access and reduces boilerplate. You can use it as an alternative to traditional ORMs such as Sequelize, TypeORM or SQL query builders like knex.js.

It is part of the Prisma ecosystem. Prisma provides database tools for data access, declarative data modeling, schema migrations and visual data management. Learn more in the main prisma repository or read the documentation.

Getting started

Follow one of these guides to get started with Prisma Client JS:

• Quickstart (5 min)
• Setup a new project with Prisma (SQL migrations) (15 min)
• Setup a new project with Prisma (Prisma Migrate) (15 min)
• Add Prisma to an existing project (15 min)

Alternatively you can explore the ready-to-run examples (REST, GraphQL, gRPC, plain JavaScript and TypeScript demos, ...) or watch the demo videos (1-2 min per video).

Contributing

Refer to our contribution guidelines and Code of Conduct for contributors.

Build Status

• Prisma Tests Status:
  
• E2E Tests Status: