ORM 이란?

ORM(Object Relational Mapping) 은 객체(Object, 즉 JS 클래스)와 데이터베이스(Relational DB, 즉 테이블)를 자동으로 매핑시켜주는 기술이다!

<aside>

SQL 문을 직접 작성하지 않고 클래스와 메서드로 DB를 다루게 해주는 기술!

</aside>

SQL로 직접 쓴다면

INSERT INTO user (username, email) VALUES ('lim', 'lim@example.com');

ORM으로 쓴다면 (TypeORM)

const user = new User();
user.username = "lim";
user.email = "lim@example.com";
await userRepository.save(user);

이렇게 자바스크립트 객체를 그대로 DB row에 매핑시켜주는 게 ORM이다

TypeORM이란?

TypeScript 기반의 Node.js ORM 라이브러리

TypeORM - Code with Confidence. Query with Power. | TypeORM

TypeORM을 쓰면 뭐가 좋은가?

TypeORM 기본 구조

NestJS에서 TypeORM 연결하기

설치

npm i @nestjs/typeorm typeorm mysql2

설정 (app.module.ts)

import { Module } from "@nestjs/common";
import { TypeOrmModule } from "@nestjs/typeorm";
import { User } from "./user/user.entity";

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: "mysql",
      host: "localhost",
      port: 3306,
      username: "root",
      password: "비밀번호",
      database: "bangbang",
      entities: [User], // 매핑할 엔티티 목록
      synchronize: true, // 개발 중에는 자동으로 테이블 생성
    }),
  ],
})
export class AppModule {}

<aside>

synchronize: true는 코드로 DB 테이블 구조를 자동으로 맞춰주는 기능인데,

운영 환경에서는 데이터가 날아갈 위험이 있어서 꺼두는 게 좋다!

</aside>

엔티티(Entity) 예시

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";

@Entity() // user 테이블
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  username: string;

  @Column()
  email: string;
}

위 코드가 실제로는 다음과 같은 SQL로 변환된다!

CREATE TABLE user (
  id INT PRIMARY KEY AUTO_INCREMENT,
  username VARCHAR(255),
  email VARCHAR(255)
);

Repository 사용하기

TypeORM은 각 엔티티별로 Repository 객체 를 제공한다.

Repository는 테이블에 대한 CRUD 기능을 모두 가지고 있다!

import { Injectable } from "@nestjs/common";
import { InjectRepository } from "@nestjs/typeorm";
import { Repository } from "typeorm";
import { User } from "./user.entity";

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

  findAll() {
    return this.userRepo.find(); // SELECT * FROM user
  }

  findOne(id: number) {
    return this.userRepo.findOneBy({ id });
  }

  create(username: string, email: string) {
    const user = this.userRepo.create({ username, email });
    return this.userRepo.save(user); // INSERT INTO user ...
  }

  delete(id: number) {
    return this.userRepo.delete(id); // DELETE FROM user WHERE id=...
  }
}

정리