Sequelize 使用中如何配置 query logging

Sequelize 是一个基于 Node.js 的 ORM（对象关系映射）框架，可以方便地操作数据库。在实际开发中，我们经常需要查看 SQL 查询语句，以便优化数据库性能或者调试代码。Sequelize 提供了 query logging 功能，可以将执行的 SQL 查询语句输出到控制台或者文件中。

本文将介绍 Sequelize 的 query logging 功能，包括如何配置、如何输出到控制台或者文件中，并提供详细的示例代码。

配置 query logging

在 Sequelize 中，可以通过设置 logging 选项来开启 query logging 功能。logging 选项可以是一个函数或者一个布尔值。当 logging 选项为函数时，Sequelize 会将执行的 SQL 查询语句作为参数传入该函数中；当 logging 选项为布尔值时，Sequelize 会将执行的 SQL 查询语句输出到控制台中。

下面是一个简单的示例，演示如何开启 query logging 功能：

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql',
  logging: true  // 开启 query logging 功能
});

在上面的示例中，我们将 logging 选项设置为 true，表示开启 query logging 功能。当执行 SQL 查询语句时，Sequelize 会将查询语句输出到控制台中。

输出到控制台

如果将 logging 选项设置为 true，Sequelize 会将执行的 SQL 查询语句输出到控制台中。下面是一个示例，演示如何将查询语句输出到控制台：

// www.javascriptcn.com code example
const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql',
  logging: true  // 将查询语句输出到控制台中
});

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

(async () => {
  await sequelize.sync();
  const users = await User.findAll();
  console.log(users);
})();

在上面的示例中，我们定义了一个 User 模型，并使用 findAll() 方法查询所有用户。由于 logging 选项为 true，Sequelize 会将查询语句输出到控制台中。

输出到文件

除了将查询语句输出到控制台中，还可以将查询语句输出到文件中。可以通过设置 logging 选项为一个输出流来实现。下面是一个示例，演示如何将查询语句输出到文件中：

// www.javascriptcn.com code example
const Sequelize = require('sequelize');
const fs = require('fs');
const sequelize = new Sequelize('database', 'username', 'password', {
  dialect: 'mysql',
  logging: fs.createWriteStream('query.log')  // 将查询语句输出到文件中
});

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

(async () => {
  await sequelize.sync();
  const users = await User.findAll();
  console.log(users);
})();

在上面的示例中，我们将 logging 选项设置为一个输出流，将查询语句输出到名为 query.log 的文件中。当执行 SQL 查询语句时，Sequelize 会将查询语句输出到文件中。

结语

本文介绍了 Sequelize 的 query logging 功能，包括如何配置、如何输出到控制台或者文件中，并提供了详细的示例代码。通过使用 query logging 功能，我们可以方便地查看执行的 SQL 查询语句，以便优化数据库性能或者调试代码。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d289d0a941bf71344cc955