Nodejs Nestjs ORM框架@nestjs/sequelize的使用

Nodejs Nestjs ORM框架@nestjs/sequelize的使用
[@nestjs](/user/nestjs)/sequelize 是 NestJS 的一个扩展库，用于与 Sequelize ORM 进行集成。Sequelize 是一个基于 promise 的 Node.js ORM，适用于 PostgreSQL, MySQL, MariaDB, SQLite 和 Microsoft SQL Server。

下面是如何在 NestJS 项目中使用 [@nestjs](/user/nestjs)/sequelize 的基本步骤：

安装依赖

首先，你需要安装 [@nestjs](/user/nestjs)/sequelize 和 sequelize 及其对应的数据库驱动（例如：pg 对于 PostgreSQL）。

npm install [@nestjs](/user/nestjs)/sequelize sequelize pg

如果你使用的是 MySQL 或其他数据库，请相应地调整安装命令。

配置 SequelizeModule

接下来，在你的应用模块中配置 SequelizeModule。例如，如果你正在创建一个名为 AppModule 的模块，你可以这样做：

import { Module } from '[@nestjs](/user/nestjs)/common';
import { SequelizeModule } from '[@nestjs](/user/nestjs)/sequelize';

@Module({
  imports: [
    SequelizeModule.forRoot({
      dialect: 'postgres', // 数据库类型
      host: 'localhost',
      port: 5432,
      username: 'your-username',
      password: 'your-password',
      database: 'your-database-name',
      autoLoadModels: true, // 自动加载模型
      synchronize: true, // 在生产环境中不要设置为true
    }),
  ],
})
export class AppModule {}

创建模型

在 src 目录下创建一个名为 models 的文件夹，并在其中创建你的第一个模型，例如 user.model.ts：

import { Table, Column, Model, DataType } from 'sequelize-typescript';

@Table({ tableName: 'users' })
export class User extends Model<User> {
  @Column({
    type: DataType.INTEGER,
    unique: true,
    primaryKey: true,
    autoIncrement: true,
  })
  id: number;

  @Column
  name: string;

  @Column
  email: string;
}

使用模型

现在你可以在服务中注入模型并使用它。例如，创建一个名为 users.service.ts 的服务文件：

import { Injectable } from '[@nestjs](/user/nestjs)/common';
import { InjectModel } from '[@nestjs](/user/nestjs)/sequelize';
import { User } from './models/user.model';

@Injectable()
export class UsersService {
  constructor(@InjectModel(User) private readonly userModel: typeof User) {}

  async findAll(): Promise<User[]> {
    return this.userModel.findAll();
  }

  async create(user: Partial<User>): Promise<User> {
    return this.userModel.create(user);
  }
}

控制器

最后，在控制器中调用服务方法：

import { Controller, Get, Post, Body } from '[@nestjs](/user/nestjs)/common';
import { UsersService } from './users.service';
import { User } from './models/user.model';

@Controller('users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Get()
  findAll(): Promise<User[]> {
    return this.usersService.findAll();
  }

  @Post()
  create(@Body() user: Partial<User>): Promise<User> {
    return this.usersService.create(user);
  }
}

以上就是如何在 NestJS 中使用 [@nestjs](/user/nestjs)/sequelize 的基本流程。你可以根据自己的需求进行相应的调整和扩展。