Npgsql中使用记录类型作为SQL参数的实践指南

背景介绍

在使用PostgreSQL数据库时，开发者经常会遇到需要将一组复合值作为参数传递给SQL查询的需求。例如，我们可能希望在WHERE子句中使用多个列的组合值进行过滤，而不是单独传递每个列的值。

问题分析

在Npgsql中，当我们尝试将二维数组作为参数传递并用于记录比较时，会遇到"undefined function: record = integer"的错误。这是因为PostgreSQL本身不支持直接将匿名记录类型作为参数接收。

技术解决方案

方案一：使用命名复合类型

1. 在PostgreSQL中定义复合类型： 首先需要在数据库中创建一个命名的复合类型，例如：

   CREATE TYPE my_composite_type AS (colA integer, colB integer);
   

2. 在C#中定义对应类型：

   public class MyCompositeType
   {
       public int ColA { get; set; }
       public int ColB { get; set; }
   }
   

3. 注册类型映射： 在应用程序启动时注册类型映射：

   NpgsqlConnection.GlobalTypeMapper.MapComposite<MyCompositeType>("my_composite_type");
   

4. 使用复合类型数组作为参数：

   var param = new NpgsqlParameter("param", NpgsqlDbType.Array | NpgsqlDbType.Composite)
   {
       Value = new MyCompositeType[] 
       {
           new MyCompositeType { ColA = 0, ColB = 1 },
           new MyCompositeType { ColA = 1, ColB = 2 }
       }
   };
   

方案二：直接嵌入SQL构造

如果不想定义复合类型，可以在SQL语句中直接构造ROW值：

var values = new (int, int)[] { (0, 1), (1, 2) };
var sql = $@"SELECT colA, colB, colC FROM table 
             WHERE (colA, colB) = ANY(ARRAY[{string.Join(",", values.Select(v => $"ROW({v.Item1}, {v.Item2})"))}])";

注意事项：

• 需要确保值来自可信来源或进行适当的参数化处理，避免SQL注入风险
• 这种方法无法利用语句准备(prepared statement)的性能优势

性能考量

使用命名复合类型的方案虽然需要前期配置，但具有以下优势：

1. 支持语句准备，提高重复查询性能
2. 类型安全，编译时检查
3. 代码更清晰，易于维护

最佳实践建议

1. 对于频繁使用的复合查询条件，优先考虑使用命名复合类型方案
2. 对于一次性或简单的查询，可以考虑直接嵌入SQL构造
3. 始终注意SQL注入风险，特别是当使用字符串拼接方式时

通过以上方法，开发者可以灵活地在Npgsql中处理复杂的记录类型参数传递需求。