TypeORM Migration Guide 🚥

ORM을 활용하여 데이터베이스 테이블을 자동으로 생성하면 물론 편하지만,
기존 데이터베이스에서 테이블을 생성 하고 엔티티를 역으로 마이그레이션 해야 하는 상황이 있다.
즉, 테이블 생성 ➡️ TypeORM Generator ➡️ 엔티티 수정

1. 테이블 생성 📜

a. Reverse Engineer

• MySQL Workbench 8.0
• Database - Reverse Engineer
• 다른 테이블을 참고하여 데이터베이스를 만들고 연관 관계를 추가한다.

b. Forward Engineer

• 작업을 다 마쳤다면 Database -Forward Engineer
• 테이블 생성 SQL 문을 확인할 수 있다.

-- -----------------------------------------------------
-- Table `test`.`test_reverse_copy`
-- -----------------------------------------------------
CREATE TABLE IF NOT EXISTS `test`.`test_reverse_copy` (
  `test_reverse_copy_id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
  `type` VARCHAR(20) CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci' NOT NULL,
  `created_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `updated_at` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  `deleted_at` DATETIME NULL DEFAULT NULL,
  PRIMARY KEY (`test_reverse_copy_id`))
ENGINE = InnoDB
AUTO_INCREMENT = 166
DEFAULT CHARACTER SET = utf8mb4
COLLATE = utf8mb4_unicode_ci;

• Forward Engineer를 다 마쳤다면 다음과 같이 성공적으로 테이블이 생긴 것을 볼 수 있다.

2. TypeORM Migration 🧊

a. typeorm-model-generator

• 연결된 데이터베이스의 상태를 토대로 엔티티를 만들어준다.
• 엔티티는 /output/entities 폴더에 만들어진다.

npx typeorm-model-generator -h [호스트 주소] -p 3306 -d [데이터베이스 이름] -u [유저 이름] -x [접속패스워드] -e mysql

• 응답 결과

Need to install the following packages:
typeorm-model-generator@0.4.6
Ok to proceed? (y) y
npm WARN deprecated adal-node@0.2.4: This package is no longer supported. Please migrate to @azure/msal-node.
npm WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
npm WARN deprecated @npmcli/move-file@1.1.2: This functionality has been moved to @npmcli/fs
typeorm-model-generator@0.4.6
[3:28:27 PM] Starting creation of model classes.
[3:28:27 PM] Typeorm model classes created.
npm notice
npm notice New minor version of npm available! 10.2.3 -> 10.5.0
npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.5.0
npm notice Run npm install -g npm@10.5.0 to update!
npm notice

b. 엔티티 확인

• /output/entities/TestReverseCopy.ts
• 실제 TypeORM에서 사용하고 있는 엔티티 폴더로 옮겨 사용하도록 하자.

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

@Entity("test_reverse_copy", { schema: "rever_school" })
export class TestReverseCopy {
  @PrimaryGeneratedColumn({
    type: "bigint",
    name: "test_reverse_copy_id",
    unsigned: true,
  })
  testReverseCopyId: string;

  @Column("varchar", {
    name: "type",
    length: 20,
  })
  type: string;

  @Column("datetime", {
    name: "created_at",
    default: () => "CURRENT_TIMESTAMP",
  })
  createdAt: Date;

  @Column("datetime", {
    name: "updated_at",
    default: () => "CURRENT_TIMESTAMP",
  })
  updatedAt: Date;

  @Column("datetime", { name: "deleted_at", nullable: true })
  deletedAt: Date | null;
}

c. 엔티티에 필요 제약조건 설정

• @IsNumber()
• @ApiProperty()
• @IsString()

다음과 같이, 필요한 제약 조건을 설정하고, 정상적으로 마이그레이션 되었다면 TypeORM과 연동 된다.