TypeORM column mapping 하기 with snakeCase

이우길·2022년 5월 9일

Node typeOrm

예제는 Github에 있습니다 :)

Goal

TypeORM을 사용할 때 애플리케이션 필드명은 CamelCase, Database의 Column명은 SnakeCase로 사용하기.

개발 환경

database: sqllite
nestjs
typeorm

일반적으로 애플리케이션의 필드는 CamelCase로 사용하고 Database의 Column명은 SnakeCase를 이용한다.

TypeORM에서는 Column명에 아무런 option을 주지 않으면 애플리케이션의 필드명을 그대로 사용하여 매핑을 하게 된다.

mapping이 정상적이지 않을 때

만약 애플리케이션의 필드명과 Database의 Column명이 일치하지 않고 매핑되지 않는다면 사용할 수 없다.

users entity

@Entity({ name: "users" })
export class Users {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @CreateDateColumn({ nullable: false })
  createdAt: Date;

  @UpdateDateColumn({ nullable: false })
  lastModifiedAt: Date;
}

database

위와 같은 상태에서 TypeORM을 이용하여 데이터를 조작하게되면 아래와 같은 error를 만날 수 있게 된다. 간단하게 find 메소드를 실행한 결과이다.

[Nest] 7655  - 2022. 05. 08. 오후 1:06:51   ERROR [ExceptionsHandler] SQLITE_ERROR: no such column: Users.createdAt
QueryFailedError: SQLITE_ERROR: no such column: Users.createdAt ...

해결

해결방법은 2가지가 존재한다.

@Column() 데코레이터에 name Option을 이용하여 TypeORM에게 해당 필드가 어떠한 Column에 매핑되는지 알려주기.
typeorm-naming-strategies를 이용하여 처리하기.

애플리케이션 필드마다 name 부여하기

1번 방법은 간단하지만 반복적인 작업들이 많이 생긴다. entity마다 @Column()에 Option을 부여하여 처리하기 때문이다.

방법은 아래의 코드와 같다.

@Entity({ name: "users" })
export class Users {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @CreateDateColumn({ name: "created_at", nullable: false })
  createdAt: Date;

  @UpdateDateColumn({ name: "last_modified_at", nullable: false })
  lastModifiedAt: Date;
}

테이블이 적고, entity의 필드가 적으면 1번 방법도 사용할 수 있겠지만 실무에서는 테이블이 적고, entity의 필드가 적을 가능성이 희박하다. 그렇기 때문에 2번 방법을 선택하는 것을 추천한다.

typeorm-naming-strategies 라이브러리 사용하기

2번 방법은 라이브러리 하나만 추가해주면 된다.

yarn add typeorm-naming-strategies

추가한 후 TypeORM을 설정하는 곳에서 설정 Option중 namingStrategy만 추가해주면 된다. 추가하는 코드는 아래와 같다.

@Module({
  imports: [
    TypeOrmModule.forRoot({
      //...
      namingStrategy: new SnakeNamingStrategy(),
    }),
    UsersModules,
  ],
})
export class AppModule {}