Reigle 技術ブログ

プログラミング、IT関連の記事中心

Knex.jsのSeed設定方法

目次

Knex.jsのSeed設定方法

Knex.jsでは、データベースの初期データを簡単に設定するためのSeedsを提供しています。
この記事では、Knex.jsのSeedの基本的な設定方法を紹介します。

1. Seed ファイルの作成

まず、Knex CLIを使用して新しいSeedファイルを作成します。

npx knex seed:make seed_name

seed_nameの部分は、実際のSeedの名前に置き換えてください。
これにより、seedsディレクトリに新しいファイルが生成されます。

2. Seed ファイルの編集

次に、生成されたSeedファイルを編集します。
以下は、itemsテーブルにデータを挿入するためのサンプルコードです。

exports.seed = function (knex) {
  return knex('items').del()
    .then(function () {
      return knex('items').insert([
        { name: 'item1' },
        { name: 'item2' },
        { name: 'item3' }
      ]);
    });
};

このコードは、まずitemsテーブルの全エントリを削除し、その後新しいエントリを3つ挿入します。

3. Seed ファイルの実行

最後に、以下のコマンドを使用して、作成したSeedファイルを実行します。

npx knex seed:run

これにより、指定したデータがデータベースに挿入されます。

注意点

  • Seedの操作は、主に開発環境でデータベースを初期化するために使用されます。
    生産環境でSeedを使用する際には注意が必要です。
  • Seedファイルは、実行される順序が重要な場合があります。
    例えば、外部キー制約がある場合、親テーブルのSeedが先に実行される必要があります。

以上、Knex.jsのSeed設定の基本的な方法についての紹介でした。
この情報が役立つことを願っています!