如何从.net代码将表值参数传递给存储过程

Posted 2023-02-15

【中文标题】如何从.net代码将表值参数传递给存储过程

【英文标题】：How to pass table value parameters to stored procedure from .net code

【发布时间】：2011-08-01 12:11:48

【问题描述】：

我有一个 SQL Server 2005 数据库。在一些过程中，我将表参数作为nvarchar（用逗号分隔）传递给存储过程，并在内部分为单个值。我将它添加到 SQL 命令参数列表中，如下所示：

cmd.Parameters.Add("@Logins", SqlDbType.NVarchar).Value = "jim18,jenny1975,cosmo";

我必须将数据库迁移到SQL Server 2008。我知道有表值参数，并且我知道如何在存储过程中使用它们。但我不知道如何将一个传递给 SQL 命令中的参数列表。

有人知道Parameters.Add 过程的正确语法吗？或者还有其他方法可以传递这个参数吗？

【问题讨论】：

查看此解决方案：EF 中具有表值参数的存储过程。 code.msdn.microsoft.com/Stored-Procedure-with-6c194514

在这种情况下，我通常连接字符串并在服务器端拆分它们，或者如果我有多个列，甚至传递一个 xml。 Sql 在处理 xml 时非常快。您可以尝试所有方法并检查处理时间，然后选择最佳方法。 XML 看起来像 ...。 Sql Server 上的过程也很简单。使用此方法，如果您需要更多信息，您可以随时向 添加新属性。

@NițuAlexandru，“处理 xml 时，Sql 非常快。”。甚至没有关闭。

【参考方案1】：

DataTable、DbDataReader 或 IEnumerable<SqlDataRecord> 对象可用于根据 MSDN 文章 Table-Valued Parameters in SQL Server 2008 (ADO.NET) 填充表值参数。

以下示例说明了如何使用DataTable 或IEnumerable<SqlDataRecord>：

SQL 代码：

CREATE TABLE dbo.PageView
(
    PageViewID BIGINT NOT NULL CONSTRAINT pkPageView PRIMARY KEY CLUSTERED,
    PageViewCount BIGINT NOT NULL
);
CREATE TYPE dbo.PageViewTableType AS TABLE
(
    PageViewID BIGINT NOT NULL
);
CREATE PROCEDURE dbo.procMergePageView
    @Display dbo.PageViewTableType READONLY
AS
BEGIN
    MERGE INTO dbo.PageView AS T
    USING @Display AS S
    ON T.PageViewID = S.PageViewID
    WHEN MATCHED THEN UPDATE SET T.PageViewCount = T.PageViewCount + 1
    WHEN NOT MATCHED THEN INSERT VALUES(S.PageViewID, 1);
END

C# 代码：

private static void ExecuteProcedure(bool useDataTable, 
                                     string connectionString, 
                                     IEnumerable<long> ids) 

    using (SqlConnection connection = new SqlConnection(connectionString)) 
    
        connection.Open();
        using (SqlCommand command = connection.CreateCommand()) 
        
            command.CommandText = "dbo.procMergePageView";
            command.CommandType = CommandType.StoredProcedure;

            SqlParameter parameter;
            if (useDataTable) 
                parameter = command.Parameters
                              .AddWithValue("@Display", CreateDataTable(ids));
            
            else 
            
                parameter = command.Parameters
                              .AddWithValue("@Display", CreateSqlDataRecords(ids));
            
            parameter.SqlDbType = SqlDbType.Structured;
            parameter.TypeName = "dbo.PageViewTableType";

            command.ExecuteNonQuery();
        
    


private static DataTable CreateDataTable(IEnumerable<long> ids) 

    DataTable table = new DataTable();
    table.Columns.Add("ID", typeof(long));
    foreach (long id in ids) 
    
        table.Rows.Add(id);
    
    return table;


private static IEnumerable<SqlDataRecord> CreateSqlDataRecords(IEnumerable<long> ids) 

    SqlMetaData[] metaData = new SqlMetaData[1];
    metaData[0] = new SqlMetaData("ID", SqlDbType.BigInt);
    SqlDataRecord record = new SqlDataRecord(metaData);
    foreach (long id in ids) 
    
        record.SetInt64(0, id);
        yield return record;
    

【讨论】：

+1 很好的例子。要点是：发送一个DataTable作为参数值，将SqlDbType设置为Structured，将TypeName设置为数据库UDT名称。

如果您要在循环中重用引用类型的实例（在您的示例中为 SqlDataRecord），请添加评论说明为什么在此特定实例中这样做是安全的。跨度>

此代码错误：空表值参数应将其值设置为null。如果给定一个空的 ids 参数，CreateSqlDataRecords 将永远不会返回 null。

@Crono: DataTable（或DataSet）只实现它，因为他们必须在Visual-Studio中支持拖放功能，所以他们实现了IComponent，它实现了IDisposable。如果您不使用设计器而是手动创建它，则没有理由处置它（或使用using-statement）。所以这是黄金法则“处置所有实现IDisposable”的例外之一。

未来用户，请注意：DataTable 方法会消耗大量内存，而IEnumerable 则不会。

【参考方案2】：

除了 Ryan 的回答之外，如果您正在处理带有 多个 列的序号为 not 按字母顺序排列。

例如，如果您有以下表值用作 SQL 中的参数：

CREATE TYPE NodeFilter AS TABLE (
  ID int not null
  Code nvarchar(10) not null,
);

您需要在 C# 中对列进行排序：

table.Columns["ID"].SetOrdinal(0);
// this also bumps Code to ordinal of 1
// if you have more than 2 cols then you would need to set more ordinals

如果你不这样做，你会得到一个解析错误，无法将 nvarchar 转换为 int。

【参考方案3】：

通用

   public static DataTable ToTableValuedParameter<T, TProperty>(this IEnumerable<T> list, Func<T, TProperty> selector)
    
        var tbl = new DataTable();
        tbl.Columns.Add("Id", typeof(T));

        foreach (var item in list)
        
            tbl.Rows.Add(selector.Invoke(item));

        

        return tbl;

    

【讨论】：

您能告诉我我应该传递什么作为参数吗？ Func 选择器？不能只是简单的 tbl.Rows.Add(item) 而不需要那个参数。

selector.Invoke(item) 在大多数情况下选择项目上的属性，它是一个 int，但它也允许您选择一个字符串属性

您能否提供一个示例，说明如何将选择器放在那里？我有一个 List 要传递给存储过程...

guidList.ToTabledValuedParameter(x=>x)，由于 x 是您的情况下的 guid，因此返回将是一个 DataTable，其中有一列（id）和一个 guid 列表，

【参考方案4】：

使用它的最简洁的方式。假设您的表格是一个名为“dbo.tvp_Int”的整数列表（为您自己的表格类型定制）

创建这个扩展方法...

public static void AddWithValue_Tvp_Int(this SqlParameterCollection paramCollection, string parameterName, List<int> data)

   if(paramCollection != null)
   
       var p = paramCollection.Add(parameterName, SqlDbType.Structured);
       p.TypeName = "dbo.tvp_Int";
       DataTable _dt = new DataTable() Columns = "Value";
       data.ForEach(value => _dt.Rows.Add(value));
       p.Value = _dt;
   

现在您可以通过以下方式在任意位置的一行中添加一个表值参数：

cmd.Parameters.AddWithValueFor_Tvp_Int("@IDValues", listOfIds);

【讨论】：

如果 paramCollection 为 NULL 怎么办？如何传递空类型？

@Muflix 隐晦地，扩展方法实际上对空实例起作用。所以在方法顶部添加一个简单的if(paramCollection != null)检查就可以了

使用初始 -if- check 更新答案

可能有点迂腐，但我会在签名中使用IEnumerable 而不是List，这样你就可以传递IEnumerable 的任何内容，而不仅仅是列表，因为你是没有使用List 特有的任何功能，我真的没有理由不使用IEnumerable

Using List 允许您使用简写 data.ForEach()，否则您必须实际编写一个 foreach 循环。这也可以，但我喜欢写尽可能短的东西。

【参考方案5】：

使用此代码根据您的类型创建合适的参数：

private SqlParameter GenerateTypedParameter(string name, object typedParameter)

    DataTable dt = new DataTable();

    var properties = typedParameter.GetType().GetProperties().ToList();
    properties.ForEach(p =>
    
        dt.Columns.Add(p.Name, Nullable.GetUnderlyingType(p.PropertyType) ?? p.PropertyType);
    );
    var row = dt.NewRow();
    properties.ForEach(p =>  row[p.Name] = (p.GetValue(typedParameter) ?? DBNull.Value); );
    dt.Rows.Add(row);

    return new SqlParameter
    
        Direction = ParameterDirection.Input,
        ParameterName = name,
        Value = dt,
        SqlDbType = SqlDbType.Structured
    ;