Передача массива значений в хранимую процедуру SQL Server с помощью XML и Visual Basic .NET

В этой статье показано, как передать массив значений в хранимую процедуру SQL Server с помощью XML и Visual Basic .NET.

Исходная версия продукта: Visual Basic
Исходный номер базы знаний: 555266

Симптомы

Необходимо передать массив значений в хранимую процедуру SQL Server, чтобы использовать ее в качестве списка для IN предложения.

ПРИЧИНА

Текущая версия Microsoft SQL Server не поддерживает тип данных массива, позволяющий передавать массив значений в качестве параметра хранимой процедуры или инструкции SQL. Часто разработчикам требуется передать массив значений для выбора записей на основе предоставленного списка в предложении IN . В некоторых случаях список параметров, передаваемых в хранимую процедуру в виде строки с разделителями-запятыми, и эту строку с разделителями нельзя использовать непосредственно в качестве параметра предложения IN и необходимо преобразовать в форму, приемлемой для использования внутри IN предложения.

Решение

Одним из решений этой проблемы является передача массива значений в хранимую процедуру в качестве параметра строки XML и использование OPENXML rowset поставщика внутри хранимой процедуры для выбора значений из предоставленного XML-кода. OPENXML Использование поставщика в сочетании с инструкциями Transact-SQL обеспечивает гибкий и простой способ управления данными в базе данных на основе переданного массива значений.

Создание проекта

Примечание.

Этот пример не содержит код для обработки исключений, необходимых в приложении уровня рабочей среды.

Мы будем использовать таблицу Northwind Orders из базы данных SQL Server. Чтобы создать хранимую процедуру в Northwind базе данных, используйте следующую сильную процедуру.

IF EXISTS (SELECT name
    FROM sysobjects
    WHERE name = N'sp_SelectOrders'
    AND type = 'P')
    DROP PROCEDURE sp_SelectOrders
GO

CREATE PROC sp_SelectOrders @in_values nText AS

DECLARE @hDoc int

--Prepare input values as an XML documnet
exec sp_xml_preparedocument @hDoc OUTPUT, @in_values

--Select data from the table based on values in XML
SELECT * FROM Orders WHERE CustomerID IN (
 SELECT CustomerID FROM OPENXML (@hdoc, '/NewDataSet/Customers', 1)
 WITH (CustomerID NCHAR(5)))

EXEC sp_xml_removedocument @hDoc

GO

Запустите Visual Studio .NET и создайте консольное приложение. По умолчанию будет создан файл Module1.vb .

Замените сильный внутри файла Module1.vb следующим образом. Чтобы упростить и пример, пример строго выбирает список всех клиентов из таблицы "Клиенты", подготавливает массив значений как XML-строку только для половины клиентов (для демонстрации ограниченного выбора), а затем запускает хранимую процедуру, чтобы выбрать список заказов из таблицы "Заказы" для выбранных клиентов.

Примечание.

Вам потребуется изменить строка подключения в примере строгого использования в вашей среде.

Imports System.Data.SqlClient
Imports System.Xml
Imports System.Text

Module Module1

PublicSub Main()

    Dim loCustomers As DataSet
    Dim loOrders As DataTable
    
    Try
    
        'Get list of the customers from the database
        loCustomers = GetCustomers()
        
        Console.WriteLine("Total customers: " & loCustomers.Tables(0).Rows.Count.ToString)
        
        If Not loCustomers Is Nothing Then
            loOrders = GetOrders(loCustomers)
            Console.WriteLine("Total orders: " & loOrders.Rows.Count.ToString)
        EndIf
        
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        Finally
        
        If Not loCustomers Is Nothing Then
            loCustomers.Dispose()
            loCustomers = Nothing
        EndIf
        
        If Not loOrders Is Nothing Then
            loOrders.Dispose()
            loOrders = Nothing
        EndIf
    
    EndTry

EndSub

Private Function GetOrders(ByVal loCustomers As DataSet) As DataTable

    Dim loOrders As DataSet
    Dim loParameter As SqlParameter
    Dim loCol As DataColumn
    
    Try
    
        'Prepare XML output from the Customers DataSet as a string
        ForEach loCol In loCustomers.Tables("Customers").Columns
            loCol.ColumnMapping = System.Data.MappingType.Attribute
        Next
        
        'Pass XML into the stored procedure as a parameter
        loParameter = New SqlParameter("@in_values", System.Data.SqlDbType.NText)
        loParameter.Value = loCustomers.GetXml
        
        'Get list of the orders from the database
        loOrders = GetDataFromDb("sp_SelectOrders", CommandType.StoredProcedure, "Customers", loParameter)'Return list of the orders as a DataTable
        If (Not loOrders Is Nothing) AndAlso loOrders.Tables.Count = 1 Then
            Return loOrders.Tables(0)
        EndIf
    
    Catch ex As Exception
        Throw ex
    EndTry

EndFunction

Private Function GetCustomers() As DataSet

    Dim loCustomers As DataSet
    Dim i As Int32
    
    Try
    
    'Get list of the customers from the database
    loCustomers = GetDataFromDb("SELECT CustomerID FROM Customers", CommandType.Text, "Customers")'Remove half of the customers for the demo purposes to show that we select info just for some of them
    If Not loCustomers Is Nothing Then
    
    If loCustomers.Tables.Contains("Customers") Then
            With loCustomers.Tables("Customers")
        
        i = .Rows.Count \ 2
        DoWhile .Rows.Count > i
            .Rows.RemoveAt(0)
        Loop
        
        'Accept changes to remove the rows completely from the DataTable
        .AcceptChanges()
        EndWith
        Else
            ThrowNew ApplicationException("Customers table does not exist")
        EndIf
    
    EndIf
    
    'Return list of the customers as a DataSet
    Return loCustomers
    
    Catch ex As Exception
        Throw ex
    EndTry

EndFunction

Private Function GetDataFromDb(ByVal lcSQL AsString, ByVal loCommandType As CommandType, _
ByVal lcTableName AsString, ByValParamArray loParameters() As SqlParameter) As DataSet

    Dim loResult As DataSet
    Dim loConnection As SqlConnection
    Dim loCommand As SqlCommand
    Dim loAdapter As SqlDataAdapter
    Dim i As Int32
    Dim loParameter As SqlParameter
    
    Try
    
        'Create and open connection to the Northwind database
        loConnection = New SqlConnection("Persist Security Info=False;Integrated Security=SSPI;database=northwind;server=(local);Connect Timeout=30")
        loConnection.Open()'Prepare command and to select data from the database
        loCommand = New SqlCommand(lcSQL, loConnection)
        loCommand.CommandType = loCommandType
        
        IfNot loParameters IsNothingThen
        ForEach loParameter In loParameters
        loCommand.Parameters.Add(loParameter)
        Next
        EndIf
        
        loAdapter = New SqlDataAdapter(loCommand)
        
        loResult = New DataSet
        loAdapter.Fill(loResult, lcTableName)'Return list of the customers as a DataSet
        Return loResult
    
    Catch ex As Exception
        Throw ex
    Finally
    
        'Clean resources
        If Not loAdapter Is Nothing Then
            loAdapter.Dispose()
            loAdapter = Nothing
        EndIf
        
        If Not loCommand Is Nothing Then
            loCommand.Dispose()
            loCommand = Nothing
        EndIf
        
        If Not loConnection Is Nothing Then
        
            If loConnection.State = ConnectionState.Open Then
                loConnection.Close()
            EndIf
            
            loConnection.Dispose()
            loConnection = Nothing
        
        EndIf
    EndTry

  EndFunction

EndModule

Нажмите клавишу F5 , чтобы скомпилировать и запустить приложение. Консоль отобразит результаты.