如何在DACPAC SQL Server项目中嵌入表值函数SQL脚本

文件夹结构与命名规范 #

SSDT（SQL Server Data Tools，也就是DACPAC项目的底层工具）不会根据文件夹路径识别对象类型，所以没有强制的文件夹命名、层级要求，只要方便团队维护即可，通用的实践规则如下：

• 在项目根目录新建顶层文件夹Functions，所有自定义函数统一放在该目录下
• 如果项目规模大、函数数量多，可以在Functions下追加子目录：比如建Table-Valued Functions子文件夹专门存表值函数，建Scalar-Valued Functions存标量函数；也可以按业务模块划分子目录，完全不影响DACPAC的编译和部署
• 单个SQL文件直接以函数名命名即可，比如函数全称为dbo.GetOrderStatistics，文件名就设为GetOrderStatistics.sql，不要加多余的前缀后缀，和数据库内对象名保持一致，后续查找维护方便。

SQL文件导入与配置步骤 #

• 在解决方案资源管理器里，右键点击你建好的目标存放文件夹，选择「添加」-「现有项」，选中本地已经写好的表值函数SQL脚本，导入到项目中
• 打开导入的SQL文件，调整脚本格式符合SSDT编译要求：脚本核心必须是标准的CREATE FUNCTION语句，不要在脚本开头写USE [数据库名]这类切换数据库的语句，DACPAC部署时会自动匹配目标连接的数据库，加USE语句大概率会导致编译报错或者部署异常。标准的表值函数脚本结构参考：

CREATE FUNCTION [dbo].[你的函数名]
(
    -- 填入函数入参定义，例：@QueryDate DATE, @ShopId INT
)
RETURNS TABLE
AS
RETURN
(
    -- 填入函数返回的查询逻辑
    SELECT Col1, Col2 FROM dbo.SomeTable WHERE CreateDate >= @QueryDate
)

小提示：如果需要做存在性判断，不要自己写IF EXISTS DROP FUNCTION逻辑，直接在文件属性里开启「当对象已存在时生成DROP语句」即可，SSDT会在部署时自动处理判断逻辑，避免脚本顺序导致的部署错误。

• 选中导入的SQL文件，打开属性面板（右下角默认显示，没显示就右键文件选「属性」），确认默认配置即可，不需要额外修改：
  • 生成操作：Build
  • 复制到输出目录：不复制

配置有效性验证 #

右键项目名称选择「生成」，查看输出窗口的编译日志，如果没有和该函数相关的语法错误、依赖对象不存在的错误，就说明配置已经生效。编译完成后在项目输出目录（默认是bin/对应编译配置文件夹）下的dacpac包就已经包含了这个表值函数，后续部署时会自动在目标库创建该对象。

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