8 |
30 | 11 | 404 12 |
13 |16 | Page not found 17 |
18 |19 | Sorry, we couldn't find the page you're looking for. 20 |
21 |
22 |
26 | Go back home
27 |
28 |
29 |
12 |
30 |
--------------------------------------------------------------------------------
/docs/src/content/docs/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Installation
3 | ---
4 |
5 | ## Automatic Install
6 |
7 | Use the [nest add](/docs/schematics) command to automatically setup the library, Prisma and Docker (optionally):
8 |
9 | ```sh
10 | nest add nestjs-prisma
11 | ```
12 |
13 | ## Manual Install
14 |
15 | Add `nestjs-prisma` library to your [NestJS application](https://docs.nestjs.com/#installation):
16 |
17 | ```sh
18 | # npm
19 | npm install nestjs-prisma
20 |
21 | # yarn
22 | yarn add nestjs-prisma
23 | ```
24 |
25 | Furthermore, setup [Prisma](https://www.prisma.io/docs/getting-started/setup-prisma/add-to-existing-project/relational-databases-typescript-postgres#set-up-prisma) in your NestJS application, if you haven't already.
26 |
27 | ```sh
28 | npm i -D prisma
29 | npm install @prisma/client
30 |
31 | npx prisma init
32 | ```
33 |
--------------------------------------------------------------------------------
/lib/prisma.service.ts:
--------------------------------------------------------------------------------
1 | import { Inject, Injectable, OnModuleInit, Optional } from '@nestjs/common';
2 | import { Prisma, PrismaClient } from '@prisma/client';
3 | import { PrismaServiceOptions } from './interfaces';
4 | import { PRISMA_SERVICE_OPTIONS } from './prisma.constants';
5 |
6 | @Injectable()
7 | export class PrismaService
8 | extends PrismaClient<
9 | Prisma.PrismaClientOptions,
10 | 'query' | 'info' | 'warn' | 'error'
11 | >
12 | implements OnModuleInit
13 | {
14 | constructor(
15 | @Optional()
16 | @Inject(PRISMA_SERVICE_OPTIONS)
17 | private readonly prismaServiceOptions: PrismaServiceOptions = {},
18 | ) {
19 | super(prismaServiceOptions.prismaOptions);
20 | }
21 |
22 | async onModuleInit() {
23 | if (this.prismaServiceOptions.explicitConnect) {
24 | await this.$connect();
25 | }
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/examples/driver/src/generated/prisma/browser.ts:
--------------------------------------------------------------------------------
1 |
2 | /* !!! This is code generated by Prisma. Do not edit directly. !!! */
3 | /* eslint-disable */
4 | // biome-ignore-all lint: generated file
5 | // @ts-nocheck
6 | /*
7 | * This file should be your main import to use Prisma-related types and utilities in a browser.
8 | * Use it to get access to models, enums, and input types.
9 | *
10 | * This file does not contain a `PrismaClient` class, nor several other helpers that are intended as server-side only.
11 | * See `client.ts` for the standard, server-side entry point.
12 | *
13 | * 🟢 You can import this file directly.
14 | */
15 |
16 | import * as Prisma from './internal/prismaNamespaceBrowser.js'
17 | export { Prisma }
18 | export * as $Enums from './enums.js'
19 | export * from './enums.js';
20 | /**
21 | * Model User
22 | *
23 | */
24 | export type User = Prisma.UserModel
25 |
--------------------------------------------------------------------------------
/examples/fastify/src/app.service.ts:
--------------------------------------------------------------------------------
1 | import { Injectable } from '@nestjs/common';
2 | import { PrismaService } from 'nestjs-prisma';
3 | import { CreateUserDto } from './dto/create-user.dto';
4 |
5 | @Injectable()
6 | export class AppService {
7 | constructor(private prisma: PrismaService) {}
8 |
9 | createUser(createUserDto: CreateUserDto) {
10 | return this.prisma.user.create({ data: createUserDto });
11 | }
12 |
13 | users() {
14 | return this.prisma.user.findMany();
15 | }
16 |
17 | user(userId: string) {
18 | // returns `null` if not found
19 | // return this.prisma.user.findUnique({
20 | // where: { id: userId },
21 | // });
22 | // throws `Prisma.NotFoundError` if not found, use `PrismaClientExceptionFilter` to catch the exception
23 | return this.prisma.user.findUniqueOrThrow({
24 | where: { id: userId },
25 | });
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/docs/src/icons/github.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/workflows/node.js.yml:
--------------------------------------------------------------------------------
1 | # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
3 |
4 | name: Build
5 |
6 | on:
7 | push:
8 | branches: [ main ]
9 | pull_request:
10 | branches: [ main ]
11 |
12 | jobs:
13 | build:
14 |
15 | runs-on: ubuntu-latest
16 |
17 | strategy:
18 | matrix:
19 | node-version: [20, 22]
20 |
21 | steps:
22 | - uses: actions/checkout@v4
23 | - name: Use Node.js ${{ matrix.node-version }}
24 | uses: actions/setup-node@v4
25 | with:
26 | node-version: ${{ matrix.node-version }}
27 | cache: 'npm'
28 | - run: npm install
29 | - run: npx prisma generate
30 | - run: npm run lint
31 | - run: npm run build
32 |
--------------------------------------------------------------------------------
/examples/basics/src/app.module.ts:
--------------------------------------------------------------------------------
1 | import { Module } from '@nestjs/common';
2 | import { APP_FILTER, HttpAdapterHost } from '@nestjs/core';
3 | import {
4 | PrismaClientExceptionFilter,
5 | PrismaModule,
6 | } from 'nestjs-prisma';
7 | import { AppController } from './app.controller';
8 | import { AppService } from './app.service';
9 |
10 | @Module({
11 | imports: [
12 | PrismaModule.forRoot({
13 | prismaServiceOptions: {},
14 | }),
15 | ],
16 | controllers: [AppController],
17 | providers: [
18 | AppService,
19 | // register filter here or in main.ts
20 | // {
21 | // provide: APP_FILTER,
22 | // useFactory: ({ httpAdapter }: HttpAdapterHost) => {
23 | // return new PrismaClientExceptionFilter(httpAdapter);
24 | // },
25 | // inject: [HttpAdapterHost],
26 | // },
27 | // or
28 | // providePrismaClientExceptionFilter()
29 | ],
30 | })
31 | export class AppModule {}
32 |
--------------------------------------------------------------------------------
/examples/graphql/src/user/user.service.ts:
--------------------------------------------------------------------------------
1 | import { Injectable } from '@nestjs/common';
2 | import { CreateUserInput } from './dto/create-user.input';
3 | import { UpdateUserInput } from './dto/update-user.input';
4 | import { PrismaService } from 'nestjs-prisma';
5 |
6 | @Injectable()
7 | export class UserService {
8 | constructor(private readonly prisma: PrismaService) {}
9 |
10 | create(createUserInput: CreateUserInput) {
11 | return this.prisma.user.create({ data: createUserInput });
12 | }
13 |
14 | findAll() {
15 | return this.prisma.user.findMany();
16 | }
17 |
18 | findOne(id: string) {
19 | return this.prisma.user.findUniqueOrThrow({ where: { id } });
20 | }
21 |
22 | update(id: string, updateUserInput: UpdateUserInput) {
23 | return this.prisma.user.update({ where: { id }, data: updateUserInput });
24 | }
25 |
26 | remove(id: string) {
27 | return this.prisma.user.delete({ where: { id } });
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/examples/basics/README.md:
--------------------------------------------------------------------------------
1 | # Basics
2 |
3 | NestJS app with Express, Prisma and nestjs-prisma.
4 |
5 | Adjust `prisma/schema.prisma` and perform a migration:
6 |
7 | ```sh
8 | npx prisma migrate dev
9 | ```
10 |
11 | Seed the example database:
12 |
13 | ```sh
14 | npx prisma db seed
15 | ```
16 |
17 | Start the Nest app and open [localhost:3000](http://localhost:3000).
18 |
19 | ```sh
20 | npm i
21 |
22 | npm run start:dev
23 | ```
24 |
25 | Use `PrismaService` to access the type-safe generated `PrismaClient`.
26 |
27 | ```ts
28 | import { Injectable } from '@nestjs/common';
29 | import { PrismaService } from 'nestjs-prisma';
30 |
31 | @Injectable()
32 | export class AppService {
33 | constructor(private prisma: PrismaService) {}
34 |
35 | users() {
36 | return this.prisma.user.findMany();
37 | }
38 |
39 | user(userId: string) {
40 | return this.prisma.user.findUnique({
41 | where: { id: userId },
42 | });
43 | }
44 | }
45 | ```
46 |
--------------------------------------------------------------------------------
/examples/driver/.gitignore:
--------------------------------------------------------------------------------
1 | # compiled output
2 | /dist
3 | /node_modules
4 | /build
5 |
6 | # Logs
7 | logs
8 | *.log
9 | npm-debug.log*
10 | pnpm-debug.log*
11 | yarn-debug.log*
12 | yarn-error.log*
13 | lerna-debug.log*
14 |
15 | # OS
16 | .DS_Store
17 |
18 | # Tests
19 | /coverage
20 | /.nyc_output
21 |
22 | # IDEs and editors
23 | /.idea
24 | .project
25 | .classpath
26 | .c9/
27 | *.launch
28 | .settings/
29 | *.sublime-workspace
30 |
31 | # IDE - VSCode
32 | .vscode/*
33 | !.vscode/settings.json
34 | !.vscode/tasks.json
35 | !.vscode/launch.json
36 | !.vscode/extensions.json
37 |
38 | # dotenv environment variable files
39 | .env
40 | .env.development.local
41 | .env.test.local
42 | .env.production.local
43 | .env.local
44 |
45 | # temp directory
46 | .temp
47 | .tmp
48 |
49 | # Runtime data
50 | pids
51 | *.pid
52 | *.seed
53 | *.pid.lock
54 |
55 | # Diagnostic reports (https://nodejs.org/api/report.html)
56 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
57 |
58 | # prisma
59 | prisma/dev.db*
--------------------------------------------------------------------------------
/examples/driver/eslint.config.mjs:
--------------------------------------------------------------------------------
1 | // @ts-check
2 | import eslint from '@eslint/js';
3 | import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
4 | import globals from 'globals';
5 | import tseslint from 'typescript-eslint';
6 |
7 | export default tseslint.config(
8 | {
9 | ignores: ['eslint.config.mjs'],
10 | },
11 | eslint.configs.recommended,
12 | ...tseslint.configs.recommendedTypeChecked,
13 | eslintPluginPrettierRecommended,
14 | {
15 | languageOptions: {
16 | globals: {
17 | ...globals.node,
18 | ...globals.jest,
19 | },
20 | sourceType: 'commonjs',
21 | parserOptions: {
22 | projectService: true,
23 | tsconfigRootDir: import.meta.dirname,
24 | },
25 | },
26 | },
27 | {
28 | rules: {
29 | '@typescript-eslint/no-explicit-any': 'off',
30 | '@typescript-eslint/no-floating-promises': 'warn',
31 | '@typescript-eslint/no-unsafe-argument': 'warn'
32 | },
33 | },
34 | );
--------------------------------------------------------------------------------
/examples/extensions/src/app.service.ts:
--------------------------------------------------------------------------------
1 | import { Inject, Injectable } from '@nestjs/common';
2 | import { CustomPrismaService } from 'nestjs-prisma';
3 | import { type ExtendedPrismaClient } from './prisma.extension';
4 |
5 | @Injectable()
6 | export class AppService {
7 | constructor(
8 | // ✅ use `ExtendedPrismaClient` from extension for correct type-safety
9 | @Inject('PrismaService')
10 | private prismaService: CustomPrismaServiceOn this page
13 |-
14 | {
15 | headings
16 | .filter(({ depth }) => depth === 2 || depth === 3)
17 | .map((heading) => (
18 |
- 19 | 23 | {heading.text} 24 | 25 | 26 | )) 27 | } 28 |
-
12 | {
13 | examples.map((example) => (
14 |
-
15 |
16 |
17 |
18 | {example.name}
19 |
20 |
21 |
22 | 23 | 24 | 25 | {example.description} 26 | 27 | 28 |
29 | ))
30 | }
31 |
15 | {
16 | previousPage && (
17 |
47 |
--------------------------------------------------------------------------------
/examples/extensions/src/prisma.extension.ts:
--------------------------------------------------------------------------------
1 | import { Prisma, PrismaClient } from '@prisma/client';
2 | import pagination from 'prisma-extension-pagination';
3 | // used for Read Replicas example
4 | import { readReplicas } from '@prisma/extension-read-replicas';
5 | import { Logger } from '@nestjs/common';
6 | import { queryLoggingExtension } from './query-logging.extension';
7 |
8 | const logger = new Logger('PrismaClient');
9 |
10 | export const extendedPrismaClient = new PrismaClient<
11 | Prisma.PrismaClientOptions,
12 | 'query' | 'info' | 'warn' | 'error'
13 | >({
14 | log: [
15 | { level: 'query', emit: 'event' },
16 | { level: 'info', emit: 'event' },
17 | { level: 'warn', emit: 'event' },
18 | { level: 'error', emit: 'event' },
19 | ],
20 | })
21 | .$extends(queryLoggingExtension(logger))
22 | .$extends({
23 | model: {
24 | user: {
25 | findByEmail: async (email: string) => {
26 | console.log('extension findByEmail');
27 | return extendedPrismaClient.user.findFirstOrThrow({
28 | where: { email },
29 | });
30 | },
31 | },
32 | },
33 | })
34 | .$extends(pagination());
35 | // Read Replicas example, change datasource prodiver (prisma/schema.prisma) to a supported database
36 | // More details in the blog - https://www.prisma.io/blog/read-replicas-prisma-client-extension-f66prwk56wow
37 | // .$extends(
38 | // readReplicas({
39 | // url: 'postgres://localhost:5432/prisma',
40 | // }),
41 | // );
42 |
43 | export type ExtendedPrismaClient = typeof extendedPrismaClient;
44 |
--------------------------------------------------------------------------------
/docs/tailwind.config.cjs:
--------------------------------------------------------------------------------
1 | const plugin = require('tailwindcss/plugin');
2 | const defaultTheme = require('tailwindcss/defaultTheme');
3 |
4 | /** @type {import('tailwindcss').Config} */
5 | module.exports = {
6 | content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
7 | darkMode: 'class',
8 | theme: {
9 | extend: {
10 | fontFamily: {
11 | sans: ['inter', ...defaultTheme.fontFamily.sans],
12 | },
13 | typography: ({ theme }) => ({
14 | DEFAULT: {
15 | css: {
16 | code: {
17 | color: '#FFA657',
18 | backgroundColor: '#0d1117',
19 | padding: '0.125rem 0.25rem',
20 | borderRadius: theme('borderRadius.md'),
21 | },
22 | 'code::before': {
23 | content: '',
24 | },
25 | 'code::after': {
26 | content: '',
27 | },
28 | 'blockquote p:first-of-type::before': {
29 | content: '',
30 | },
31 | 'blockquote p:last-of-type::after': {
32 | content: '',
33 | },
34 | 'blockquote code': {
35 | color: '#FFA657',
36 | },
37 | },
38 | },
39 | }),
40 | },
41 | },
42 | plugins: [
43 | require('@tailwindcss/typography'),
44 | plugin(({ addVariant }) => {
45 | addVariant('scrollbar', '&::-webkit-scrollbar');
46 | addVariant('scrollbar-track', '&::-webkit-scrollbar-track');
47 | addVariant('scrollbar-thumb', '&::-webkit-scrollbar-thumb');
48 | }),
49 | ],
50 | };
51 |
--------------------------------------------------------------------------------
/lib/interfaces/prisma-module-options.interface.ts:
--------------------------------------------------------------------------------
1 | import { ModuleMetadata, Type } from '@nestjs/common';
2 | import { Prisma } from '@prisma/client';
3 |
4 | export interface PrismaModuleOptions {
5 | /**
6 | * If "true", registers `PrismaModule` as a global module.
7 | * See: https://docs.nestjs.com/modules#global-modules
8 | */
9 | isGlobal?: boolean;
10 |
11 | prismaServiceOptions?: PrismaServiceOptions;
12 | }
13 |
14 | export interface PrismaServiceOptions {
15 | /**
16 | * Pass options directly to the `PrismaClient`.
17 | * See: https://www.prisma.io/docs/reference/api-reference/prisma-client-reference/#prismaclient
18 | */
19 | prismaOptions?: Prisma.PrismaClientOptions;
20 |
21 | /**
22 | * If "true", `PrismaClient` explicitly creates a connection pool and your first query will respond instantly.
23 | *
24 | * For most use cases the lazy connect behavior of `PrismaClient` will do. The first query of `PrismaClient` creates the connection pool.
25 | * See: https://www.prisma.io/docs/concepts/components/prisma-client/working-with-prismaclient/connection-management
26 | */
27 | explicitConnect?: boolean;
28 | }
29 |
30 | export interface PrismaOptionsFactory {
31 | createPrismaOptions(): Promise
18 |
28 | )
29 | }
30 |
31 | {
32 | nextPage && (
33 | Previous
19 |
20 |
24 | {previousPage.title}
25 |
26 |
27 |
34 |
44 | )
45 | }
46 | Next
35 |
36 |
40 | {nextPage.title}
41 |
42 |
43 |
25 |
60 |
26 |
29 |
30 |
31 |
32 |
33 | {
34 | currentSection && (
35 |
36 | {currentSection.title}
37 |
38 | )
39 | }
40 |
42 |
43 |
45 |
59 |
49 |
53 | Edit this page on GitHub
54 |
55 |
56 | )
57 | }
58 |
17 |
54 |
55 |
59 |
69 | Sponsor us
70 |
71 |
72 |
--------------------------------------------------------------------------------
/docs/src/layouts/Doc.astro:
--------------------------------------------------------------------------------
1 | ---
2 | import Layout from './Base.astro';
3 | import Navigation from '../components/Navigation.astro';
4 | import TableOfContents from '../components/TableOfContents.astro';
5 | import PrevNextNavigation from '../components/PrevNextNavigation.astro';
6 |
7 | import type { MarkdownHeading } from 'astro';
8 | import { GITHUB_EDIT_URL, navigation } from '../config';
9 |
10 | type Props = {
11 | title: string;
12 | headings: MarkdownHeading[];
13 | };
14 |
15 | const { title, headings } = Astro.props as Props;
16 |
17 | const currentPage = Astro.url.pathname;
18 | const currentPageMatch = currentPage.endsWith('/')
19 | ? currentPage.slice(0, -1)
20 | : currentPage.slice(0);
21 | const currentSection = navigation.find((section) =>
22 | section.links.find((link) => link.link == currentPageMatch),
23 | );
24 |
25 | const currentFile = `src/content${currentPage.replace(/\/$/, '')}.md`;
26 | const githubEditUrl = `${GITHUB_EDIT_URL}/${currentFile}`;
27 | ---
28 |
29 |
31 |
73 |
32 |
35 |
36 |
37 |
38 |
39 | {
40 | currentSection && (
41 |
42 | {currentSection.title}
43 |
44 | )
45 | }
46 |
48 |
49 |
54 |
55 |
67 | {title}
47 |
59 |
63 | Edit this page on GitHub
64 |
65 |
66 |
68 |
71 |
72 |
2 | 
3 |
A progressive Node.js framework for building efficient and scalable server-side applications.
9 |
10 | 
11 | 
12 | 
13 | 
15 | 
16 | 
17 | 
18 | 
19 | 
20 | 
21 |
32 |
109 |
70 |
105 |
106 | )
107 | }
108 |
74 |
104 |
75 |
80 | nestjs-prisma
81 |
82 |
83 |
99 |
100 |
101 |
103 | nestjs-prisma
2 | 3 |4 | Easy Prisma support for your NestJS application. 5 |
6 | 7 |
8 |
9 | 
10 |
11 |
12 | 
13 |
14 |
15 | 
16 |
17 |
18 | 
19 |
20 |
154 |
162 |
164 | );
165 | }
166 |
--------------------------------------------------------------------------------
/docs/src/content/docs/query-logging-extension.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Query Logging Extension
3 | ---
4 |
5 | Create a PrismaClient extension to log all queries performed by the PrismaClient.
6 |
7 | ## Add query logging extension
8 |
9 | Prisma provides an example for [Prisma Client Extension - Query Logging](https://github.com/prisma/prisma-client-extensions/tree/main/query-logging). You need to create a new `PrismaClient` instance with `$extends` where you will define the query logging extension.
10 |
11 | ```ts
12 | // prisma.extension.ts
13 | import { Logger } from '@nestjs/common';
14 | import { PrismaClient } from '@prisma/client';
15 |
16 | const logger = new Logger('PrismaClient');
17 |
18 | export const extendedPrismaClient = new PrismaClient().$extends({
19 | query: {
20 | $allModels: {
21 | async $allOperations({ operation, model, args, query }) {
22 | const start = performance.now();
23 | const result = await query(args);
24 | const end = performance.now();
25 | const time = Math.ceil((end - start) * 100) / 100;
26 | // adjust logging behavior to your needs
27 | logger.log(`Prisma Query ${model}.${operation} took ${time}ms`);
28 | return result;
29 | },
30 | },
31 | },
32 | });
33 |
34 | export const ExtendedPrismaClient = typeof extendedPrismaClient;
35 | ```
36 |
37 | Now you need to register and inject the `CustomPrismaService` with your `extendedPrismaClient`. Read more about [Prisma Client Extensions](/docs/prisma-client-extensions).
38 |
39 | ```ts
40 | import { Module } from '@nestjs/common';
41 | import { AppController } from './app.controller';
42 | import { AppService } from './app.service';
43 |
44 | import { CustomPrismaModule } from 'nestjs-prisma';
45 | import { extendedPrismaClient } from './prisma.extension';
46 |
47 | @Module({
48 | imports: [
49 | // ✅ use `forRootAsync` when using `PrismaClient().$extends({})`
50 | CustomPrismaModule.forRootAsync({
51 | name: 'PrismaService',
52 | useFactory: () => {
53 | return extendedPrismaClient;
54 | },
55 | }),
56 | ],
57 | controllers: [AppController],
58 | providers: [AppService],
59 | })
60 | export class AppModule {}
61 | ```
62 |
63 | Inject the `CustomPrismaService` with the `ExtendedPrismaClient` type, useful when adding [custom methods](http://localhost:4321/docs/prisma-client-extensions#create-prisma-extension) to your models.
64 |
65 | ```ts
66 | import { Inject, Injectable } from '@nestjs/common';
67 | import { CustomPrismaService } from 'nestjs-prisma';
68 | import { type ExtendedPrismaClient } from './prisma.extension';
69 |
70 | @Injectable()
71 | export class AppService {
72 | constructor(
73 | // ✅ use `ExtendedPrismaClient` type for correct type-safety of your extended PrismaClient
74 | @Inject('PrismaService')
75 | private prismaService: CustomPrismaService
2 |
3 |
A progressive Node.js framework for building efficient and scalable server-side applications.
9 |
10 |
11 |
12 |
13 |
15 |
16 |
17 |
18 |
19 |
20 |