Azure Synapse部署DacPac后外部文件FORMAT_OPTIONS丢失求解决方案

问题背景 #

在针对Azure Synapse Analytics Serverless SQL Pool的SQL项目中，定义了包含FIRST_ROW和USE_TYPE_DEFAULT选项的外部文件格式：

CREATE EXTERNAL FILE FORMAT [SynapseDelimitedTextFormat]
WITH (
FORMAT_TYPE = DELIMITEDTEXT,
FORMAT_OPTIONS (FIELD_TERMINATOR = N';', FIRST_ROW = 2, USE_TYPE_DEFAULT = False)
);

但通过SqlAzureDacpacDeployment@1部署DacPac后，数据库中的文件格式丢失了这两个选项，仅保留：

CREATE EXTERNAL FILE FORMAT [SynapseDelimitedTextFormat]
WITH (
FORMAT_TYPE = DELIMITEDTEXT,
FORMAT_OPTIONS (FIELD_TERMINATOR = N';')
);

同时Visual Studio架构对比时也无法识别这两个选项，已向微软反馈该Bug，现提供紧急变通方案：

变通方案 #

1. 使用Post-Deployment脚本补全配置 #

在SQL项目中添加Post-Deployment脚本，部署完成后自动执行ALTER语句补全缺失的选项：

• 右键SQL项目 → 添加 → 新建项 → 选择“SQL脚本”，命名为PostDeploy_FileFormatFix.sql
• 将脚本内容设置为：

ALTER EXTERNAL FILE FORMAT [SynapseDelimitedTextFormat]
WITH (
    FORMAT_OPTIONS (
        FIRST_ROW = 2,
        USE_TYPE_DEFAULT = False
    )
);

• 在脚本属性中，设置“生成操作”为PostDeploy

如果担心重复执行报错，可以添加存在性判断：

IF NOT EXISTS (
    SELECT 1 FROM sys.external_file_formats
    WHERE name = 'SynapseDelimitedTextFormat'
    AND format_type = 1 -- DELIMITEDTEXT对应的类型值
    AND first_row = 2
    AND use_type_default = 0 -- False对应0
)
BEGIN
    ALTER EXTERNAL FILE FORMAT [SynapseDelimitedTextFormat]
    WITH (
        FORMAT_OPTIONS (
            FIRST_ROW = 2,
            USE_TYPE_DEFAULT = False
        )
    );
END

2. 绕过DacPac，直接执行CREATE语句 #

如果项目部署流程允许，放弃DacPac打包，改用SqlAzureDacpacDeployment@1任务的SqlCommand模式，直接运行完整的CREATE EXTERNAL FILE FORMAT语句：

• 在Azure DevOps流水线中，将SqlAzureDacpacDeployment@1的DeploymentAction设置为SqlTask
• 在SqlFile或InlineSql中填入完整的创建语句，确保所有选项都被包含

这种方式可以完全避免DacPac对选项的截断问题，直接将完整配置写入数据库。

3. 手动编辑SQL项目模型文件（进阶） #

如果前两种方案不适用，可以尝试手动修改SQL项目的.sqlproj文件，确保模型正确识别这两个属性：

• 找到项目中对应外部文件格式的.sql文件条目，添加对应的属性元素：

<ItemGroup>
  <Build Include="ExternalFileFormats\SynapseDelimitedTextFormat.sql">
    <FirstRow>2</FirstRow>
    <UseTypeDefault>False</UseTypeDefault>
  </Build>
</ItemGroup>

注意：这种方式需要确认SQL项目模型是否支持这些自定义属性，可能存在兼容性问题，建议仅在必要时使用。

内容的提问来源于stack exchange，提问作者FS'Wæhre