Condividi tramite

Oggetto SqlPipe

  • Articolo

Si applica a:SQL Server

Nelle versioni precedenti di SQL Server, è stato comune scrivere una stored procedure (o una stored procedure estesa) che ha inviato 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 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 altre informazioni, vedere Microsoft.SqlServer.Server.SqlPipe.

Restituire i risultati tabulari e i messaggi

L'oggetto SqlPipe dispone di un metodo Send, con 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 del SqlPipe, ma con stored procedure CLR annidate, il consumer di output può anche essere una stored procedure. Ad esempio, Procedure1 chiama SqlCommand.ExecuteReader() con il testo del comando EXEC Procedure2. Procedure2 è anche una stored procedure gestita. Se Procedure2 ora chiama SqlPipe.Send(SqlDataRecord), la riga viene inviata al lettore in 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 SqlDataRecordo un set di risultati su più righe usando un SqlDataReader.

L'oggetto SqlPipe dispone anche di 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 e una copia viene inviata 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 di pipe visualizza comunque l'errore, ma non si verifica un errore duplicato.

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

Restituire set di risultati personalizzati

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

SendResultsStart accetta un 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 usando SendResultsRow, devono corrispondere a tale definizione di metadati.

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 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.

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.
        }
     }
}
};

L'istruzione Transact-SQL seguente esegue la procedura di uspGetProduct, che restituisce un elenco di prodotti per biciclette da turismo.

EXECUTE uspGetProductLineVB 'T';

Contenuto correlato