Oggetto SqlPipe

Si applica a: SQL Server

Nelle versioni precedenti di SQL Server, è molto comune scrivere una stored procedure (o una stored procedure estesa) che invia i risultati o i parametri di output al client chiamante.

In una stored procedure Transact-SQL, qualsiasi istruzione SELECT che restituisce zero o più righe invia i risultati alla "pipe" del chiamante connesso.

Per gli oggetti di database CLR (Common Language Runtime) in esecuzione in SQL Server, è possibile inviare i risultati alla pipe connessa usando i metodi Send dell'oggetto SqlPipe . Accedere alla proprietà Pipe dell'oggetto SqlContext per ottenere l'oggetto SqlPipe . La classe SqlPipe è concettualmente simile alla classe Response disponibile in ASP.NET. Per ulteriori informazioni, vedere documentazione di riferimento per la classe SqlPipe in .NET Framework SDK (Software Development Kit).

Restituzione di risultati tabulari e messaggi

SqlPipe dispone di un metodo Send, che dispone di tre overload. Sono:

• void Send(string message)

• void Send(SqlDataReader reader)

• void Send(SqlDataRecord record)

Il metodo Send invia i dati direttamente al client o al chiamante. In genere è il client che utilizza l'output di SqlPipe, ma nel caso di stored procedure CLR annidate, il consumer di output può anche essere una stored procedure. Procedure1 chiama ad esempio SqlCommand.ExecuteReader() con il testo del comando "EXEC Procedure2". Procedure2 è anche una stored procedure gestita. Se Procedure2 chiama il metodo SqlPipe.Send(SqlDataRecord), la riga verrà inviata al lettore di Procedure1, non al client.

Il metodo Send invia un messaggio stringa visualizzato nel client come messaggio informativo, equivalente a PRINT in Transact-SQL. Può anche inviare un set di risultati a riga singola usando SqlDataRecord o un set di risultati su più righe usando un oggetto SqlDataReader.

L'oggetto SqlPipe ha anche un metodo ExecuteAndSend . Questo metodo può essere usato per eseguire un comando (passato come oggetto SqlCommand ) e inviare i risultati direttamente al chiamante. Se sono presenti errori nel comando inviato, le eccezioni vengono inviate alla pipe, ma una copia viene inviata anche al codice gestito chiamante. Se il codice chiamante non rileva l'eccezione, propaga lo stack al codice Transact-SQL e viene visualizzato nell'output due volte. Se il codice chiamante rileva l'eccezione, il consumer della pipe visualizzerà l'errore, ma questo non verrà duplicato.

Può accettare solo un oggetto SqlCommand associato alla connessione di contesto. Non può accettare un comando associato alla connessione non contestuale.

Restituzione di set di risultati personalizzati

Le stored procedure gestite possono inviare set di risultati che non provengono da sqlDataReader. Il metodo SendResultsStart , insieme a SendResultsRow e SendResultsEnd, consente alle stored procedure di inviare set di risultati personalizzati al client.

SendResultsStart accetta sqlDataRecord come input. Indica l'inizio di un set di risultati e utilizza i metadati del record per costruire i metadati che descrivono il set in questione. Non invia il valore del record con SendResultsStart. Tutte le righe successive, inviate tramite SendResultsRow, devono corrispondere a tale definizione di metadati.

Nota

Dopo aver chiamato il metodo SendResultsStart , è possibile chiamare solo SendResultsRow e SendResultsEnd . La chiamata di qualsiasi altro metodo nella stessa istanza di SqlPipe causa un'eccezione InvalidOperationException. SendResultsEnd imposta SqlPipe sullo stato iniziale in cui è possibile chiamare altri metodi.

Esempio

La stored procedure uspGetProductLine restituisce il nome, il numero di prodotto, il colore e il prezzo di listino di tutti i prodotti all'interno di una linea di prodotto specificata. Questa stored procedure accetta corrispondenze esatte per prodLine.

C#

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  

L'istruzione Transact-SQL seguente esegue la procedura uspGetProduct , che restituisce un elenco di prodotti touring bike.

EXEC uspGetProductLineVB 'T';  

Vedi anche

Oggetto SqlDataRecord
Stored procedure CLR
Estensioni specifiche In-Process di SQL Server ad ADO.NET