SqlCommand.BeginExecuteXmlReader Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| Nombre | Description |
|---|---|
| BeginExecuteXmlReader() |
Inicia la ejecución asincrónica de la instrucción Transact-SQL o el procedimiento almacenado descrito por este SqlCommand objeto y devuelve resultados como un XmlReader objeto . |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Inicia la ejecución asincrónica de la instrucción Transact-SQL o el procedimiento almacenado descrito por este SqlCommand objeto y devuelve resultados como un XmlReader objeto mediante un procedimiento de devolución de llamada. |
BeginExecuteXmlReader()
- Source:
- SqlCommand.cs
- Source:
- SqlCommand.cs
- Source:
- SqlCommand.cs
- Source:
- SqlCommand.cs
Inicia la ejecución asincrónica de la instrucción Transact-SQL o el procedimiento almacenado descrito por este SqlCommand objeto y devuelve resultados como un XmlReader objeto .
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultDevoluciones
IAsyncResult que se puede usar para sondear o esperar resultados, o ambos; este valor también es necesario al invocar EndExecuteXmlReader, que devuelve un único valor XML.
Excepciones
-
Que SqlDbType no es o
Binaryse usó cuandoVarBinaryse estableció en ValueStream . Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient. -
Un SqlDbType valor distinto de
Char,NChar,NVarChar,VarCharoXmlse usó cuando Value se estableció en TextReader. -
Que SqlDbType no se usó cuando
Xmlse estableció en Value.XmlReader
- Cualquier error que se produjo al ejecutar el texto del comando.
- Se ha agotado el tiempo de espera durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
- Cerrado SqlConnection o quitado durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
- EnableOptimizedParameterBinding se establece en true y se ha agregado un parámetro con la dirección Output o InputOutput a la Parameters colección.
Error en un Streamobjeto , XmlReader o TextReader durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
El Streamobjeto , XmlReader o TextReader se cerró durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
Ejemplos
La siguiente aplicación de consola inicia el proceso de recuperación de datos XML de forma asincrónica. Mientras espera los resultados, esta aplicación sencilla se encuentra en un bucle, investigando el valor de la IsCompleted propiedad. Una vez completado el proceso, el código recupera el XML y muestra su contenido.
using System;
using System.Data;
using Microsoft.Data.SqlClient;
using System.Xml;
class Class1
{
static void Main()
{
// This example is not terribly effective, but it proves a point.
// The WAITFOR statement simply adds enough time to prove the
// asynchronous nature of the command.
string commandText =
"WAITFOR DELAY '00:00:03';" +
"SELECT Name, ListPrice FROM Production.Product " +
"WHERE ListPrice < 100 " +
"FOR XML AUTO, XMLDATA";
RunCommandAsynchronously(commandText, GetConnectionString());
Console.WriteLine("Press ENTER to continue.");
Console.ReadLine();
}
private static void RunCommandAsynchronously(string commandText, string connectionString)
{
// Given command text and connection string, asynchronously execute
// the specified command against the connection. For this example,
// the code displays an indicator as it is working, verifying the
// asynchronous behavior.
using (SqlConnection connection = new SqlConnection(connectionString))
{
SqlCommand command = new SqlCommand(commandText, connection);
connection.Open();
IAsyncResult result = command.BeginExecuteXmlReader();
// Although it is not necessary, the following procedure
// displays a counter in the console window, indicating that
// the main thread is not blocked while awaiting the command
// results.
int count = 0;
while (!result.IsCompleted)
{
Console.WriteLine("Waiting ({0})", count++);
// Wait for 1/10 second, so the counter
// does not consume all available resources
// on the main thread.
System.Threading.Thread.Sleep(100);
}
XmlReader reader = command.EndExecuteXmlReader(result);
DisplayProductInfo(reader);
}
}
private static void DisplayProductInfo(XmlReader reader)
{
// Display the data within the reader.
while (reader.Read())
{
// Skip past items that are not from the correct table.
if (reader.LocalName.ToString() == "Production.Product")
{
Console.WriteLine("{0}: {1:C}",
reader["Name"], Convert.ToSingle(reader["ListPrice"]));
}
}
}
private static string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
}
Comentarios
El BeginExecuteXmlReader() método inicia el proceso de ejecutar de forma asincrónica una instrucción Transact-SQL que devuelve filas como XML, de modo que otras tareas se puedan ejecutar simultáneamente mientras se ejecuta la instrucción. Cuando se haya completado la instrucción , los desarrolladores deben llamar al EndExecuteXmlReader(IAsyncResult) método para finalizar la operación y recuperar el XML devuelto por el comando . El BeginExecuteXmlReader() método devuelve inmediatamente, pero hasta que el código ejecuta la llamada al método correspondiente EndExecuteXmlReader(IAsyncResult) , no debe ejecutar ninguna otra llamada que inicie una ejecución sincrónica o asincrónica en el mismo SqlCommand objeto.
EndExecuteXmlReader Al llamar a antes de que se complete la ejecución del comando, el SqlCommand objeto se bloqueará hasta que finalice la ejecución.
Normalmente, la CommandText propiedad especifica una instrucción Transact-SQL con una cláusula FOR XML válida. Sin embargo, CommandText también puede especificar una instrucción que devuelva ntext datos que contengan XML válidos.
Se puede dar formato a una consulta típica BeginExecuteXmlReader() como en el ejemplo de C#siguiente:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y de una sola columna. En este caso, si se devuelve más de una fila, el EndExecuteXmlReader(IAsyncResult) método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.
La característica de varios conjuntos de resultados activos (MARS) permite que varias acciones usen la misma conexión.
Tenga en cuenta que el texto del comando y los parámetros se envían al servidor de forma sincrónica. Si se envía un comando grande o muchos parámetros, este método puede bloquearse durante las escrituras. Una vez enviado el comando, el método devuelve inmediatamente sin esperar una respuesta del servidor, es decir, las lecturas son asincrónicas. Aunque la ejecución de comandos es asincrónica, la captura de valores sigue siendo sincrónica.
Dado que esta sobrecarga no admite un procedimiento de devolución de llamada, los desarrolladores deben sondear para determinar si el comando se ha completado, mediante la IsCompleted propiedad del IAsyncResult devuelto por el BeginExecuteXmlReader() método; o esperar a que finalice uno o varios comandos mediante la AsyncWaitHandle propiedad del devuelto IAsyncResult.
Si usa ExecuteReader() o BeginExecuteReader() para tener acceso a datos XML, SQL Server devuelve cualquier resultado XML superior a 2033 caracteres de longitud en varias filas de 2033 caracteres cada uno. Para evitar este comportamiento, use ExecuteXmlReader() o BeginExecuteXmlReader() para leer consultas FOR XML.
Este método omite la CommandTimeout propiedad .
Se aplica a
BeginExecuteXmlReader(AsyncCallback, Object)
- Source:
- SqlCommand.cs
- Source:
- SqlCommand.cs
- Source:
- SqlCommand.cs
- Source:
- SqlCommand.cs
Inicia la ejecución asincrónica de la instrucción Transact-SQL o el procedimiento almacenado descrito por este SqlCommand objeto y devuelve resultados como un XmlReader objeto mediante un procedimiento de devolución de llamada.
public:
IAsyncResult ^ BeginExecuteXmlReader(AsyncCallback ^ callback, System::Object ^ stateObject);public IAsyncResult BeginExecuteXmlReader(AsyncCallback callback, object stateObject);member this.BeginExecuteXmlReader : AsyncCallback * obj -> IAsyncResultPublic Function BeginExecuteXmlReader (callback As AsyncCallback, stateObject As Object) As IAsyncResultParámetros
- callback
- AsyncCallback
AsyncCallback Delegado que se invoca cuando se ha completado la ejecución del comando. Pase
null ( Nothing en Microsoft Visual Basic) para indicar que no se requiere ninguna devolución de llamada.
- stateObject
- Object
Objeto de estado definido por el usuario que se pasa al procedimiento de devolución de llamada. Recupere este objeto desde el procedimiento de devolución de llamada mediante la AsyncState propiedad .
Devoluciones
IAsyncResult que se puede usar para sondear, esperar resultados o ambos; este valor también es necesario cuando EndExecuteXmlReader(IAsyncResult) se llama a , que devuelve los resultados del comando como XML.
Excepciones
Se usó un SqlDbType valor distinto de Binary o VarBinary cuando Value se estableció en Stream . Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
-o bien-
Se usó un SqlDbType valor distinto de Char, NChar, NVarChar, VarChar o Xml cuando Value se estableció en TextReader .
-o bien-
Se usó un SqlDbType valor distinto de Xml cuando Value se estableció en XmlReader .
Cualquier error que se produjo al ejecutar el texto del comando.
-o bien-
Se ha agotado el tiempo de espera durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
Cerrado SqlConnection o quitado durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
- o -
Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding se establece en true y se ha agregado un parámetro con la dirección Output o InputOutput a la Parameters colección.
Error en un Stream objeto , XmlReader o TextReader durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
El Stream objeto , XmlReader o TextReader se cerró durante una operación de streaming. Para obtener más información sobre el streaming, consulte Compatibilidad con streaming de SqlClient.
Ejemplos
La siguiente aplicación Windows muestra el uso del método BeginExecuteXmlReader, que ejecuta una instrucción Transact-SQL que incluye un retraso de unos pocos segundos (emulando un comando de ejecución prolongada). En este ejemplo se pasa el objeto en SqlCommand ejecución como stateObject parámetro, lo que facilita la recuperación del SqlCommand objeto desde el procedimiento de devolución de llamada, de modo que el código pueda llamar al EndExecuteXmlReader método correspondiente a la llamada inicial a BeginExecuteXmlReader.
En este ejemplo se muestran muchas técnicas importantes. Esto incluye llamar a un método que interactúa con el formulario desde un subproceso independiente. Además, en este ejemplo se muestra cómo debe impedir que los usuarios ejecuten un comando varias veces simultáneamente y cómo debe asegurarse de que el formulario no se cierra antes de llamar al procedimiento de devolución de llamada.
Para configurar este ejemplo, cree una aplicación Windows. Coloque un Button control, un ListBox control y un Label control en el formulario (aceptando el nombre predeterminado para cada control). Agregue el código siguiente a la clase del formulario, modificando la cadena de conexión según sea necesario para el entorno.
/* This does not compile, as multiple methods are missing.
// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;
using System.Xml;
namespace SqlCommand_BeginExecuteXmlReaderAsync
{
public partial class Form1 : Form
{
// Hook up the form's Load event handler and then add
// this code to the form's class:
// You need these delegates in order to display text from a thread
// other than the form's thread. See the HandleCallback
// procedure for more information.
private delegate void DisplayInfoDelegate(string Text);
private delegate void DisplayReaderDelegate(XmlReader reader);
private bool isExecuting;
// This example maintains the connection object
// externally, so that it is available for closing.
private SqlConnection connection;
public Form1()
{
InitializeComponent();
}
private string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
private void DisplayStatus(string Text)
{
this.label1.Text = Text;
}
private void ClearProductInfo()
{
// Clear the list box.
this.listBox1.Items.Clear();
}
private void DisplayProductInfo(XmlReader reader)
{
// Display the data within the reader.
while (reader.Read())
{
// Skip past items that are not from the correct table.
if (reader.LocalName.ToString() == "Production.Product")
{
this.listBox1.Items.Add(String.Format("{0}: {1:C}",
reader["Name"], Convert.ToDecimal(reader["ListPrice"])));
}
}
DisplayStatus("Ready");
}
private void Form1_FormClosing(object sender,
System.Windows.Forms.FormClosingEventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this, "Cannot close the form until " +
"the pending asynchronous command has completed. Please wait...");
e.Cancel = true;
}
}
private void button1_Click(object sender, System.EventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this,
"Already executing. Please wait until the current query " +
"has completed.");
}
else
{
SqlCommand command = null;
try
{
ClearProductInfo();
DisplayStatus("Connecting...");
connection = new SqlConnection(GetConnectionString());
// To emulate a long-running query, wait for
// a few seconds before working with the data.
string commandText =
"WAITFOR DELAY '00:00:03';" +
"SELECT Name, ListPrice FROM Production.Product " +
"WHERE ListPrice < 100 " +
"FOR XML AUTO, XMLDATA";
command = new SqlCommand(commandText, connection);
connection.Open();
DisplayStatus("Executing...");
isExecuting = true;
// Although it is not required that you pass the
// SqlCommand object as the second parameter in the
// BeginExecuteXmlReader call, doing so makes it easier
// to call EndExecuteXmlReader in the callback procedure.
AsyncCallback callback = new AsyncCallback(HandleCallback);
command.BeginExecuteXmlReader(callback, command);
}
catch (Exception ex)
{
isExecuting = false;
DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
if (connection != null)
{
connection.Close();
}
}
}
}
private void HandleCallback(IAsyncResult result)
{
try
{
// Retrieve the original command object, passed
// to this procedure in the AsyncState property
// of the IAsyncResult parameter.
SqlCommand command = (SqlCommand)result.AsyncState;
XmlReader reader = command.EndExecuteXmlReader(result);
// You may not interact with the form and its contents
// from a different thread, and this callback procedure
// is all but guaranteed to be running from a different thread
// than the form.
// Instead, you must call the procedure from the form's thread.
// One simple way to accomplish this is to call the Invoke
// method of the form, which calls the delegate you supply
// from the form's thread.
DisplayReaderDelegate del = new DisplayReaderDelegate(DisplayProductInfo);
this.Invoke(del, reader);
}
catch (Exception ex)
{
// Because you are now running code in a separate thread,
// if you do not handle the exception here, none of your other
// code catches the exception. Because none of
// your code is on the call stack in this thread, there is nothing
// higher up the stack to catch the exception if you do not
// handle it here. You can either log the exception or
// invoke a delegate (as in the non-error case in this
// example) to display the error on the form. In no case
// can you simply display the error without executing a delegate
// as in the try block here.
// You can create the delegate instance as you
// invoke it, like this:
this.Invoke(new DisplayInfoDelegate(DisplayStatus),
String.Format("Ready(last error: {0}", ex.Message));
}
finally
{
isExecuting = false;
if (connection != null)
{
connection.Close();
}
}
}
private void Form1_Load(object sender, System.EventArgs e)
{
this.button1.Click += new System.EventHandler(this.button1_Click);
this.FormClosing += new System.Windows.Forms.
FormClosingEventHandler(this.Form1_FormClosing);
}
}
}
// </Snippet1>
*/
Comentarios
El BeginExecuteXmlReader método inicia el proceso de ejecutar de forma asincrónica una instrucción Transact-SQL o un procedimiento almacenado que devuelve filas como XML, de modo que otras tareas se puedan ejecutar simultáneamente mientras se ejecuta la instrucción. Una vez completada la instrucción , los desarrolladores deben llamar al EndExecuteXmlReader método para finalizar la operación y recuperar los datos XML solicitados. El BeginExecuteXmlReader método devuelve inmediatamente, pero hasta que el código ejecuta la llamada al método correspondiente EndExecuteXmlReader , no debe ejecutar ninguna otra llamada que inicie una ejecución sincrónica o asincrónica en el mismo SqlCommand objeto. EndExecuteXmlReader Al llamar a antes de que se complete la ejecución del comando, el SqlCommand objeto se bloqueará hasta que finalice la ejecución.
Normalmente, la CommandText propiedad especifica una instrucción Transact-SQL con una cláusula FOR XML válida. Sin embargo, CommandText también puede especificar una instrucción que devuelva datos que contengan XML válidos. Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y de una sola columna. En este caso, si se devuelve más de una fila, el EndExecuteXmlReader método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.
Se puede dar formato a una consulta típica BeginExecuteXmlReader como en el ejemplo de C#siguiente:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Este método también se puede usar para recuperar un conjunto de resultados de una sola fila y de una sola columna. En este caso, si se devuelve más de una fila, el EndExecuteXmlReader método adjunta el XmlReader al valor de la primera fila y descarta el resto del conjunto de resultados.
La característica de varios conjuntos de resultados activos (MARS) permite que varias acciones usen la misma conexión.
El callback parámetro permite especificar un AsyncCallback delegado al que se llama cuando se ha completado la instrucción . Puede llamar al EndExecuteXmlReader método desde este procedimiento delegado o desde cualquier otra ubicación dentro de la aplicación. Además, puede pasar cualquier objeto en el stateObject parámetro y el procedimiento de devolución de llamada puede recuperar esta información mediante la AsyncState propiedad .
Tenga en cuenta que el texto del comando y los parámetros se envían al servidor de forma sincrónica. Si se envía un comando grande o muchos parámetros, este método puede bloquearse durante las escrituras. Una vez enviado el comando, el método devuelve inmediatamente sin esperar una respuesta del servidor, es decir, las lecturas son asincrónicas.
Todos los errores que se producen durante la ejecución de la operación se producen como excepciones en el procedimiento de devolución de llamada. Debe controlar la excepción en el procedimiento de devolución de llamada, no en la aplicación principal. Consulte el ejemplo de este tema para obtener información adicional sobre el control de excepciones en el procedimiento de devolución de llamada.
Si usa ExecuteReader o BeginExecuteReader para obtener acceso a datos XML, SQL Server devolverá resultados XML mayores de 2033 caracteres de longitud en varias filas de 2033 caracteres cada uno. Para evitar este comportamiento, use ExecuteXmlReader o BeginExecuteXmlReader para leer consultas FOR XML.
Este método omite la CommandTimeout propiedad .