Как интегрировать TypeORM с NestJS?

Интеграция TypeORM с NestJS

NestJS предоставляет официальный пакет @nestjs/typeorm, который оборачивает TypeORM и встраивает его в систему модулей и внедрения зависимостей фреймворка.

Установка

npm install @nestjs/typeorm typeorm pg

Подключение в корневом модуле

В AppModule вызывается TypeOrmModule.forRoot() — это настраивает единственное соединение с базой данных и делает его доступным через DI-контейнер во всём приложении.

// app.module.ts
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'postgres',
      host: process.env.DB_HOST,
      port: Number(process.env.DB_PORT),
      username: process.env.DB_USER,
      password: process.env.DB_PASS,
      database: process.env.DB_NAME,
      autoLoadEntities: true, // автоматически подхватывает сущности, зарегистрированные через forFeature
      synchronize: false,     // никогда не включать в production
    }),
  ],
})
export class AppModule {}

Объявление сущности

// user.entity.ts
import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn } from 'typeorm';

@Entity('users')
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ unique: true })
  email: string;

  @Column()
  name: string;

  @CreateDateColumn()
  createdAt: Date;
}

Регистрация сущности в feature-модуле

// users.module.ts
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './user.entity';

@Module({
  imports: [TypeOrmModule.forFeature([User])],
  providers: [UsersService],
  controllers: [UsersController],
})
export class UsersModule {}

Внедрение репозитория в сервис

// users.service.ts
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { User } from './user.entity';

@Injectable()
export class UsersService {
  constructor(
    @InjectRepository(User)
    private readonly userRepository: Repository<User>,
  ) {}

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

  findOne(id: number): Promise<User | null> {
    return this.userRepository.findOneBy({ id });
  }

  async create(dto: CreateUserDto): Promise<User> {
    const user = this.userRepository.create(dto);
    return this.userRepository.save(user);
  }
}

Асинхронная конфигурация через ConfigService

Для продакшн-приложений конфигурацию принято загружать асинхронно:

TypeOrmModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: (config: ConfigService) => ({
    type: 'postgres',
    host: config.get('DB_HOST'),
    port: config.get<number>('DB_PORT'),
    username: config.get('DB_USER'),
    password: config.get('DB_PASS'),
    database: config.get('DB_NAME'),
    autoLoadEntities: true,
    synchronize: false,
  }),
  inject: [ConfigService],
}),

Миграции

Вместо synchronize: true в production используют миграции TypeORM. Для этого создаётся отдельный data-source.ts с настройками, и CLI TypeORM запускается как typeorm migration:run.