prisma

What is prisma?

Prisma is an open-source database toolkit that includes an ORM (Object-Relational Mapper), migrations, and a query builder for Node.js and TypeScript. It simplifies database access, ensures type safety, and can be used to build GraphQL and REST APIs.

What are prisma's main functionalities?

ORM (Object-Relational Mapping)

Prisma's ORM allows you to interact with your database through an object-oriented model. The code sample demonstrates how to fetch all users from the database using Prisma's ORM.

const { PrismaClient } = require('@prisma/client');
const prisma = new PrismaClient();

async function main() {
  const allUsers = await prisma.user.findMany();
  console.log(allUsers);
}

main()
  .catch(e => {
    throw e
  })
  .finally(async () => {
    await prisma.$disconnect()
  });

Migrations

Prisma Migrate generates and runs SQL migrations based on your Prisma schema. The code sample shows how to create and apply a new migration called 'init'.

npx prisma migrate dev --name init

Type Safety

Prisma ensures type safety by generating TypeScript types based on your database schema. The code sample demonstrates fetching a user with a specific ID and the result is typed as 'User'.

const user: User = await prisma.user.findUnique({ where: { id: 1 } });

Data Modeling

Prisma uses a schema file to model your database. The code sample shows a Prisma schema definition for a User model with an auto-incrementing ID, name, and unique email.

model User {
  id    Int     @id @default(autoincrement())
  name  String
  email String  @unique
}

Query Builder

Prisma's query builder allows you to construct complex queries with ease. The code sample demonstrates ordering users by their name in ascending order.

const sortedUsers = await prisma.user.findMany({
  orderBy: {
    name: 'asc',
  },
});

Other packages similar to prisma

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, Sequelize has been around for longer and has a more traditional API, but it might not offer the same level of type safety and simplicity in schema management.

typeorm

TypeORM is an ORM that can run in Node.js, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, and Electron platforms and can be used with TypeScript and JavaScript. TypeORM is highly influenced by other ORMs, such as Hibernate, Doctrine, and Entity Framework. It provides a similar level of type safety as Prisma but with a different approach to defining models and running migrations.

knex

Knex.js is a SQL query builder for Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift, designed to be flexible, portable, and fun to use. It does not include an ORM by default, but it can be paired with objection.js for ORM functionality. Knex is more of a query builder than a full-fledged ORM and lacks the type safety and model generation features of Prisma.

README

Prisma CLI ·

Learn more about Prisma in the docs.

Getting started

Check out the Getting Started Quickstart.

Installation

The Prisma CLI currently requires Node.js 12.2 (or higher). We recommend using the latest Node.js LTS ("long-term support") release.

npm

npm install prisma --save-dev

Yarn

yarn add prisma --dev

Check out the docs for more information.

CLI Reference

Check out the docs for Prisma CLI commands, arguments, and options.

Contributing

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

Build Status

• Prisma Tests Status:
  
• E2E Tests Status: