SequelizeのSQLログを抑制してパフォーマンスを向上させる

そこで、今回はSequelizeでクエリ実行時のSQLログ出力を抑制する方法について解説します。

環境

• Node.js v16.14.0
• Sequelize v6.7.0

ログ出力抑制方法

Sequelizeでクエリ実行時のSQLログ出力を抑制するには、以下の3つの方法があります。

方法1: loggingオプションを使用する

SequelizeのQueryInterfaceクラスのquery()メソッドには、loggingオプションがあります。このオプションにfalseを設定することで、SQLログ出力を抑制できます。

const sequelize = new Sequelize(...);

sequelize.query('SELECT * FROM users', {
  logging: false,
});

方法2: options.loggingプロパティを使用する

SequelizeのモデルインスタンスのfindAll()、findOne()などのメソッドには、optionsオブジェクトを渡すことができます。このオブジェクトのloggingプロパティにfalseを設定することで、そのメソッド実行時のSQLログ出力を抑制できます。

const User = sequelize.define('user', ...);

User.findAll({
  where: {
    name: 'John Doe',
  },
  options: {
    logging: false,
  },
});

方法3: 環境変数を使用する

Sequelizeは、NODE_ENV環境変数を使用してログレベルを設定できます。NODE_ENVをproductionに設定すると、SQLログが出力されなくなります。

NODE_ENV=production node index.js

まとめ

Sequelizeでクエリ実行時のSQLログ出力を抑制するには、loggingオプション、options.loggingプロパティ、または環境変数を使用することができます。

どの方法を使用するかは、開発環境と本番環境でログ出力レベルをどのように切り分けたいかによって異なります。

loggingオプションを使用する

const sequelize = new Sequelize(...);

sequelize.query('SELECT * FROM users', {
  logging: false,
});

options.loggingプロパティを使用する

const User = sequelize.define('user', ...);

User.findAll({
  where: {
    name: 'John Doe',
  },
  options: {
    logging: false,
  },
});

環境変数を使用する

NODE_ENV=production node index.js

注意事項

• ログ出力抑制は、開発中はデバッグを困難にする可能性があります。
• ログ出力抑制は、パフォーマンスの向上に役立つ可能性がありますが、その効果は状況によって異なります。

Sequelizeでクエリ実行時のSQLログ出力を抑制するその他の方法

silentオプションを使用する

const sequelize = new Sequelize(...);

sequelize.query('SELECT * FROM users', {
  silent: true,
});

debugプロパティを使用する

SequelizeのSequelizeクラスには、debugプロパティがあります。このプロパティにfalseを設定することで、すべてのログ出力を抑制できます。

const sequelize = new Sequelize(...);

sequelize.debug = false;

sequelize.query('SELECT * FROM users');

独自のロガーを使用する

Sequelizeは、独自のロガーを使用することができます。独自のロガーを使用することで、ログ出力フォーマットや出力先を自由に設定できます。

const sequelize = new Sequelize(...);

const logger = {
  log: (sql) => {
    // 独自の処理
  },
};

sequelize.options.logger = logger;

sequelize.query('SELECT * FROM users');