데이터베이스 관리

// src/index.ts
// 소스: example/src/index.ts
import 'reflect-metadata';
import dotenv from 'dotenv';
import { Application } from '@asapjs/core';
 
dotenv.config();
 
const config = {
  name: 'My App',
  port: process.env.PORT || 3000,
  basePath: 'api',
  extensions: ['@asapjs/router', '@asapjs/sequelize'],  // Router + Sequelize 확장 활성화
  auth: {
    jwt_access_token_secret: process.env.JWT_SECRET || 'secret',
  },
  db: {
    username: process.env.DB_USER || 'root',
    password: process.env.DB_PASSWORD || '',
    database: process.env.DB_NAME || 'myapp',
    host: process.env.DB_HOST || 'localhost',
    port: parseInt(process.env.DB_PORT || '3306', 10),
    dialect: 'mysql',
    logging: false,
  },
};
 
const app = new Application(__dirname, config);
app.run();

DB_USER=root
DB_PASSWORD=password
DB_NAME=myapp
DB_HOST=localhost
DB_PORT=3306
DB_SYNC=true

// 내부 동작 흐름 (packages/sequelize/src/sequelize/index.ts)
1. dbInit(config) → Sequelize 인스턴스 생성
2. authenticate() 시도
3. ER_BAD_DB_ERROR 발생 시:
   → 임시 연결 (database: undefined)
   → CREATE DATABASE IF NOT EXISTS
   → 원래 연결로 재인증

Application.run()
  └─ initMoudles()
       └─ initSequelizeModule(dirname)
            ├─ dbInit(config.db)             // DB 연결
            ├─ loadPath(dirname, '')         // *Table.js, *Dto.js 파일 스캔
            ├─ addModelsToSequelize()        // 모델 등록
            └─ addDtosToSwagger()           // DTO → Swagger 스키마 등록

// src/user/domain/entity/UsersTable.ts
// 소스: example/src/user/domain/entity/UsersTable.ts
import { Model } from 'sequelize-typescript';
import { Table, TypeIs } from '@asapjs/sequelize';
 
@Table({
  tableName: 'users',
  timestamps: true,
})
export default class UsersTable extends Model {
  @TypeIs.INT({ primaryKey: true, autoIncrement: true, comment: '사용자 ID' })
  id: number;
 
  @TypeIs.STRING({ unique: true, comment: '이메일 (고유)' })
  email: string;
 
  @TypeIs.PASSWORD({ comment: '비밀번호 (bcrypt)' })
  password: string;
 
  @TypeIs.STRING({ comment: '사용자 이름' })
  name: string;
 
  @TypeIs.DATETIME({ comment: '생성 일시' })
  created_at: Date;
 
  @TypeIs.DATETIME({ comment: '수정 일시' })
  updated_at: Date;
}

// src/post/domain/entity/PostsTable.ts
// 소스: example/src/post/domain/entity/PostsTable.ts
import { Model } from 'sequelize-typescript';
import { Table, TypeIs } from '@asapjs/sequelize';
import UsersTable from '../../../user/domain/entity/UsersTable';
 
@Table({
  tableName: 'posts',
  timestamps: true,
})
export default class PostsTable extends Model {
  @TypeIs.INT({ primaryKey: true, autoIncrement: true, comment: '게시글 ID' })
  id: number;
 
  @TypeIs.STRING({ comment: '게시글 제목' })
  title: string;
 
  @TypeIs.TEXT({ comment: '게시글 내용' })
  content: string;
 
  @TypeIs.FOREIGNKEY({ table: () => UsersTable, comment: '작성자 ID' })
  user_id: number;
 
  @TypeIs.BELONGSTO(() => UsersTable, 'user_id')
  user: UsersTable;
 
  @TypeIs.DATETIME({ comment: '생성 일시' })
  created_at: Date;
 
  @TypeIs.DATETIME({ comment: '수정 일시' })
  updated_at: Date;
}

// src/user/dto/UserInfoDto.ts
import { ExtendableDto, Dto, TypeIs } from '@asapjs/sequelize';
import UsersTable from '../domain/entity/UsersTable';
 
@Dto({ name: 'user_info_dto', defineTable: UsersTable })
export default class UserInfoDto extends ExtendableDto {
  @TypeIs.INT({ comment: '사용자 ID' })
  id: number;
 
  @TypeIs.STRING({ comment: '이메일' })
  email: string;
 
  @TypeIs.STRING({ comment: '이름' })
  name: string;
 
  @TypeIs.DATETIME({ comment: '가입일' })
  created_at: Date;
}

// src/user/application/UserApplication.ts
import { Repository } from '@asapjs/sequelize';
import UsersTable from '../domain/entity/UsersTable';
import UserInfoDto from '../dto/UserInfoDto';
 
export default class UserApplication extends Repository {
  async getUsers(paging: { page: number; limit: number }, user: any) {
    return await this.repository.findAll(UsersTable, {
      exportTo: UserInfoDto,
      user,
      paging,
      order: [['created_at', 'DESC']],
    });
  }
 
  async getUserById(id: number, user: any) {
    return await this.repository.findOne(UsersTable, {
      exportTo: UserInfoDto,
      user,
      where: { id },
    });
  }
}

// paging 포함 시 응답 형태
{
  data: T[],            // 현재 페이지의 레코드 배열
  page: number,         // 현재 페이지 (0-based)
  page_size: number,    // 페이지당 항목 수
  max_page: number,     // 마지막 페이지 인덱스
  has_prev: boolean,    // 이전 페이지 존재 여부
  has_next: boolean,    // 다음 페이지 존재 여부
  total_elements: number // 전체 레코드 수
}

// src/index.ts
import { Application } from '@asapjs/core';
import { modelsSync } from '@asapjs/sequelize';
 
const app = new Application(__dirname, config);
 
app.run(async () => {
  if (process.env.DB_SYNC === 'true') {
    await modelsSync();
  }
});

# 스키마 동기화
cd example && yarn db:sync    # DB_SYNC=true로 실행
 
# 시드 데이터 삽입
cd example && yarn db:seed
 
# 동기화 + 시드
cd example && yarn db:reset

// src/health/controller/HealthController.ts
import { RouterController, Get, ExecuteArgs } from '@asapjs/router';
import { healthCheck } from '@asapjs/sequelize';
 
export default class HealthController extends RouterController {
  public basePath = '/health';
  public tag = 'Health';
 
  constructor() {
    super();
    this.registerRoutes();
  }
 
  @Get('/', { title: 'Health check', auth: false })
  async check({}: ExecuteArgs) {
    await healthCheck();
    return { status: 'ok' };
  }
}

import { getSequelize } from '@asapjs/sequelize';
 
// 트랜잭션 사용
const sequelize = getSequelize();
await sequelize.transaction(async (t) => {
  await UsersTable.create({ name: 'Alice' }, { transaction: t });
  await PostsTable.create({ title: 'Hello', user_id: 1 }, { transaction: t });
});