# NestJSとTypeORMでカスタムマイグレーションを作成する方法

## 目次

1. はじめに
2. NestJSとTypeORMの基本設定
   1. プロジェクトのセットアップ
   2. TypeORMの導入と設定
3. マイグレーションの基礎
   1. マイグレーションとは
   2. マイグレーションの利点
4. カスタムマイグレーションの作成
   1. 初期マイグレーションクラスの生成
   2. カスタムマイグレーションロジックの追加
5. マイグレーションの実行と確認
   1. コマンドでの実行
   2. データベースでの確認
6. まとめ

## 1. はじめに

NestJSとTypeORMは、現代のウェブアプリケーション開発において非常に人気のあるスタックです。特に、TypeORMはオブジェクトリレーショナルマッピング(ORM)ツールとして、データベースとのやりとりを抽象化し、効率的な開発を可能にします。本記事では、NestJSとTypeORMを使って、カスタムマイグレーションを作成する方法について詳しく解説します。

## 2. NestJSとTypeORMの基本設定

### 2.1 プロジェクトのセットアップ

まずは、NestJSプロジェクトを新規作成します。ターミナルで以下のコマンドを実行してプロジェクトを作成しましょう。

![img](/mosaic-code.jpg)

この作業により、基本的なNestJSプロジェクトが作成されます。

### 2.2 TypeORMの導入と設定

次に、TypeORMとその他必要なパッケージをインストールします。

![img](/mosaic-code.jpg)

ここではMySQLを使用しますが、ほかのデータベースもサポートされています。プロジェクトの`app.module.ts`にTypeORMを設定します。

![img](/mosaic-code.jpg)

## 3. マイグレーションの基礎

### 3.1 マイグレーションとは

マイグレーションとは、データベースのスキーマバージョンを管理するプロセスを指します。データベースのスキーマに変更があった際、以前のデータベーススキーマを保持しつつ新しいスキーマを導入するために使用されます。

### 3.2 マイグレーションの利点

- データベースのスキーマ変更を簡単に追跡可能
- 複数の環境で一致したデータ構造を維持
- チームでの作業時にスキーマ変更を安全に共有

## 4. カスタムマイグレーションの作成

### 4.1 初期マイグレーションクラスの生成

まず、TypeORM CLIを使用してマイグレーションファイルを作成します。

![img](/mosaic-code.jpg)

このコマンドにより、`src/migration`フォルダの下にマイグレーションファイルが自動生成されます。

### 4.2 カスタムマイグレーションロジックの追加

マイグレーションファイル内に、カスタムのSQLクエリを記述します。例として、テーブルを新規作成するためのコードを追加します。

![img](/mosaic-code.jpg)

## 5. マイグレーションの実行と確認

### 5.1 コマンドでの実行

マイグレーションを適用するには、以下のコマンドを実行します。

![img](/mosaic-code.jpg)

### 5.2 データベースでの確認

マイグレーションが正しく適用されたかを確認するため、データベース管理ツール（例: MySQL WorkbenchやDBeaver）を使用して、データベース構造をチェックします。

## 6. まとめ

NestJSとTypeORMを使用したカスタムマイグレーションの作成方法について説明しました。プロジェクトにおけるデータベースの一貫性を保つために、マイグレーションは非常に強力なツールです。マイグレーションを活用し、効率的なデータベース管理を行いましょう。

この技術的な内容を理解し、自身のプロジェクトで応用してみてください。 [cv:issue_marketplace_engineer]

# NestJSとTypeORMでカスタムマイグレーションを作成する方法

## 目次

1. はじめに
2. NestJSとTypeORMの基本設定
   1. プロジェクトのセットアップ
   2. TypeORMの導入と設定
3. マイグレーションの基礎
   1. マイグレーションとは
   2. マイグレーションの利点
4. カスタムマイグレーションの作成
   1. 初期マイグレーションクラスの生成
   2. カスタムマイグレーションロジックの追加
5. マイグレーションの実行と確認
   1. コマンドでの実行
   2. データベースでの確認
6. まとめ

## 1. はじめに

NestJSとTypeORMは、現代のウェブアプリケーション開発において非常に人気のあるスタックです。特に、TypeORMはオブジェクトリレーショナルマッピング(ORM)ツールとして、データベースとのやりとりを抽象化し、効率的な開発を可能にします。本記事では、NestJSとTypeORMを使って、カスタムマイグレーションを作成する方法について詳しく解説します。

## 2. NestJSとTypeORMの基本設定

### 2.1 プロジェクトのセットアップ

まずは、NestJSプロジェクトを新規作成します。ターミナルで以下のコマンドを実行してプロジェクトを作成しましょう。

```bash
npm i -g @nestjs/cli
nest new my-nest-project
```

この作業により、基本的なNestJSプロジェクトが作成されます。

### 2.2 TypeORMの導入と設定

次に、TypeORMとその他必要なパッケージをインストールします。

```bash
npm install --save @nestjs/typeorm typeorm mysql
```

ここではMySQLを使用しますが、ほかのデータベースもサポートされています。プロジェクトの`app.module.ts`にTypeORMを設定します。

```typescript
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'mysql',
      host: 'localhost',
      port: 3306,
      username: 'test',
      password: 'test',
      database: 'test',
      entities: [__dirname + '/**/*.entity{.ts,.js}'],
      synchronize: false,
    }),
  ],
})
export class AppModule {}
```

## 3. マイグレーションの基礎

### 3.1 マイグレーションとは

マイグレーションとは、データベースのスキーマバージョンを管理するプロセスを指します。データベースのスキーマに変更があった際、以前のデータベーススキーマを保持しつつ新しいスキーマを導入するために使用されます。

### 3.2 マイグレーションの利点

- データベースのスキーマ変更を簡単に追跡可能
- 複数の環境で一致したデータ構造を維持
- チームでの作業時にスキーマ変更を安全に共有

## 4. カスタムマイグレーションの作成

### 4.1 初期マイグレーションクラスの生成

まず、TypeORM CLIを使用してマイグレーションファイルを作成します。

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

このコマンドにより、`src/migration`フォルダの下にマイグレーションファイルが自動生成されます。

### 4.2 カスタムマイグレーションロジックの追加

マイグレーションファイル内に、カスタムのSQLクエリを記述します。例として、テーブルを新規作成するためのコードを追加します。

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

export class MigrationName1644329436792 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`
      CREATE TABLE user (
        id int NOT NULL AUTO_INCREMENT,
        name varchar(255) NOT NULL,
        email varchar(255) NOT NULL,
        PRIMARY KEY (id)
      )
    `);
  }

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

## 5. マイグレーションの実行と確認

### 5.1 コマンドでの実行

マイグレーションを適用するには、以下のコマンドを実行します。

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

### 5.2 データベースでの確認

マイグレーションが正しく適用されたかを確認するため、データベース管理ツール（例: MySQL WorkbenchやDBeaver）を使用して、データベース構造をチェックします。

## 6. まとめ

NestJSとTypeORMを使用したカスタムマイグレーションの作成方法について説明しました。プロジェクトにおけるデータベースの一貫性を保つために、マイグレーションは非常に強力なツールです。マイグレーションを活用し、効率的なデータベース管理を行いましょう。

この技術的な内容を理解し、自身のプロジェクトで応用してみてください。 

NestJSとTypeORMでカスタムマイグレーションを作成する方法

目次

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