TypeOrm how to soft delete data on cascade

fk (foreign key) 로 연결되어 있는 두 테이블의 데이터를 한 번에 TypeOrm 의 메소드를 사용해 삭제하는 방법에 대해 정리한다.

상황

1. user name, password 등의 정보를 담은 Users table 이 있다. user_id 가 PK (primary key) 이다.
2. user 의 nickname, birth date 등을 담은 UserProfile table 이 있다. Users table 과는 OneToOne relationship 을 가지고 있고, 연결고리가 되어주는 foreign key 는 users table 의 pk 인 users_id 이다.
3. 회원이 탈퇴를 해서 user 데이터를 삭제하면 user profile 데이터도 함께 삭제가 되어야 한다.
4. 삭제는 완전히 DB 에서 row 를 없애버리는 hard delete 가 아니라, deleted_at 필드의 값만 CURRENT_TIMESTAMP 로 찍어주는 soft delete 로 한다.

위와 같은 상황에서 선택할 수 있는 방법은 두 가지이다.

1. users Table 에서 삭제하고자 하는 user id 로 데이터를 찾아내 삭제한 후, 성공적으로 삭제 되었으면 user profile 테이블에서도 user_id 로 데이터를 찾아 삭제해주는 방법
2. users table 에서 user_id 로 조회해 삭제하면, 해당 user_id 를 foreign key 로 가지는 user profile 이 자동 삭제되도록 on cascade 를 걸어주는 방법

TypeORM 은 2번의 방법을 매우 쉽게 구현하도록 옵션을 만들어 놓았다.

1. entity 를 만들 때, parent entity 에서 relation 선언 시 옵션에 cascade: true 를 걸어준다.

cascade 에는 boolean,("insert" | "update" | "remove" | "soft-remove" | "recover")[] 를 넣을 수 있는데, default 값은 false 여서 아무 cascade 도 일어나지 않게 되어 있다.

true 로 넣어주면 insert, update, remove, soft-remove, recover 모두 cascade 를 허용해준다는 뜻이다.

해당 case 에서는 soft-remove 혹은 true 를 넣어주면 된다.

src/domain/user/users.entity.ts 

@Entity()
export class Users {
    @PrimaryGeneratedColumn()
    user_id: number

    @Column()
    name: string

    @OneToOne(() => UserProfile, (profile) => profile.user, { cascade: true or soft-remove })
    @JoinColumn()
    profile: Profile
}


src/domain/user/user-profile.entity.ts

@Entity()
export class UserProfile {
	...

  @OneToOne(() => Users, (user) => user.profile)
  user: Users
}

2. 삭제 구현 코드

주의할 점은, cascade 옵션에서 알 수 있듯이, typeORM 에서 지원하는 cascade delete 는 softDelete 가 아니라 softRemove 이다. softRemove 를 해주려면 entity 를 통채로 넘겨주어야 한다.

src/domain/user/service.ts

async deleteUser (userId: string) {
  const user = await this.userRepository.findOne({
		user_id
  })
	await this.userRepository.softRemove(user)
}

이렇게 구현하고 나서 deleteUser(32) 를 해보면,

Users DB 32번 째 user 의 deleted_at 의 값과, UserProfile DB 32번 째 user profile 의 deleted_at 값이 채워져 있음을 확인할 수 있다.

nestjs request dto and response dto

google social login 한 유저의 생년월일 가져오기

TypeORM soft delete on cascade

typeORM entity 에서 비밀번호 hash 하기