Knex.jsの環境構築ガイド

目次

Knex.jsの環境構築ガイド

この記事では、Node.js用の強力なSQLクエリビルダーであるKnex.jsの環境構築方法について解説します。
Knex.jsは、MySQL、PostgreSQL、SQLite3など、多くのSQLデータベースとの接続をサポートしています。

ステップ1: Node.jsのインストール

Knex.jsを使用する前に、Node.jsがシステムにインストールされていることを確認してください。
Node.jsは以下の公式ウェブサイトからダウンロードできます：Node.js公式サイト

ステップ2: 新しいNode.jsプロジェクトの作成

新しいディレクトリを作成し、その中で以下のコマンドを実行してNode.jsプロジェクトを初期化します。

npm init -y

ステップ3: Knex.jsとデータベースドライバのインストール

次に、Knex.jsと使用するデータベースに対応するドライバをインストールします。
例えば、PostgreSQLを使用する場合は以下のようになります。

npm install knex pg

MySQLやSQLiteを使用する場合は、それぞれmysqlやsqlite3をインストールしてください。

ステップ4: Knexfileの設定

プロジェクトのルートにknexfile.jsを作成し、データベースの設定を記述します。
以下はPostgreSQL用の設定例です。

module.exports = {
  development: {
    client: 'postgresql',
    connection: {
      database: 'my_db',
      user:     'username',
      password: 'password'
    },
    migrations: {
      tableName: 'knex_migrations'
    }
  }
};

ステップ5: マイグレーションとシードの使用

データベーススキーマの作成や初期データの投入には、Knexのマイグレーションとシード機能を使用します。

• マイグレーションの作成：

npx knex migrate:make migration_name

• マイグレーションの実行：

npx knex migrate:latest

• シードファイルの作成：

npx knex seed:make seed_name

• シードの実行：

npx knex seed:run

以上で基本的なKnex.jsの環境構築は完了です。
プロジェクトやデータベースに応じて設定を調整してください。
詳細な情報については、Knex.jsの公式ドキュメントを参照してください。