fix!: typeorm migrate 작성하기 (#84)

* feat: typeorm migrate 위한 파일 정리 및 config 수정 * refactor: 파일 경로 변경에 의한 import 변경 * migrate: typeorm migrate 성공 * [autofix.ci] apply automated fixes * chore: readme migration 방법 추가 --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
jiphyeonjeon-42 · Dec 22, 2024 · f393135 · f393135
1 parent feeb8f4
commit f393135
Show file tree

Hide file tree

Showing 40 changed files with 422 additions and 539 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,12 @@ $ pnpm dev
 
 위 명령어로 개발용 docker compose를 실행합니다.
 
+### migrate 실행
+```sh
+$ pnpm run migrate:run
+```
+위 명령어로 migration 실행합니
+
 ![](./swagger.webp)
 
 <http://localhost:3000/api> 경로에 접근하여 API 명세가 올바르게 표시되는지 확인합니다.
diff --git a/backend/package.json b/backend/package.json
@@ -19,7 +19,12 @@
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "migrate:run": "pnpm ts-node ./node_modules/typeorm/cli.js migration:run -d ./src/database/config.ts",
+    "migrate:revert": "pnpm ts-node ./node_modules/typeorm/cli.js migration:revert -d ./src/database/config.ts",
+    "migrate:reset": "pnpm migrate:revert && pnpm migrate:run",
+    "migrate:create": "pnpm ts-node ./node_modules/typeorm/cli.js migration:create ./src/database/migrate/custom",
+    "migrate:generate": "pnpm ts-node ./node_modules/typeorm/cli.js migration:generate ./src/database/migrate/auto -d ./src/database/config.ts"
   },
   "dependencies": {
     "@anatine/zod-nestjs": "^2.0.9",

diff --git a/backend/src/app.module.ts b/backend/src/app.module.ts
@@ -4,10 +4,14 @@ import { AppController } from './app.controller';
 import { AppService } from './app.service';
 import { HistoriesModule } from './histories/histories.module';
 import { BooksModule } from './books/books.module';
-import { dbConfig } from './config';
+import { typeOrmModuleOptions } from './database/config';
 
 @Module({
-  imports: [TypeOrmModule.forRoot(dbConfig), HistoriesModule, BooksModule],
+  imports: [
+    TypeOrmModule.forRoot(typeOrmModuleOptions),
+    HistoriesModule,
+    BooksModule,
+  ],
   controllers: [AppController],
   providers: [AppService],
 })

diff --git a/backend/src/books/books.module.ts b/backend/src/books/books.module.ts
@@ -2,7 +2,7 @@ import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { BooksController } from './books.controller';
 import { BooksService } from './books.service';
-import { Book, BookCopy } from '../entities';
+import { Book, BookCopy } from '../database/entities';
 
 @Module({
   imports: [TypeOrmModule.forFeature([Book, BookCopy])],

diff --git a/backend/src/books/books.service.ts b/backend/src/books/books.service.ts
@@ -1,7 +1,7 @@
 import { Injectable, NotFoundException } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
-import { Book, BookCopy } from '../entities';
+import { Book, BookCopy } from '../database/entities';
 import { PaginationOptionsDto } from '../common/dtos/page-options.dto';
 import {
   CreateBookCopyRequestDto,

diff --git a/backend/src/categories/categories.service.ts b/backend/src/categories/categories.service.ts
@@ -1,8 +1,8 @@
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
-import { Category } from '../entities/Category';
-import { Book } from '../entities/Book';
+import { Category } from '../database/entities/Category';
+import { Book } from '../database/entities/Book';
 import { categoryCountSchema } from 'src/books/dto/books.dto';
 
 @Injectable()

diff --git a/backend/src/config.ts b/backend/src/config.ts
diff --git a/backend/src/database/config.ts b/backend/src/database/config.ts
@@ -0,0 +1,23 @@
+import { TypeOrmModuleOptions } from '@nestjs/typeorm';
+import * as dotenv from 'dotenv';
+import { DataSource, DataSourceOptions } from 'typeorm';
+
+dotenv.config();
+
+export const dbConfig: DataSourceOptions = {
+  type: 'mysql',
+  host: process.env.MYSQL_HOST,
+  port: 3306,
+  username: process.env.MYSQL_USER,
+  password: process.env.MYSQL_PASSWORD,
+  database: process.env.MYSQL_DATABASE,
+  entities: [__dirname + '/entities/*{.ts,.js}'],
+  migrations: [__dirname + '/migrate/*{.ts,.js}'],
+  migrationsTableName: 'typeorm_migrations',
+  synchronize: false,
+};
+
+// TypeOrmModuleOptions 는 extends Partial<DataSourceOptions>
+export const typeOrmModuleOptions: TypeOrmModuleOptions = dbConfig;
+
+export const dataSource: DataSource = new DataSource(dbConfig);
diff --git a/backend/src/entities/Book.ts → backend/src/database/entities/Book.ts b/backend/src/entities/Book.ts → backend/src/database/entities/Book.ts
@@ -13,10 +13,8 @@ import { Category } from './Category';
 import { Likes } from './Likes';
 import { Reservation } from './Reservation';
 import { Reviews } from './Reviews';
-import { SuperTag } from './SuperTag';
 import { BookInfoSearchKeywords } from './BookInfoSearchKeywords';
 
-@Index('categoryId', ['categoryId'], {})
 @Entity('book_info')
 export class Book {
   @PrimaryGeneratedColumn({ type: 'int', name: 'id' })
@@ -42,13 +40,14 @@ export class Book {
 
   @Column('datetime', {
     name: 'createdAt',
-    default: () => "'CURRENT_TIMESTAMP(6)'",
+    default: 'CURRENT_TIMESTAMP(6)',
   })
   createdAt: Date;
 
   @Column('datetime', {
     name: 'updatedAt',
-    default: () => "'CURRENT_TIMESTAMP(6)'",
+    default: 'CURRENT_TIMESTAMP(6)',
+    onUpdate: 'CURRENT_TIMESTAMP(6)',
   })
   updatedAt: Date;
 
@@ -62,7 +61,12 @@ export class Book {
     onDelete: 'NO ACTION',
     onUpdate: 'NO ACTION',
   })
-  @JoinColumn([{ name: 'categoryId', referencedColumnName: 'id' }])
+  @JoinColumn([
+    {
+      name: 'categoryId',
+      referencedColumnName: 'id',
+    },
+  ])
   category: Category;
 
   @OneToMany(() => Likes, (likes) => likes.bookInfo)
@@ -74,9 +78,6 @@ export class Book {
   @OneToMany(() => Reviews, (reviews) => reviews.bookInfo)
   reviews?: Reviews[];
 
-  @OneToMany(() => SuperTag, (superTags) => superTags.userId)
-  superTags?: SuperTag[];
-
   @OneToOne(
     () => BookInfoSearchKeywords,
     (bookInfoSearchKeyword) => bookInfoSearchKeyword.bookInfo,

diff --git a/backend/src/entities/BookCopy.ts → backend/src/database/entities/BookCopy.ts b/backend/src/entities/BookCopy.ts → backend/src/database/entities/BookCopy.ts
@@ -1,19 +1,20 @@
 import {
   Column,
+  CreateDateColumn,
   Entity,
   Index,
   JoinColumn,
   ManyToOne,
   OneToMany,
   PrimaryGeneratedColumn,
+  UpdateDateColumn,
 } from 'typeorm';
 import { Book } from './Book';
 import { User } from './User';
 import { Lending } from './Lending';
 import { Reservation } from './Reservation';
 import { BookStatus } from 'src/books/constants';
 
-@Index('FK_donator_id_from_user', ['donatorId'], {})
 @Entity('book')
 export class BookCopy {
   @PrimaryGeneratedColumn({ type: 'int', name: 'id' })
@@ -28,19 +29,13 @@ export class BookCopy {
   @Column('int', { name: 'status' })
   status: BookStatus;
 
-  @Column('datetime', {
-    name: 'createdAt',
-    default: () => "'CURRENT_TIMESTAMP(6)'",
-  })
+  @CreateDateColumn({ name: 'createdAt' })
   createdAt?: Date;
 
   @Column('int')
   infoId: number;
 
-  @Column('datetime', {
-    name: 'updatedAt',
-    default: () => "'CURRENT_TIMESTAMP(6)'",
-  })
+  @UpdateDateColumn({ name: 'updatedAt' })
   updatedAt?: Date;
 
   @Column('int', { name: 'donatorId', nullable: true })
@@ -53,12 +48,18 @@ export class BookCopy {
   @JoinColumn([{ name: 'infoId', referencedColumnName: 'id' }])
   info?: Book;
 
-  @ManyToOne(() => User, (user) => user.books, {
+  @ManyToOne(() => User, (user) => user.donateBooks, {
     onDelete: 'NO ACTION',
     onUpdate: 'NO ACTION',
   })
-  @JoinColumn([{ name: 'donatorId', referencedColumnName: 'id' }])
-  donator2?: User;
+  @JoinColumn([
+    {
+      name: 'donatorId',
+      referencedColumnName: 'id',
+      foreignKeyConstraintName: 'FK_donator_id_from_user',
+    },
+  ])
+  donateUser?: User;
 
   @OneToMany(() => Lending, (lending) => lending.book)
   lendings?: Lending[];

diff --git a/backend/src/database/entities/BookInfoSearchKeywords.ts b/backend/src/database/entities/BookInfoSearchKeywords.ts
@@ -0,0 +1,63 @@
+import {
+  Column,
+  Entity,
+  JoinColumn,
+  OneToOne,
+  PrimaryGeneratedColumn,
+} from 'typeorm';
+import { Book } from './Book';
+
+@Entity('book_info_search_keywords')
+export class BookInfoSearchKeywords {
+  @PrimaryGeneratedColumn({
+    type: 'int',
+    name: 'id',
+  })
+  id: number;
+
+  @Column('varchar', {
+    name: 'disassembled_title',
+    length: 255,
+    nullable: true,
+  })
+  disassembledTitle?: string;
+
+  @Column('varchar', {
+    name: 'disassembled_author',
+    length: 255,
+    nullable: true,
+  })
+  disassembledAuthor?: string;
+
+  @Column('varchar', {
+    name: 'disassembled_publisher',
+    length: 255,
+    nullable: true,
+  })
+  disassembledPublisher?: string;
+
+  @Column('varchar', { name: 'title_initials', length: 255, nullable: true })
+  titleInitials?: string;
+
+  @Column('varchar', { name: 'author_initials', length: 255, nullable: true })
+  authorInitials?: string;
+
+  @Column('varchar', {
+    name: 'publisher_initials',
+    length: 255,
+    nullable: true,
+  })
+  publisherInitials?: string;
+
+  @Column('int', { name: 'book_info_id', nullable: true })
+  bookInfoId?: number;
+
+  @OneToOne(() => Book, (bookInfo) => bookInfo.id)
+  @JoinColumn([
+    {
+      name: 'book_info_id',
+      referencedColumnName: 'id',
+    },
+  ])
+  bookInfo?: Book;
+}
diff --git a/backend/src/entities/Category.ts → backend/src/database/entities/Category.ts b/backend/src/entities/Category.ts → backend/src/database/entities/Category.ts
diff --git a/backend/src/entities/Lending.ts → backend/src/database/entities/Lending.ts b/backend/src/entities/Lending.ts → backend/src/database/entities/Lending.ts
@@ -1,16 +1,15 @@
 import {
   Column,
+  CreateDateColumn,
   Entity,
-  Index,
   JoinColumn,
   ManyToOne,
   PrimaryGeneratedColumn,
+  UpdateDateColumn,
 } from 'typeorm';
 import { BookCopy } from './BookCopy';
 import { User } from './User';
 
-@Index('FK_f2adde8c7d298210c39c500d966', ['lendingLibrarianId'], {})
-@Index('FK_returningLibrarianId', ['returningLibrarianId'], {})
 @Entity('lending', { schema: '42library' })
 export class Lending {
   @PrimaryGeneratedColumn({ type: 'int', name: 'id' })
@@ -19,7 +18,12 @@ export class Lending {
   @Column('int', { name: 'lendingLibrarianId' })
   lendingLibrarianId: number;
 
-  @Column('varchar', { name: 'lendingCondition', length: 255 })
+  @Column('varchar', {
+    name: 'lendingCondition',
+    length: 255,
+    nullable: false,
+    default: '',
+  })
   lendingCondition: string;
 
   @Column('int', { name: 'returningLibrarianId', nullable: true })
@@ -35,16 +39,10 @@ export class Lending {
   @Column('datetime', { name: 'returnedAt', nullable: true })
   returnedAt: Date | null;
 
-  @Column('timestamp', {
-    name: 'createdAt',
-    default: () => "'CURRENT_TIMESTAMP(6)'",
-  })
+  @CreateDateColumn({ name: 'createdAt', type: 'timestamp' })
   createdAt: Date;
 
-  @Column('timestamp', {
-    name: 'updatedAt',
-    default: () => "'CURRENT_TIMESTAMP(6)'",
-  })
+  @UpdateDateColumn({ name: 'updatedAt', type: 'timestamp' })
   updatedAt: Date;
 
   @ManyToOne(() => BookCopy, (book) => book.lendings, {
@@ -67,17 +65,29 @@ export class Lending {
   @Column({ name: 'userId', type: 'int' })
   userId: number;
 
-  @ManyToOne(() => User, (user) => user.lendings2, {
+  @ManyToOne(() => User, (user) => user.librarianLendings, {
     onDelete: 'NO ACTION',
     onUpdate: 'NO ACTION',
   })
-  @JoinColumn([{ name: 'lendingLibrarianId', referencedColumnName: 'id' }])
+  @JoinColumn([
+    {
+      name: 'lendingLibrarianId',
+      referencedColumnName: 'id',
+      foreignKeyConstraintName: 'FK_f2adde8c7d298210c39c500d966',
+    },
+  ])
   lendingLibrarian: User;
 
-  @ManyToOne(() => User, (user) => user.lendings3, {
+  @ManyToOne(() => User, (user) => user.librarianReturnings, {
     onDelete: 'NO ACTION',
     onUpdate: 'NO ACTION',
   })
-  @JoinColumn([{ name: 'returningLibrarianId', referencedColumnName: 'id' }])
+  @JoinColumn([
+    {
+      name: 'returningLibrarianId',
+      referencedColumnName: 'id',
+      foreignKeyConstraintName: 'FK_returningLibrarianId',
+    },
+  ])
   returningLibrarian: User;
 }