如何在Sequelize中定义SQL Server自定义函数，无需手动创建？

我目前在Node.js里用Sequelize调用SQL Server中手动创建的自定义函数getSomeData，代码如下：

let query = "select * from getSomeData(:StartDate,:EndDate)"; 
let SeqOptions = { 
  replacements: { 
    StartDate : '2015-05-03', 
    EndDate : '2015-05-05', 
  }, 
  type: sequelize.QueryTypes.SELECT 
}; 
let result = await sequelize.query(query , SeqOptions );

但这个函数是手动在SQL里定义的，我想知道能不能直接在Sequelize里声明函数定义，这样重启服务器或者重置数据库时，不用再手动跑脚本创建函数？

当然可以！Sequelize提供了几种实用方式帮你自动管理自定义SQL函数，彻底告别手动创建的麻烦。下面是两种最常用的方案：

方案1：利用启动时执行SQL（适合开发环境） #

你可以在初始化Sequelize实例后，先执行一段检查并创建函数的SQL语句，确保每次服务器启动时函数都存在：

const sequelize = new Sequelize(/* 你的数据库配置参数 */);

// 定义创建函数的SQL（带存在性检查，避免重复创建报错）
const createFunctionSql = `
IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[getSomeData]') AND type in (N'FN', N'IF', N'TF', N'FS', N'FT'))
BEGIN
  CREATE FUNCTION [dbo].[getSomeData](@StartDate DATE, @EndDate DATE)
  RETURNS TABLE
  AS
  RETURN
  (
    -- 这里替换成你的实际函数逻辑
    SELECT * FROM YourTargetTable WHERE DateColumn BETWEEN @StartDate AND @EndDate
  )
END
`;

// 初始化数据库的函数
async function initDb() {
  try {
    // 先确保函数存在
    await sequelize.query(createFunctionSql);
    // 如果需要同步模型结构，可添加这行（根据你的需求选择）
    // await sequelize.sync({ alter: true });
    console.log("函数初始化完成，数据库连接就绪");
  } catch (err) {
    console.error("初始化自定义函数失败:", err);
  }
}

// 启动时执行初始化
initDb();

这里的IF NOT EXISTS判断很关键，它会避免每次启动都尝试创建已存在的函数，防止抛出重复创建的错误。

方案2：使用Sequelize迁移（适合生产环境） #

如果是生产环境，更推荐用**迁移（Migrations）**来管理数据库变更，包括自定义函数。迁移可以跟踪数据库结构的版本变化，还支持回滚操作，非常适合团队协作和部署场景：

1. 首先生成一个迁移文件：

npx sequelize-cli migration:generate --name create-getSomeData-function

2. 在生成的迁移文件中，编写up（创建函数）和down（回滚删除函数）的逻辑：

'use strict';

module.exports = {
  async up(queryInterface, Sequelize) {
    const createFuncSql = `
      CREATE FUNCTION [dbo].[getSomeData](@StartDate DATE, @EndDate DATE)
      RETURNS TABLE
      AS
      RETURN
      (
        -- 你的函数逻辑
        SELECT * FROM YourTargetTable WHERE DateColumn BETWEEN @StartDate AND @EndDate
      )
    `;
    await queryInterface.sequelize.query(createFuncSql);
  },

  async down(queryInterface, Sequelize) {
    const dropFuncSql = `DROP FUNCTION IF EXISTS [dbo].[getSomeData]`;
    await queryInterface.sequelize.query(dropFuncSql);
  }
};

3. 运行迁移，将函数同步到数据库：

npx sequelize-cli db:migrate

后续部署时，只需要运行这条迁移命令就能确保函数存在；如果需要回滚变更，执行npx sequelize-cli db:migrate:undo即可删除函数。

额外小提示 #

• 确保你的数据库账号拥有创建、修改函数的权限，否则会执行失败。
• 如果函数逻辑比较复杂，可以把SQL语句单独存放在一个.sql文件中，通过fs.readFileSync读取后再执行，让代码结构更整洁。

内容的提问来源于stack exchange，提问作者CoderX