Sequelize CLI自定义配置指南：环境变量和选项参数详解

Sequelize CLI自定义配置指南：环境变量和选项参数详解

【免费下载链接】cli The Sequelize CLI 项目地址: https://gitcode.com/gh_mirrors/cli10/cli

Sequelize CLI 是管理 Sequelize 项目的强大工具，通过灵活的配置系统帮助开发者轻松处理数据库迁移、模型生成等任务。本文将详细介绍如何通过环境变量和选项参数自定义 Sequelize CLI 的行为，让数据库管理更高效、更符合项目需求。

环境变量配置：灵活管理数据库连接

环境变量是配置 Sequelize CLI 的首选方式，尤其适合在不同环境（开发、测试、生产）中切换配置。Sequelize CLI 支持多种环境变量，覆盖数据库连接的各个方面。

基础环境变量

核心环境变量用于配置数据库连接的基本信息，包括用户名、密码、数据库名等。例如：

• SEQ_USER：数据库用户名，默认值为 root
• SEQ_PW：数据库密码，默认值为 null
• SEQ_DB：数据库名称，默认值为 sequelize_test
• SEQ_HOST：数据库主机地址，默认值为 127.0.0.1
• SEQ_PORT：数据库端口，不同数据库有不同默认值

这些变量在配置文件中通过 process.env 读取，例如 test/support/config/config.js 中的代码：

username: process.env.SEQ_USER || 'root',
password: process.env.SEQ_PW || null,
database: process.env.SEQ_DB || 'sequelize_test',
host: process.env.SEQ_HOST || '127.0.0.1',

数据库类型特定变量

对于不同的数据库类型（如 MySQL、PostgreSQL），Sequelize CLI 提供了专用环境变量，允许更精细的配置。例如 MySQL 的专用变量：

• SEQ_MYSQL_DB：MySQL 数据库名，优先级高于 SEQ_DB
• SEQ_MYSQL_USER：MySQL 用户名，优先级高于 SEQ_USER
• SEQ_MYSQL_PW：MySQL 密码，优先级高于 SEQ_PW
• SEQ_MYSQL_HOST：MySQL 主机地址，优先级高于 SEQ_HOST
• SEQ_MYSQL_PORT：MySQL 端口，优先级高于 SEQ_PORT

PostgreSQL 的专用变量类似，以 SEQ_PG_ 为前缀，如 SEQ_PG_DB、SEQ_PG_USER 等。

连接池配置

连接池参数通过环境变量控制，优化数据库连接性能：

• SEQ_POOL_MAX：最大连接数，默认值为 5
• SEQ_POOL_IDLE：连接空闲时间（毫秒），默认值为 30000

数据库类型特定的连接池变量（如 SEQ_MYSQL_POOL_MAX）优先级高于通用变量。

选项参数：命令行自定义行为

除了环境变量，Sequelize CLI 还支持通过命令行选项参数临时覆盖配置，满足特定场景需求。

配置文件路径

使用 --config 选项指定自定义配置文件路径，覆盖默认配置：

sequelize init --config=./custom-config.js

在测试代码 test/options.test.js 中可以看到类似用法：

.pipe(helpers.runCli('init --config=' + configPath))

数据库连接选项

执行数据库命令时，可以通过选项参数临时指定数据库连接信息，例如：

sequelize db:create --url=mysql://user:pass@localhost:3306/mydb

在 test/db/migrate.test.js 中，通过代码设置配置对象覆盖默认值：

const config = { url: helpers.getTestUrl() };

命令特定选项

不同命令支持不同的选项参数，例如迁移命令支持 --to 指定迁移目标版本，种子命令支持 --seed 指定特定种子文件。这些选项可以在执行命令时临时调整行为，无需修改配置文件。

配置文件结构：深入理解配置加载

Sequelize CLI 的配置文件通常是一个 JavaScript 对象，包含不同环境的配置。默认情况下，配置文件位于项目根目录，也可以通过环境变量 SEQUELIZE_CONFIG 或命令行选项 --config 指定。

默认配置文件示例

配置文件的基本结构如下（参考 test/support/config/config.js）：

module.exports = {
  username: process.env.SEQ_USER || 'root',
  password: process.env.SEQ_PW || null,
  database: process.env.SEQ_DB || 'sequelize_test',
  host: process.env.SEQ_HOST || '127.0.0.1',
  pool: {
    maxConnections: process.env.SEQ_POOL_MAX || 5,
    maxIdleTime: process.env.SEQ_POOL_IDLE || 30000,
  },
  // 数据库类型特定配置
  mysql: {
    // MySQL 特定配置
  },
  postgres: {
    // PostgreSQL 特定配置
  }
};

环境变量与配置文件的优先级

配置加载的优先级从高到低为：

1. 命令行选项参数（如 --url、--config）
2. 数据库类型特定环境变量（如 SEQ_MYSQL_DB）
3. 通用环境变量（如 SEQ_DB）
4. 配置文件中的默认值

这种优先级机制确保了配置的灵活性，既可以通过环境变量进行全局配置，也可以通过命令行选项临时调整。

实战示例：配置 Sequelize CLI 连接 MySQL

以下是一个完整的示例，展示如何通过环境变量和选项参数配置 Sequelize CLI 连接 MySQL 数据库。

设置环境变量

在终端中设置环境变量：

export SEQ_USER=myuser
export SEQ_PW=mypassword
export SEQ_DB=mydatabase
export SEQ_HOST=mysql.example.com
export SEQ_PORT=3306
export SEQ_POOL_MAX=10

执行数据库命令

使用配置的环境变量创建数据库：

sequelize db:create

临时覆盖配置

如需临时连接到不同的数据库，可以使用 --url 选项：

sequelize db:create --url=mysql://tempuser:temppass@localhost:3306/tempdb

总结

Sequelize CLI 提供了强大的配置系统，通过环境变量和选项参数可以灵活定制数据库连接和命令行为。掌握这些配置方法，能够帮助开发者在不同环境中高效管理 Sequelize 项目，提升开发效率。

通过合理使用环境变量（如 SEQ_USER、SEQ_DB）和命令行选项（如 --config、--url），可以轻松应对各种复杂的数据库配置需求。配置文件 test/support/config/config.js 是学习配置结构的重要参考，建议开发者深入理解其内容，以便更好地自定义自己的项目配置。

【免费下载链接】cli The Sequelize CLI 项目地址: https://gitcode.com/gh_mirrors/cli10/cli