# NestJSとTypeORMのマイグレーションガイド

## 目次

1. はじめに
2. 環境設定
   - 2-1. 必要なパッケージとインストール
3. TypeORM CLIの設定
   - 3-1. `ormconfig.json`の設定
   - 3-2. CLIの活用方法
4. マイグレーションの作成
   - 4-1. マイグレーションのファイル生成
   - 4-2. コードの記述
5. マイグレーションの適用
   - 5-1. マイグレーションの実行
6. マイグレーションのロールバック
   - 6-1. マイグレーションの取り消し
7. 実践的なTips
   - 7-1. 複数のデータベース環境に対応する
   - 7-2. マイグレーションのバージョン管理
8. まとめ

## 1. はじめに

NestJSとTypeORMを使うことで、エンティティをデータベースにマッピングし、データベースとのやり取りを効率的に行うことができます。ここでは、TypeORMのマイグレーションの使い方を紹介し、データベースのスキーマをバージョン管理する流れを理解します。

## 2. 環境設定

### 2-1. 必要なパッケージとインストール

まずは、NestJSプロジェクトに必要なパッケージをインストールします。

```bash
npm install @nestjs/typeorm typeorm pg
```

pgは、PostgreSQLを使用するためのドライバーライブラリです。他のデータベースを使用する場合は、それに応じたドライバーをインストールします。

## 3. TypeORM CLIの設定

### 3-1. `ormconfig.json`の設定

`ormconfig.json`は、TypeORMの設定を記述するJSONファイルです。以下の設定例は、PostgreSQLを使用した接続設定を表しています。

```json
{
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "your_username",
  "password": "your_password",
  "database": "your_database",
  "entities": ["dist/**/*.entity.js"],
  "migrations": ["dist/migration/*.js"],
  "cli": {
    "migrationsDir": "src/migration"
  }
}
```

### 3-2. CLIの活用方法

TypeORM CLIを利用するために、以下のようにpackage.jsonにスクリプトを追加します。

```json
"scripts": {
  "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js"
}
```

これにより、`npm run typeorm` コマンドを使ってCLIを実行できます。

## 4. マイグレーションの作成

### 4-1. マイグレーションのファイル生成

新しいマイグレーションを作成するには、以下のコマンドを使用します。

```bash
npm run typeorm migration:generate -- -n MigrationName
```

このコマンドを実行すると、`src/migration`ディレクトリにマイグレーションファイルが生成されます。

### 4-2. コードの記述

生成されたマイグレーションファイルには、`up` と `down` メソッドがあります。それぞれのメソッドに実行したいSQLや変更を記述します。

```typescript
import { MigrationInterface, QueryRunner } from "typeorm";

export class MigrationName implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`ALTER TABLE example ADD COLUMN new_column VARCHAR;`);
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`ALTER TABLE example DROP COLUMN new_column;`);
  }
}
```

## 5. マイグレーションの適用

### 5-1. マイグレーションの実行

マイグレーションをデータベースに適用するには、以下のコマンドを使用します。

```bash
npm run typeorm migration:run
```

このコマンドにより、未適用のマイグレーションが実行されます。

## 6. マイグレーションのロールバック

### 6-1. マイグレーションの取り消し

適用されたマイグレーションを取り消すためには、次のコマンドを使用します。

```bash
npm run typeorm migration:revert
```

このコマンドは、最新のマイグレーションを逆方向に実行します。

## 7. 実践的なTips

### 7-1. 複数のデータベース環境に対応する

開発、テスト、本番と複数のデータベースに対応するために、環境ごとに`ormconfig.json`を分け、スクリプト実行時に`--config`オプションで指定することが可能です。

### 7-2. マイグレーションのバージョン管理

マイグレーションは、バージョン管理システムで管理すると、チームメンバーとスキーマの変更点を共有しやすくなります。

## 8. まとめ

NestJSとTypeORMを組み合わせることで、データベーススキーマの管理がより直感的に行えるようになります。本ガイドを通じ、マイグレーションの基本的な操作から実践的な活用方法までを理解できたでしょう。特に、複数環境への適用や、バージョン管理との併用は、多くのプロジェクトで役立つテクニックです。エンティティ管理とデータベーススキーマの同期を維持しつつ、適切なマイグレーションの手法を習得してください。 [cv:issue_marketplace_engineer]

NestJSとTypeORMのマイグレーションガイド

目次

続きを読むには単価診断を受けてください（30秒）