EF Core迁移执行外部SQL文件时的引号语法错误排查

问题原因 #

你用$"EXEC(N'{sqlScript}')"拼接动态SQL执行脚本时，脚本内容里的**换行符、隐含的特殊字符（比如注释里的格式符号）**会直接破坏动态字符串的结构。比如SET ANSI_NULLS ON这类语句前的换行，会让SQL Server判定动态字符串在换行处被截断，进而触发引号未闭合的语法错误。另外，当脚本内容较长时，这种拼接方式还可能超出SQL Server对动态字符串的长度限制。

解决办法 #

1. 直接使用migrationBuilder.Sql()执行脚本（推荐） #

EF Core的Sql()方法本身支持直接执行完整SQL脚本，不需要额外套EXEC包裹。直接把读取到的脚本内容传入即可：

var sqlPath = Path.Combine(AppContext.BaseDirectory, "Migrations/scripts/x1.sql");
var sqlScript = File.ReadAllText(sqlPath);
migrationBuilder.Sql(sqlScript);

这种方式会直接将脚本发送到数据库执行，完全规避了动态字符串拼接带来的转义问题。

2. 若必须使用动态SQL，正确转义特殊字符 #

如果因为特殊场景一定要用EXEC执行动态SQL，需要对脚本里的单引号进行转义（SQL Server中用两个单引号表示一个单引号），同时处理换行符：

var sqlScript = File.ReadAllText(sqlPath);
// 转义单引号并替换换行符，避免字符串截断
var escapedScript = sqlScript.Replace("'", "''").Replace(Environment.NewLine, " ");
migrationBuilder.Sql($"EXEC(N'{escapedScript}')");

⚠️ 注意：这种方式仅适用于简单脚本，复杂脚本（比如包含多行注释、特殊符号）容易出现漏转义的情况，不推荐作为首选方案。

3. 嵌入式资源加载脚本（避免路径问题） #

如果部署时存在脚本路径找不到的情况，可以把SQL脚本设置为嵌入式资源，通过程序集读取：

var assembly = System.Reflection.Assembly.GetExecutingAssembly();
// 命名空间要和脚本的实际路径对应
using var stream = assembly.GetManifestResourceStream("YourProjectName.Migrations.scripts.x1.sql");
using var reader = new StreamReader(stream);
var sqlScript = reader.ReadToEnd();
migrationBuilder.Sql(sqlScript);

需要在项目文件中把脚本的Build Action设置为Embedded Resource。

额外检查点 #

• 先把x1.sql/x0.sql脚本复制到SSMS中执行一遍，确认脚本本身没有语法错误，排除脚本自身的问题。
• 脚本开头的SET ANSI_NULLS ON、SET QUOTED_IDENTIFIER ON等会话设置，EF Core会自动处理，不需要手动添加（添加了也不会报错，但可以简化脚本）。

内容的提问来源于stack exchange，提问作者Green Grasso Holm