SqlSugar 使用 ODBC 连接 SQL Server 存储过程的注意事项

在使用 SqlSugar ORM 框架通过 ODBC 连接 SQL Server 数据库时，调用存储过程可能会遇到无法返回查询数据的问题。本文将详细分析该问题的原因，并提供解决方案。

问题现象

开发者在使用 SqlSugar 的 API 调用存储过程时，发现以下两种调用方式存在差异：

// 方式一：使用 SqlQuery 无法返回数据
db.Ado.UseStoredProcedure().SqlQuery<customer>("getcustomer", new { id= "1000"});

// 方式二：使用 GetDataTable 可以返回数据
db.Ado.UseStoredProcedure().GetDataTable("getcustomer", new { type = "update_status_d1", doc_no = tlNumber });

根本原因

经过分析，这个问题与 ODBC 驱动对存储过程的处理方式有关。在 ODBC 连接方式下：

1. SqlSugar 的 UseStoredProcedure 方法底层会设置 CommandType 为存储过程，但 ODBC 驱动对存储过程的调用格式有特殊要求
2. ODBC 标准调用存储过程的格式应为：{CALL sp_name(?,?)}，其中问号代表参数
3. SqlSugar 无法直接控制 ODBC 驱动的参数格式转换

解决方案

针对这个问题，推荐以下几种解决方案：

方案一：使用直接执行 SQL 的方式

// 使用 exec 语法直接调用存储过程
db.Ado.SqlQuery<customer>("exec getcustomer @id=@p0", new { p0 = "1000" });

// 或者使用参数化查询
db.Ado.SqlQuery<customer>("exec getcustomer @id=@id", new { id = "1000" });

方案二：使用 ODBC 的标准 CALL 语法

// 使用 ODBC 的标准 CALL 语法
db.Ado.SqlQuery<customer>("{CALL getcustomer(?)}", new { p0 = "1000" });

方案三：使用 GetDataTable 方法

如果只需要获取数据表而不需要强类型映射，可以使用 GetDataTable 方法：

var dt = db.Ado.GetDataTable("getcustomer", new { id = "1000" });

技术建议

1. 连接方式选择：如果可能，建议优先使用 SqlClient 而不是 ODBC 连接 SQL Server，因为 SqlClient 对 SQL Server 有更好的支持

2. 参数处理：在使用 ODBC 时，注意参数传递的格式和顺序必须与存储过程定义严格匹配

3. 调试技巧：可以通过 SqlSugar 的 AOP 功能记录实际执行的 SQL，帮助排查问题

db.Aop.OnLogExecuting = (sql, pars) => 
{
    Console.WriteLine(sql); // 输出执行的SQL
};

总结

在使用 SqlSugar 通过 ODBC 连接 SQL Server 调用存储过程时，由于 ODBC 驱动的特殊性，直接使用 UseStoredProcedure 可能会遇到问题。建议采用直接执行 SQL 语句的方式调用存储过程，或者使用 ODBC 的标准 CALL 语法。理解底层驱动的工作原理有助于更好地解决这类数据库访问问题。