MySQL で Sequelize を使うなら知っておくべき：単数形テーブル名の罠と回避策

2024-06-27

Sequelize で単数形のテーブル名を使用する方法

この問題を解決するには、以下の 2 つの方法があります。

freezeTableName オプションを使用する

モデルを定義する際に、freezeTableName オプションを true に設定できます。これにより、Sequelize はモデル名を変更せずにテーブル名として使用します。

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql'
});

const User = sequelize.define('user', {
  name: Sequelize.STRING,
  email: Sequelize.STRING
}, {
  freezeTableName: true
});

この設定の場合、User モデルは users テーブルではなく、user テーブルに対応します。

tableName オプションを使用する

モデルを定義する際に、tableName オプションを使用して、テーブル名を明示的に指定できます。

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql'
});

const User = sequelize.define('User', {
  name: Sequelize.STRING,
  email: Sequelize.STRING
}, {
  tableName: 'user'
});

補足:

上記の方法は、Sequelize バージョン 5.x 以降で使用できます。
既存のマイグレーションがある場合は、tableName オプションを使用する方が簡単です。
プロジェクト全体で一貫性を保つために、どちらかの方法を必ず選択してください。

Sequelize で単数形のテーブル名を使用する：サンプルコード

freezeTableName オプションを使用する

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql'
});

// `user` テーブルに対応する `User` モデルを定義します
const User = sequelize.define('User', {
  name: Sequelize.STRING,
  email: Sequelize.STRING
}, {
  freezeTableName: true // テーブル名を変更しない
});

// データベースにマイグレーションを実行します
User.sync();

このコードでは、freezeTableName オプションを true に設定することで、User モデル名がテーブル名としてそのまま使用されます。

tableName オプションを使用する

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql'
});

// `user` テーブルに対応する `User` モデルを定義します
const User = sequelize.define('User', {
  name: Sequelize.STRING,
  email: Sequelize.STRING
}, {
  tableName: 'user' // テーブル名を明示的に指定
});

// データベースにマイグレーションを実行します
User.sync();

このコードでは、tableName オプションを使用して、User モデルに対応するテーブル名を user と明示的に指定しています。

どちらの方法を選択する場合も、マイグレーションを実行する前に必ず sequelize.sync() を呼び出すようにしてください。

Sequelize で単数形のテーブル名を使用する：その他の方法

カスタムシーケンスを使用する

Sequelize では、カスタムシーケンスを使用してテーブル名とモデル名を別々に定義することができます。これは、より複雑な命名規則が必要な場合に役立ちます。

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql'
});

// シーケンスを定義します
const sequence = sequelize.define('sequence', {
  tableName: {
    type: Sequelize.STRING,
    allowNull: false
  }
});

// `user` テーブルに対応する `User` モデルを定義します
const User = sequelize.define('User', {
  name: Sequelize.STRING,
  email: Sequelize.STRING
}, {
  sequelize,
  tableName: function() {
    return sequence.findOne().then(seq => seq.tableName);
  }
});

// データベースにマイグレーションを実行します
sequence.sync();
User.sync();

このコードでは、sequence モデルを使用してテーブル名を格納するカスタムシーケンスを定義しています。その後、User モデルの tableName オプションで、シーケンスからテーブル名を取得するように設定しています。

環境変数を使用する

テーブル名を環境変数から取得することもできます。これは、異なる環境で異なるテーブル名を使用する必要がある場合に役立ちます。

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql'
});

const tableName = process.env.TABLE_NAME || 'user'; // 環境変数からテーブル名を取得

// `tableName` テーブルに対応する `User` モデルを定義します
const User = sequelize.define('User', {
  name: Sequelize.STRING,
  email: Sequelize.STRING
}, {
  tableName: tableName
});

// データベースにマイグレーションを実行します
User.sync();