[Nest.js] TypeORM Table 관계가 맺어졌을 때, Seeding (feat. Migration)

[Nest.js] TypeORM Table 관계가 맺어졌을 때, Seeding (feat. Migration)

2023. 11. 30. 20:01ㆍBack-End 작업실/문제 정리

728x90

NestJS로 배우는 백엔드 프로그래밍:타입스크립트 환경의 차세대 서버 프레임워크를 만나다

COUPANG

www.coupang.com

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

GitHub - junyharang-coding-study/GraphQL-Study: GraphQL을 공부하고, 실습한 코드에요 😀

GraphQL을 공부하고, 실습한 코드에요 😀. Contribute to junyharang-coding-study/GraphQL-Study development by creating an account on GitHub.

github.com

👷‍♂️ 작업 중인 내용

이 글은 Nest.JS를 이용해 GraphQL 실습 환경 구성 중 Mock Data를 구성하기 위해 TypeORM Extension의 Seeding을 하면서 발생한 문제에 대해 정리하는 글이에요.

Seeding을 해서 아래 명령어를 입력하면 Enbedded SQLite에 위와 같이 Mock Data가 Table에 맞춰 입력된걸 확인할 수 있어요.

⚠️ 문제 발생!

하지만 문제는 위와 같이 관계가 맺어져 있는 Table에서 해당 Table의 FK 값이 들어가지 않는다는 문제가 발생했어요.

🤔 원인 분석

이는 위와 같이 Supply는 Team과 관계를 맺고 있고, FK로 team_id를 가지고 있어요.

Supply Entity에 10 ~ 11번째 줄을 보면 Team과 연관 관계를 맺었고, 하나의 Supply는 여러 Team과 관계를 맺기 때문에 Many To One으로 관계를 맺어 주었으며, 이 때, N + 1 문제를 방어하고자 Entity Type을 Promise로 설정해 주었어요.

이것은 해당 관계를 Lazy Relations로 설정하겠다는 의미에요.

Lay Relations(지연 관계)를 맺게 되면 해당 Entity에 접근 할 때만 데이터를 가져오게 되게 돼요.

위의 SupplyEntity의 11번째 줄 team 객체형 변수는 Pramise<TeamEntity>로 받아야 하는데,

Seeder를 보면 Team Table에 값이 들어가고 나서 해당 Table의 teamId로 한 객체를 가져와
각각의 상수형 변수에 넣어주는 걸 볼 수 있어요.

그리고 나서 Supply Table에 insert를 할 때, 위와 같이 team Field에 해당 객체를 넣어주려고 하니
문제가 발생하는 걸 알 수 있어요.

🍻 문제 해결!

최초 이를 사용하기 위해 아래 의존성을 설치해 주어야 해요.

위 명령어를 통해 TypeScript 파일 실행 시 도움을 받을 수 있는 패키지를 설치할 수 있는데,
-D Options(옵션)은 이 패키지들이 devDependencies에 설치 되도록 하는 옵션이에요.
이것은 개발 환경에서만필요하고, 운영환경에서는 쓰지 않겠다는 의미에요.

이렇게 명령어를 입력하면 TypeScript 코드를 직접 Node.js 환경에서 실행할 수 있는 도구 ts-node가 설치되고, 이것은 Node.js는 JavaScript 코드만 실행할 수 있는데,
이를 통해 TypeScript 파일을 직접 실행할 수 있도록 도와주는 패키지에요.

그리고, TypeScript 프로젝트에서 설정된 tsconfig.json 파일의 paths 설정을 활용하여 Module 경로를 해석할 수
있도록 도와주는 패키지가 바로 tsconfig-paths에요. 이것을 통해 TypeScript로 작성된 코드에서 Import 구문을
사용할 때, 경로를 설정하면 해당 경로를 해석할 수 있게 도와준답니다.

type-script-nest-graph-ql-실습/data-source.ts

위와 같이 Project(프로젝트) Root(루트) Directory(디렉터리)에 위 내용을 입력해 주어야 해요.
이에 대한 자세한 내용은 이 곳에 작성해 주었어요.

그리고 위와 같이 package.json script{}에 TypeORM migraion 관련 Script를 넣어주었어요.

이는 공식 문서와 좀 다르게 설정해 주었는데,
이유는 TypeORM CLI가 절대 경로를 이해하지 못해 공식 문서대로 하게 되면
can not found module Error를 내뱉기 때문이에요.

그래서 임의로 절대 경로를 이해시키기 위해 위에서 ts-node와 tsconfig-paths 패키지를 설치한 거고,
Script 문에 ts-node -r tsconfig-paths/register를 넣어준 거에요.

npm 명령어(옵션)	상 세 내 용
npm run migration:run	각각의 Migration File의 up()에서 작성한 내용을 데이터베이스에 Query 전달 및 반영.
npm run migration:revert	데이터 베이스에 적용된 각각의 Migration File의 down()에서 작성한 내용을 데이터베이스에 Query 전달 및 반영. 단, 가장 최근의 Migration File의 up()을 통해 전달한 내용만 단, 한번 되돌림.
npm run migration:create	새로운 Migration File 생성.
npm run migration:grnerate	Migration 자동 생성.
npm run schema:drop	데이터베이스의 모든 스키마 삭제를 위한 Query 전달 및 반영.
npm run schema: sync	데이터베이스 스키마를 Update(최신화)하여 현재 소스 코드의 Entity와 일치하도록 작업.

여기까지 한 뒤 Entity를 만들어 줍니다. Entity 역시 이 곳을 참고해 주세요.

위 명령어를 입력하면

src/database/migrations/1701333148773-Migration.ts

import { MigrationInterface, QueryRunner } from "typeorm";

export class Migration1701333148773 implements MigrationInterface {
    name = 'Migration1701333148773'

    public async up(queryRunner: QueryRunner): Promise<void> {
        await queryRunner.query(`CREATE TABLE "software" ("software_id" varchar(255) PRIMARY KEY NOT NULL, "used_by" varchar(255) NOT NULL, "developed_by" varchar NOT NULL, "description" varchar NOT NULL, CONSTRAINT "UQ_4ef15228013fdc93b76c9339283" UNIQUE ("software_id"))`);
        await queryRunner.query(`CREATE TABLE "team" ("team_id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "manager" varchar(255) NOT NULL, "office" varchar(5) NOT NULL, "extension_number" varchar(5) NOT NULL, "mascot" varchar(10), "cleaning_duty" varchar(10) NOT NULL, "project" varchar(10) NOT NULL, CONSTRAINT "UQ_a35a345d4436b82adf6bb76f3ce" UNIQUE ("team_id"))`);
        await queryRunner.query(`CREATE TABLE "people" ("people_id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "last_name" varchar(255) NOT NULL, "first_name" varchar(255) NOT NULL, "sex" varchar(6) NOT NULL, "blood_type" varchar(2) NOT NULL, "serveYears" integer NOT NULL, "role" varchar(100) NOT NULL, "hometown" varchar NOT NULL, "team_id" integer, CONSTRAINT "UQ_017abdefead91b361b5e7ac108f" UNIQUE ("people_id"))`);
        await queryRunner.query(`CREATE TABLE "role" ("role_id" varchar(255) PRIMARY KEY NOT NULL, "job" varchar(255) NOT NULL, "requirement" varchar NOT NULL, CONSTRAINT "UQ_df46160e6aa79943b83c81e496e" UNIQUE ("role_id"))`);
        await queryRunner.query(`CREATE TABLE "equipment" ("equipment_id" varchar(255) PRIMARY KEY NOT NULL, "used_by" varchar(255) NOT NULL, "count" integer NOT NULL, "new_or_used" varchar(10) NOT NULL, CONSTRAINT "UQ_88b371a2f0b8ae33b1060f00189" UNIQUE ("equipment_id"))`);
        await queryRunner.query(`CREATE TABLE "supply" ("supply_id" varchar(255) PRIMARY KEY NOT NULL, "teamTeamId" integer, CONSTRAINT "UQ_ea803c518d575c82cd33f5668df" UNIQUE ("supply_id"))`);
        await queryRunner.query(`CREATE TABLE "temporary_people" ("people_id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "last_name" varchar(255) NOT NULL, "first_name" varchar(255) NOT NULL, "sex" varchar(6) NOT NULL, "blood_type" varchar(2) NOT NULL, "serveYears" integer NOT NULL, "role" varchar(100) NOT NULL, "hometown" varchar NOT NULL, "team_id" integer, CONSTRAINT "UQ_017abdefead91b361b5e7ac108f" UNIQUE ("people_id"), CONSTRAINT "FK_6b7b841de9de9db18199f718ee9" FOREIGN KEY ("team_id") REFERENCES "team" ("team_id") ON DELETE NO ACTION ON UPDATE NO ACTION)`);
        await queryRunner.query(`INSERT INTO "temporary_people"("people_id", "last_name", "first_name", "sex", "blood_type", "serveYears", "role", "hometown", "team_id") SELECT "people_id", "last_name", "first_name", "sex", "blood_type", "serveYears", "role", "hometown", "team_id" FROM "people"`);
        await queryRunner.query(`DROP TABLE "people"`);
        await queryRunner.query(`ALTER TABLE "temporary_people" RENAME TO "people"`);
        await queryRunner.query(`CREATE TABLE "temporary_supply" ("supply_id" varchar(255) PRIMARY KEY NOT NULL, "teamTeamId" integer, CONSTRAINT "UQ_ea803c518d575c82cd33f5668df" UNIQUE ("supply_id"), CONSTRAINT "FK_cd14bd0c792703a7fce50828bb0" FOREIGN KEY ("teamTeamId") REFERENCES "team" ("team_id") ON DELETE NO ACTION ON UPDATE NO ACTION)`);
        await queryRunner.query(`INSERT INTO "temporary_supply"("supply_id", "teamTeamId") SELECT "supply_id", "teamTeamId" FROM "supply"`);
        await queryRunner.query(`DROP TABLE "supply"`);
        await queryRunner.query(`ALTER TABLE "temporary_supply" RENAME TO "supply"`);
    }

    public async down(queryRunner: QueryRunner): Promise<void> {
        await queryRunner.query(`ALTER TABLE "supply" RENAME TO "temporary_supply"`);
        await queryRunner.query(`CREATE TABLE "supply" ("supply_id" varchar(255) PRIMARY KEY NOT NULL, "teamTeamId" integer, CONSTRAINT "UQ_ea803c518d575c82cd33f5668df" UNIQUE ("supply_id"))`);
        await queryRunner.query(`INSERT INTO "supply"("supply_id", "teamTeamId") SELECT "supply_id", "teamTeamId" FROM "temporary_supply"`);
        await queryRunner.query(`DROP TABLE "temporary_supply"`);
        await queryRunner.query(`ALTER TABLE "people" RENAME TO "temporary_people"`);
        await queryRunner.query(`CREATE TABLE "people" ("people_id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "last_name" varchar(255) NOT NULL, "first_name" varchar(255) NOT NULL, "sex" varchar(6) NOT NULL, "blood_type" varchar(2) NOT NULL, "serveYears" integer NOT NULL, "role" varchar(100) NOT NULL, "hometown" varchar NOT NULL, "team_id" integer, CONSTRAINT "UQ_017abdefead91b361b5e7ac108f" UNIQUE ("people_id"))`);
        await queryRunner.query(`INSERT INTO "people"("people_id", "last_name", "first_name", "sex", "blood_type", "serveYears", "role", "hometown", "team_id") SELECT "people_id", "last_name", "first_name", "sex", "blood_type", "serveYears", "role", "hometown", "team_id" FROM "temporary_people"`);
        await queryRunner.query(`DROP TABLE "temporary_people"`);
        await queryRunner.query(`DROP TABLE "supply"`);
        await queryRunner.query(`DROP TABLE "equipment"`);
        await queryRunner.query(`DROP TABLE "role"`);
        await queryRunner.query(`DROP TABLE "people"`);
        await queryRunner.query(`DROP TABLE "team"`);
        await queryRunner.query(`DROP TABLE "software"`);
    }

}

그럼 위와 같이 파일이 자동으로 생성될 거에요.
이 파일을 보면 DML Query가 작성 되어 있는데, 이는 Entity를 기반으로 TypeORM이 만들어 준거에요.

이번에는 Team과 Supply에 대한 Migraion을 만들어 볼게요.

typeorm migraion:create <Seed File Name>

이 명령어를 입력하면 위와 같이 Project Root Directory에 위와 같이
TypeScript 확장자를 갖은 파일이 생성되는걸 확인할 수 있어요.

주니는 위와 같이 Directory를 변경해서 사용해 보려고 해요.

up()에 대해 분석을 해볼게요. 이 Method(메서드)는 Database(데이터베이스)
Scheam(스키마)를 변경하고, 특정 Table(테이블)을 생성하는 역할을 하는 친구에요.

up()은 queryRunner.createTable()을 활용하여 team이라는 테이블을 만들게 해주는데,
이 때, team_id는 bigint Type의 컬럼을 만들고, 기본 키이며,
자동으로 생성되는 increment 전략을 사용하겠다고 명시해 준 것이에요.

name은 varchart Type으로 Null을 허용하지 않겠다고 명시해 준 부분이에요.

isPrimary는 해당 컬럼이 기본 키인지 여부를 명시해주기 위해 사용한 것이고,
isGenerated는 해당 컬럼이 자동으로 생성되는지 여부를 명시해 주기 위해 사용한 것이고,
generationStrategy는 자동 생성되는 컬럼 전략을 지정하기 위해 명시한 것인데,
위 코드는 Increament 전략을 사용하겠다고 명시한 부분이에요.

이렇게 해서 team Table을 생성하는 Migration을 만들었고, up()을 통해 Table을 생성하고,
down()을 통해 해당 Table이 삭제될 수 있도록 Logic을 구현하였어요.

그리고 위와 같이 team Table에 들어갈 Mock Data를 명시해 주었어요.

하지만, TypeORM을 사용하고 있고, Entity를 구성해준 뒤

위와 같이 synchronize를 true로 해주면 TypeORM이 알아서 Entity를 분석해서 Table과 Column을 만들어 주어요.

하지만, 원하는 시점의 정의된 스키마(Entity)를 데이터베이스에 반영해야 하는데, 위와 같이 하게 되면 서버가 기동될 때마다 스키마에 따른 데이터베이스 구조가 변경될 수 있기 때문에 매우 신중해야 해요.

그래서 많이 이용하는 것이 Migration이에요.

그래서 위와 같이 변경해 주었어요.

728x90

위 명령어를 입력하면

이렇게 만들어진다고 했는데,
보시다시피 DDL 문이 들어가 있고, TABLE을 만드는 SQL이 들어가 있는걸 볼 수 있어요.

이 구문들로 인해 synchronize를 False로 해도 Table이 알아서 만들어져요.

최초 위와 같이 team Table을 만들어 주었어요.
그리고 team Table과 관계를 맺기 위해 team_id를 FK로 설정해 주었어요.

그리고 DML Native Query를 이용해서 Mock Data를 넣을 수 있도록 처리해 주었어요.

import { MigrationInterface, QueryRunner, Table } from "typeorm";

export class SeedTeam1701325303468 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise<void> {
    const teamTableExist = await queryRunner.hasTable("team");

    if (!teamTableExist) {
      await queryRunner.createTable(
        new Table({
          name: "team",
          columns: [
            { name: "team_id", type: "integer", isPrimary: true, isGenerated: true, generationStrategy: "increment" },
            { name: "manager", type: "varchar", isNullable: false },
            { name: "office", type: "varchar", isNullable: false },
            { name: "extension_number", type: "varchar", isNullable: false },
            { name: "mascot", type: "varchar", isNullable: false },
            { name: "cleaning_duty", type: "varchar", isNullable: false },
            { name: "project", type: "varchar", isNullable: false },
          ],
        }),
        true,
      );
    }

    //Seeding Data 삽입
    await queryRunner.query(
      `INSERT INTO \`team\` (\`manager\`, \`office\`, \`extension_number\`, \`mascot\`, \`cleaning_duty\`, \`project\`) VALUES ('Mandy Warren', '101A', '#5709', 'Panda','Monday','Hyperion')`,
    );
    await queryRunner.query(
      `INSERT INTO \`team\` (\`manager\`, \`office\`, \`extension_number\`, \`mascot\`, \`cleaning_duty\`, \`project\`) VALUES ('Stewart Grant', '101B', '#4012', 'Tadpole','Tuesday','Zen')`,
    );
    await queryRunner.query(
      `INSERT INTO \`team\` (\`manager\`, \`office\`, \`extension_number\`, \`mascot\`, \`cleaning_duty\`, \`project\`) VALUES ('Smantha Wheatly', '102A', '#3852', 'Falcon','Wednesday','Duranno')`,
    );
    await queryRunner.query(
      `INSERT INTO \`team\` (\`manager\`, \`office\`, \`extension_number\`, \`mascot\`, \`cleaning_duty\`, \`project\`) VALUES ('Francis Buckley', '103B', '#1039', 'Beaver','Thursday','Genghis')`,
    );
    await queryRunner.query(
      `INSERT INTO \`team\` (\`manager\`, \`office\`, \`extension_number\`, \`mascot\`, \`cleaning_duty\`, \`project\`) VALUES ('Blake Smith', '104A', '#7750', 'Wildcat','Friday','Acheron')`,
    );
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.dropTable("team");
  }
}

TeamSeed는 위와 같이 만들어 주었어요.

✘ JunySS 🇰   ~/Programming/study/graphql-study/type-script-nest-graph-ql-실습   master ±✚  npm run migration:run

> type-script-nest-graph-ql-실습@0.0.1 migration:run
> npm run typeorm  migration:run


> type-script-nest-graph-ql-실습@0.0.1 typeorm
> ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --dataSource ./data-source.ts migration:run

query: SELECT * FROM "sqlite_master" WHERE "type" = 'table' AND "name" = 'migrations'
query: SELECT * FROM "migrations" "migrations" ORDER BY "id" DESC
0 migrations are already loaded in the database.
2 migrations were found in the source code.
2 migrations are new migrations must be executed.
query: PRAGMA foreign_keys = OFF
query: BEGIN TRANSACTION
query: SELECT * FROM "sqlite_master" WHERE "type" = 'table' AND "name" = 'supply'
query: CREATE TABLE "supply" ("supply_id" varchar NOT NULL, "team_id" integer NOT NULL, CONSTRAINT "FK_88d10c4e569685c8345705b213f" FOREIGN KEY ("team_id") REFERENCES "team" ("team_id") ON DELETE CASCADE)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('ergonomic mouse', 1)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('mug', 1)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('webcam', 2)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('hoodie', 2)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('chair', 3)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('usb hub', 3)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('headphone', 4)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('stempler', 4)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('calculator', 5)
query: INSERT INTO `supply` (`supply_id`, `team_id`) VALUES ('t shirt', 5)
query: INSERT INTO "migrations"("timestamp", "name") VALUES (1701325299045, ?) -- PARAMETERS: ["SeedSupply1701325299045"]
Migration SeedSupply1701325299045 has been  executed successfully.
query: SELECT * FROM "sqlite_master" WHERE "type" = 'table' AND "name" = 'team'
query: SELECT * FROM "sqlite_master" WHERE "type" = 'table' AND "name" = 'team'
query: CREATE TABLE "team" ("team_id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "manager" varchar NOT NULL, "office" varchar NOT NULL, "extension_number" varchar NOT NULL, "mascot" varchar NOT NULL, "cleaning_duty" varchar NOT NULL, "project" varchar NOT NULL)
query: INSERT INTO `team` (`manager`, `office`, `extension_number`, `mascot`, `cleaning_duty`, `project`) VALUES ('Mandy Warren', '101A', '#5709', 'Panda','Monday','Hyperion')
query: INSERT INTO `team` (`manager`, `office`, `extension_number`, `mascot`, `cleaning_duty`, `project`) VALUES ('Stewart Grant', '101B', '#4012', 'Tadpole','Tuesday','Zen')
query: INSERT INTO `team` (`manager`, `office`, `extension_number`, `mascot`, `cleaning_duty`, `project`) VALUES ('Smantha Wheatly', '102A', '#3852', 'Falcon','Wednesday','Duranno')
query: INSERT INTO `team` (`manager`, `office`, `extension_number`, `mascot`, `cleaning_duty`, `project`) VALUES ('Francis Buckley', '103B', '#1039', 'Beaver','Thursday','Genghis')
query: INSERT INTO `team` (`manager`, `office`, `extension_number`, `mascot`, `cleaning_duty`, `project`) VALUES ('Blake Smith', '104A', '#7750', 'Wildcat','Friday','Acheron')
query: INSERT INTO "migrations"("timestamp", "name") VALUES (1701325303468, ?) -- PARAMETERS: ["SeedTeam1701325303468"]
Migration SeedTeam1701325303468 has been  executed successfully.
query: COMMIT
query: PRAGMA foreign_keys = ON

위와 같이 Query가 날아가면서 Mock Data가 넣어진걸 확인할 수 있어요.

만약 위 명령어를 입력했는데, 이미 어떤 Table이 만들어져 있다는 Error가 나오게 되면

이 명령어는 입력하지 말고, 진행하면 되고,
이미 입력했다면 이 명령어로 만들어진 TypeScript 파일을 삭제해 주면 돼요.

해당 Error는 generate로 Table을 이미 만들었는데, Seed에서 또 Table을 만드려고 하니 발생되는 문제이기 때문이에요.

데이터베이스에 값도 잘 들어간 걸 확인할 수 있어요.

NestJS로 배우는 백엔드 프로그래밍:타입스크립트 환경의 차세대 서버 프레임워크를 만나다

COUPANG

www.coupang.com

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

GitHub - junyharang-coding-study/GraphQL-Study: GraphQL을 공부하고, 실습한 코드에요 😀

GraphQL을 공부하고, 실습한 코드에요 😀. Contribute to junyharang-coding-study/GraphQL-Study development by creating an account on GitHub.

github.com

🧐 참고 자료

How to seed TypeORM

There is no need for any packages. It is very straightforward. I am using it to seed my production server with some initial data like…

sushilkbansal.medium.com

[NestJS] TypeORM 마이그레이션

TypeORM 마이그레이션 방법에 대해 알아보기

velog.io

728x90

저작자표시 비영리 변경금지

'Back-End 작업실 > 문제 정리' 카테고리의 다른 글

[Spring Boot 3.0] Could not resolve org.springframework.boot:spring-boot-gradle-plugin (0)	2023.12.12

[Spring Boot 3.0] Could not resolve org.springframework.boot:spring-boot-gradle-plugin 2023.12.12

Juny's ITLog

Juny's ITLog

태그

최근글

댓글

공지사항

아카이브

👷‍♂️ 작업 중인 내용

⚠️ 문제 발생!

🤔 원인 분석

🍻 문제 해결!

🧐 참고 자료

'Back-End 작업실 > 문제 정리' 카테고리의 다른 글

관련글

티스토리툴바

Juny's ITLog

태그

최근글

댓글

공지사항

아카이브

👷‍♂️ 작업 중인 내용

⚠️ 문제 발생!

🤔 원인 분석

🍻 문제 해결!

🧐 참고 자료

'Back-End 작업실 > 문제 정리' 카테고리의 다른 글

관련글

티스토리툴바

⚠️ 문제 발생!

🤔 원인 분석

🍻 문제 해결!

🧐 참고 자료