Статья
09/28/2010

Объект SqlPipe

В предыдущих версиях SQL Server очень часто приходилось писать хранимую процедуру (или расширенную хранимую процедуру) для отправки результатов или выходных параметров вызывающему клиенту.

В хранимой процедуре Transact-SQL любая инструкция SELECT, которая возвращает ноль или более строк, отправляет результаты в «канал» подключенного вызывающего.

Результаты по объектам базы данных CLR, работающей на SQL Server, могут отправляться в подключенный канал при помощи методов Send объекта SqlPipe. Обратитесь к свойству Pipe объекта SqlContext, чтобы получить объект SqlPipe. Класс SqlPipe концептуально похож на класс Response в ASP.NET. Дополнительные сведения см. в справочной документации по классу SqlPipe в пакете средств разработки программного обеспечения .NET Framework.

Возврат табличных результатов и сообщений

Класс SqlPipe имеет метод Send, который имеет три перегрузки. Они перечислены ниже.

void Send(string message)
void Send(SqlDataReader reader)
void Send(SqlDataRecord record)

Метод Send пересылает данные напрямую клиенту или вызывающему. Обычно клиент использует выход из SqlPipe, но в случае вложенных хранимых процедур CLR потребителем выхода также может быть хранимая процедура. Например, Procedure1 вызывает SqlCommand.ExecuteReader() с текстом команды «EXEC Procedure2». Procedure2 — это также управляемая хранимая процедура. Если Procedure2 вызывает SqlPipe.Send( SqlDataRecord ), строка передается модулю чтения Procedure1, но не клиенту.

Метод Send посылает строку сообщения, которая отображается на клиенте как информационное сообщение, эквивалентное PRINT в Transact-SQL. Метод может также послать однострочный результирующий набор с помощью SqlDataRecord или многострочный результирующий набор с использованием SqlDataReader.

Объект SqlPipe также имеет метод ExecuteAndSend. Этот метод можно использовать, чтобы выполнять команды (переданные как объект SqlCommand) и напрямую отправлять результаты назад вызывающему. Если в представленной команде есть ошибки, исключения передаются в канал, но копия пересылается также вызывающему управляемому коду. Если вызывающий код не перехватывает исключение, оно распространяется по стеку в код Transact-SQL и дважды появляется в выходе. Если вызывающий код перехватывает исключение, потребитель канала по-прежнему видит ошибку, но повторяющейся ошибки нет.

Он может принять только команду SqlCommand, которая ассоциирована с контекстным соединением. Этот метод не может принять команду, которая ассоциирована с соединением вне данного контекста.

Возвращение пользовательских результирующих наборов

Управляемые хранимые процедуры могут отправлять результирующие наборы, которые не исходят из SqlDataReader. Метод SendResultsStart вместе с методами SendResultsRow и SendResultsEnd позволяет хранимым процедурам отправлять клиенту пользовательские результирующие наборы.

Метод SendResultsStart принимает объект SqlDataRecord в качестве ввода. Он отмечает начало результирующего набора и при помощи метаданных записи составляет метаданные, описывающие результирующий набор. Он не отправляет значение записи с SendResultsStart. Все последующие строки, отправленные при помощи метода SendResultsRow, должны соответствовать этому определению метаданных.

Примечание
После вызова метода SendResultsStart можно вызвать только методы SendResultsRow и SendResultsEnd. Вызов любого другого метода в том же экземпляре объекта SqlPipe приводит к исключению InvalidOperationException. Метод SendResultsEnd возвращает объект SqlPipe в исходное состояние, в котором можно вызывать другие методы.

После вызова метода SendResultsStart можно вызвать только методы SendResultsRow и SendResultsEnd. Вызов любого другого метода в том же экземпляре объекта SqlPipe приводит к исключению InvalidOperationException. Метод SendResultsEnd возвращает объект SqlPipe в исходное состояние, в котором можно вызывать другие методы.

Примеры

Хранимая процедура uspGetProductLine возвращает название, номер продукта, цвет и цену по прейскуранту всех продуктов в указанной линейке продуктов. Эта хранимая процедура принимает точные совпадения с prodLine.

using System;
using System.Data;
using System.Data.SqlClient;
using System.Data.SqlTypes;
using Microsoft.SqlServer.Server;

public partial class StoredProcedures
{
[Microsoft.SqlServer.Server.SqlProcedure]
public static void uspGetProductLine(SqlString prodLine)
{
    // Connect through the context connection.
    using (SqlConnection connection = new SqlConnection("context connection=true"))
    {
        connection.Open();

        SqlCommand command = new SqlCommand(
            "SELECT Name, ProductNumber, Color, ListPrice " +
            "FROM Production.Product " + 
            "WHERE ProductLine = @prodLine;", connection);

        command.Parameters.AddWithValue("@prodLine", prodLine);

        try
        {
            // Execute the command and send the results to the caller.
            SqlContext.Pipe.ExecuteAndSend(command);
        }
        catch (System.Data.SqlClient.SqlException ex)
        {
            // An error occurred executing the SQL command.
        }
     }
}
};

Visual Basic

Imports System
Imports System.Data
Imports System.Data.SqlClient
Imports System.Data.SqlTypes
Imports Microsoft.SqlServer.Server

Partial Public Class StoredProcedures
<Microsoft.SqlServer.Server.SqlProcedure()> _
Public Shared Sub uspGetProductLine(ByVal prodLine As SqlString)
    Dim command As SqlCommand

    ' Connect through the context connection.
    Using connection As New SqlConnection("context connection=true")
        connection.Open()

        command = New SqlCommand( _
        "SELECT Name, ProductNumber, Color, ListPrice " & _
        "FROM Production.Product " & _
        "WHERE ProductLine = @prodLine;", connection)
        command.Parameters.AddWithValue("@prodLine", prodLine)

        Try
            ' Execute the command and send the results 
            ' directly to the caller.
            SqlContext.Pipe.ExecuteAndSend(command)
        Catch ex As System.Data.SqlClient.SqlException
            ' An error occurred executing the SQL command.
        End Try
    End Using
End Sub
End Class

Следующая инструкция Transact-SQL выполняет процедуру uspGetProduct, которая возвращает список продуктов, относящихся к категории туристических велосипедов.