如何在构建时修改DACPAC模型？BuildContributor改表未生效问题

你的问题出在用DDL脚本直接调用AddObjects()的方式不对——AddObjects()是用来向模型中添加全新的对象（比如新表、新视图），而不是修改已存在的表结构。要修改现有表，你需要直接操作模型中的表对象，手动添加列定义。

正确的实现步骤 #

下面是修改后的代码，核心是直接操作Table对象的列集合，而不是执行ALTER语句：

using Microsoft.SqlServer.Dac.Deployment;
using Microsoft.SqlServer.Dac.Extensibility;
using Microsoft.SqlServer.Dac.Model;
using System.Collections.Generic;
using System.Linq;

namespace MyNamespace
{
    [ExportBuildContributor("MyNamespace.MyBuildContributor", "1.0.0.0")]
    public class MyBuildContributor : BuildContributor
    {
        protected override void OnExecute(BuildContributorContext context, IList<ExtensibilityError> messages)
        {
            // 获取所有用户定义的表
            var tables = context.Model.GetObjects(DacQueryScopes.UserDefined, ModelSchema.Table);
            
            foreach (var table in tables)
            {
                var tableName = table.Name.Parts.Last();
                
                // 先检查表是否已经有rowid列，避免重复添加
                var hasRowId = table.GetReferenced(Table.Columns)
                                   .Any(col => col.Name.Parts.Last().Equals("rowid", System.StringComparison.OrdinalIgnoreCase));
                
                if (hasRowId)
                {
                    messages.Add(new ExtensibilityError($"表 {tableName} 已存在rowid列，跳过修改", ExtensibilityErrorSeverity.Warning));
                    continue;
                }

                // 创建新的列对象
                var rowIdColumn = context.Model.AddObject(table.Name, "rowid", ModelSchema.Column);
                
                // 设置列的数据类型为UniqueIdentifier
                rowIdColumn.SetProperty(Column.DataType, SqlDataType.UniqueIdentifier);
                
                // 将列关联到表的Columns集合
                table.AddReference(Table.Columns, rowIdColumn);
                
                messages.Add(new ExtensibilityError($"已为表 {tableName} 添加rowid列", ExtensibilityErrorSeverity.Informational));
            }
        }
    }
}

关键说明 #

• 操作模型对象而非SQL脚本：直接通过AddObject创建列，再通过AddReference关联到目标表，这样修改会直接写入DACPAC的model.xml中。
• 重复检查：添加列前先判断是否已存在，避免构建时出现重复定义的错误。
• 属性设置：通过SetProperty指定列的数据类型，确保模型定义的正确性。

额外验证步骤 #

修改代码后，还要确保你的BuildContributor被正确配置到SQL项目中：

• 在你的.sqlproj文件中添加以下配置（如果还没加）：

  <PropertyGroup>
    <BuildContributors>MyNamespace.MyBuildContributor, MyAssemblyName</BuildContributors>
  </PropertyGroup>
  

• 构建项目时，查看输出日志，确认MyBuildContributor被执行（可以通过代码中添加的messages日志来验证）。

这样修改后，重新构建项目，打开bin\Debug\MyDb.dacpac的model.xml，就能看到每个表都添加了rowid列的定义了。

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