Toidicode.com

Toidicode.com

BASIC TO ADVANCE

Bài 15: Kết nối database với Prisma trong NestJS

Tiếp tục với series, tới bài trước dữ liệu của TaskFlow API vẫn nằm trong bộ nhớ, khởi động lại là mất. Bài này mình sẽ giới thiệu với mọi người về kết nối database với Prisma trong NestJS, với PostgreSQL chạy bằng Docker.

1. Prisma là gì?

Prisma là một ORM cho Node.js và TypeScript: các bạn khai báo bảng trong file schema.prisma, Prisma Migrate sinh và chạy SQL tạo bảng, còn Prisma Client là code truy vấn được generate từ schema với đầy đủ kiểu cho từng model.

Prisma không có package riêng cho NestJS, chúng ta tự bọc Prisma Client trong một provider. Bài này dùng Prisma 7, kết nối database qua driver adapter (PostgreSQL là @prisma/adapter-pg, dùng driver pg):

npm install prisma@7 dotenv --save-dev
npm install @prisma/client@7 @prisma/adapter-pg@7

Chú ý: Phải ghi rõ @7. Lúc viết bài, tag latest của prisma trên npm đang trỏ tới bản thử nghiệm Prisma 8, không có lệnh migrate, generate.

2. Chạy PostgreSQL bằng Docker.

Mình chạy PostgreSQL trong container (xem series Docker basic nếu các bạn chưa quen):

docker run -d --name taskflow-postgres \
    -e POSTGRES_USER=taskflow -e POSTGRES_PASSWORD=taskflow -e POSTGRES_DB=taskflow \
    -p 127.0.0.1:5432:5432 -v taskflow-pgdata:/var/lib/postgresql \
    postgres:18-alpine

Các biến POSTGRES_* tạo user, mật khẩu và database lúc chạy lần đầu, -p mở cổng để ứng dụng kết nối qua localhost:5432; ghi 127.0.0.1 để cổng chỉ mở trên máy mình, vì Docker bỏ qua firewall (như ufw) nên mở ra mọi interface thì máy khác cùng mạng cũng đăng nhập được. Volume taskflow-pgdata giữ dữ liệu khi xoá container. Những lần sau chỉ cần docker start taskflow-postgres.

Lưu ý: User/mật khẩu taskflow chỉ dùng ở local, lên production phải dùng mật khẩu mạnh và giữ bí mật.

3. Khởi tạo Prisma.

Ở thư mục gốc project:

npx prisma init --output ../src/generated/prisma --no-skills \
    --url "postgresql://taskflow:taskflow@localhost:5432/taskflow?schema=public"

Trong đó:

  • --output: thư mục chứa Prisma Client, tính từ file schema; đặt trong src để được build cùng ứng dụng.
  • --url: chuỗi kết nối, ghi vào DATABASE_URL trong .env (lệnh kết nối thử nên container phải đang chạy).
  • --no-skills: bỏ qua việc cài "agent skills" cho công cụ AI.

Lệnh tạo prisma/schema.prisma, thêm /src/generated/prisma vào .gitignore (code sinh ra không commit) và tạo file cấu hình của Prisma CLI prisma7.config.ts (trước Prisma 7.10 là prisma.config.ts), file này đọc DATABASE_URL từ .env nhờ import "dotenv/config". Các bạn thêm dòng DATABASE_URL vào cả .env.example.

4. Khai báo bảng trong schema.prisma.

TaskFlow API cần ba bảng users, projects, tasks. Các bạn sửa file schema thành:

- prisma/schema.prisma

generator client {
  provider = "prisma-client"
  output   = "../src/generated/prisma"
}

datasource db {
  provider = "postgresql"
}

enum TaskStatus {
  todo
  doing
  done
}

model User {
  id        Int       @id @default(autoincrement())
  name      String
  email     String    @unique
  createdAt DateTime  @default(now())
  projects  Project[]
  tasks     Task[]

  @@map("users")
}

model Project {
  id          Int      @id @default(autoincrement())
  name        String   @db.VarChar(100)
  description String   @default("")
  ownerId     Int
  owner       User     @relation(fields: [ownerId], references: [id])
  tasks       Task[]
  createdAt   DateTime @default(now())
  updatedAt   DateTime @updatedAt

  @@map("projects")
}

model Task {
  id          Int        @id @default(autoincrement())
  title       String
  description String?
  status      TaskStatus @default(todo)
  dueDate     DateTime?
  completedAt DateTime?
  projectId   Int
  project     Project    @relation(fields: [projectId], references: [id], onDelete: Cascade)
  assigneeId  Int?
  assignee    User?      @relation(fields: [assigneeId], references: [id])
  createdAt   DateTime   @default(now())
  updatedAt   DateTime   @updatedAt

  @@map("tasks")
}

Trong đó:

  • generator: project dùng ESM nên client sinh ra cũng là ESM, không cần cấu hình thêm.
  • Mỗi model là một bảng, @@map() đặt tên bảng thật.
  • @id @default(autoincrement()): khoá chính tự tăng; @unique: không trùng; @updatedAt: tự cập nhật khi sửa; String?: cho phép null.
  • owner, tasks... là relation field, không phải cột: chúng tạo khoá ngoại cho ownerId, projectId, assigneeId; onDelete: Cascade xoá project thì xoá luôn task. Chi tiết về quan hệ ở Bài 17.

5. Tạo bảng với prisma migrate dev.

migrate dev so sánh schema với database, sinh file migration rồi chạy nó:

npx prisma migrate dev --name init
# Datasource "db": PostgreSQL database "taskflow", schema "public" at "localhost:5432"
#
# Applying migration `20261115072858_init`
# ...
# prisma/migrations/
#   └─ 20261115072858_init/
#     └─ migration.sql
#
# Your database is now in sync with your schema.

migration.sql chứa SQL thật (CREATE TABLE "users", khoá ngoại...). Thư mục prisma/migrations được commit để máy khác tạo đúng các bảng này. Prisma 7 không tự generate client sau khi migrate, các bạn chạy thêm:

npx prisma generate
# ✔ Generated Prisma Client (7.10.1) to ./src/generated/prisma in 125ms

Database giờ có các bảng users, projects, tasks và _prisma_migrations (ghi lại các migration đã chạy). Mỗi lần sửa schema các bạn chạy migrate dev --name <tên> rồi generate; clone project về thì chạy npx prisma generate trước khi build.

6. PrismaService và PrismaModule.

Trước hết thêm cấu hình database theo cách ở Bài 14: thêm DATABASE_URL: z.url({ protocol: /^postgres(ql)?$/ }), vào envSchema trong src/config/env.validation.ts và tạo namespace database:

- src/config/database.config.ts

import { registerAs } from '@nestjs/config';

export default registerAs('database', () => ({
    url: process.env.DATABASE_URL ?? '',
}));

Tạo module, service bằng nest g module prisma --format và nest g service prisma --no-spec --format. PrismaService kế thừa PrismaClient để có toàn bộ API truy vấn:

- src/prisma/prisma.service.ts

import {
    Inject,
    Injectable,
    OnModuleDestroy,
    OnModuleInit,
} from '@nestjs/common';
import type { ConfigType } from '@nestjs/config';
import { PrismaPg } from '@prisma/adapter-pg';
import databaseConfig from '../config/database.config.js';
import { PrismaClient } from '../generated/prisma/client.js';

@Injectable()
export class PrismaService
    extends PrismaClient
    implements OnModuleInit, OnModuleDestroy
{
    constructor(
        @Inject(databaseConfig.KEY)
        database: ConfigType<typeof databaseConfig>,
    ) {
        // Prisma 7 cần driver adapter: PrismaPg dùng driver pg
        const adapter = new PrismaPg({ connectionString: database.url });
        super({ adapter });
    }

    // Chạy khi module được khởi tạo, trước khi ứng dụng nhận request
    async onModuleInit(): Promise<void> {
        await this.$connect();
        // PrismaPg chỉ kết nối khi có query: chạy thử để lỗi ngay lúc khởi động
        await this.$queryRaw`SELECT 1`;
    }

    // Chạy khi ứng dụng tắt: đóng kết nối và pool của driver
    async onModuleDestroy(): Promise<void> {
        await this.$disconnect();
    }
}

Các feature module đều cần database nên PrismaModule là global module (Bài 4), chỉ import một lần ở AppModule:

- src/prisma/prisma.module.ts

import { Global, Module } from '@nestjs/common';
import { PrismaService } from './prisma.service.js';

@Global()
@Module({
    providers: [PrismaService],
    exports: [PrismaService],
})
export class PrismaModule {}

- src/app.module.ts (đoạn trích)

import databaseConfig from './config/database.config.js';
import { PrismaModule } from './prisma/prisma.module.js';

// ...
            load: [appConfig, authConfig, databaseConfig],
        }),
        PrismaModule,
        ProjectsModule,

7. Lifecycle hook.

Lifecycle hook là các method NestJS tự gọi theo vòng đời ứng dụng: lúc khởi động có onModuleInit(), onApplicationBootstrap(); lúc tắt có onModuleDestroy(), beforeApplicationShutdown(), onApplicationShutdown(). Class cài đặt interface tương ứng như PrismaService ở trên. Hook lúc tắt chỉ chạy khi gọi app.close(), muốn chạy cả khi nhấn Ctrl+C hay nhận SIGTERM thì các bạn thêm app.enableShutdownHooks(); vào src/main.ts, ngay sau dòng NestFactory.create().

Lưu ý: Với driver adapter, $connect() chưa mở kết nối nào: bỏ dòng SELECT 1 rồi tắt database thì ứng dụng vẫn khởi động "thành công". Có dòng đó thì:

docker stop taskflow-postgres
npm run start:dev
# PrismaClientKnownRequestError:
# Invalid `prisma.$queryRaw()` invocation:
#
# Raw query failed. Code: `N/A`. Message: `Can't reach database server at 127.0.0.1:5432`

Bật lại database bằng docker start taskflow-postgres là chạy bình thường. Test e2e cũng nạp AppModule nên npm run test:e2e giờ cần database đang chạy.

8. Lời kết.

Như vậy mình đã giới thiệu với mọi người về kết nối database với Prisma trong NestJS: cài Prisma 7, PostgreSQL bằng Docker, schema.prisma, migrate dev, PrismaService và lifecycle hook. Các route vẫn dùng dữ liệu trong bộ nhớ, bài sau mình sẽ giới thiệu về CRUD với Prisma trong NestJS để chuyển chúng sang database thật.

Đăng ký nhận tin.

Chúng tôi chỉ gửi tối đa 2 lần trên 1 tháng. Tuyên bố không spam mail!

Vũ Thanh Tài

About author
The best way to learn is to share
Xem tất cả bài đăng

0 Comments

Bài viết chưa có ai bình luận, hãy là người đầu tiên đi bạn!

Bình luận

Captcha