SqlCommand.BeginExecuteXmlReader Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| Имя | Описание |
|---|---|
| BeginExecuteXmlReader() |
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой SqlCommand этим XmlReader и возвращающей результаты в виде объекта. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой этим SqlCommand , и возвращает результаты в качестве XmlReader объекта с помощью процедуры обратного вызова. |
BeginExecuteXmlReader()
- Исходный код:
- SqlCommand.cs
- Исходный код:
- SqlCommand.cs
- Исходный код:
- SqlCommand.cs
- Исходный код:
- SqlCommand.cs
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой SqlCommand этим XmlReader и возвращающей результаты в виде объекта.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultВозвращаемое значение
Можно IAsyncResult использовать для опроса или ожидания результатов или обоих результатов. Это значение также необходимо при вызове EndExecuteXmlReader, которое возвращает одно XML-значение.
Исключения
-
Значение SqlDbType , отличное
Binaryот илиVarBinaryиспользуемое, если Value задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient". -
ЗначениеSqlDbType, отличное от
Char,NChar,NVarCharVarCharилиXmlиспользовалось при Value установкеTextReader. -
Значение SqlDbType , отличное от
Xmlиспользуемого при Value установке XmlReader.
- Любая ошибка, которая произошла при выполнении текста команды.
- Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
- Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
- EnableOptimizedParameterBinding имеет значение true, а параметр с направлением Output или InputOutput добавлен в коллекцию Parameters .
Ошибка произошла в объекте StreamXmlReader или TextReader объекте во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
Stream Объект XmlReaderили TextReader объект был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
Примеры
Следующее консольное приложение запускает процесс асинхронного извлечения XML-данных. Ожидая результатов, это простое приложение находится в цикле, исследуя IsCompleted значение свойства. После завершения процесса код извлекает XML-файл и отображает его содержимое.
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";
}
}
Комментарии
Метод BeginExecuteXmlReader() запускает процесс асинхронного выполнения инструкции Transact-SQL, которая возвращает строки в виде XML, чтобы другие задачи могли выполняться одновременно при выполнении инструкции. После завершения инструкции разработчики должны вызвать EndExecuteXmlReader(IAsyncResult) метод, чтобы завершить операцию и получить XML- код, возвращенный командой. Метод BeginExecuteXmlReader() возвращается немедленно, но пока код не выполнит соответствующий EndExecuteXmlReader(IAsyncResult) вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта.
EndExecuteXmlReader Вызов вызова перед завершением выполнения команды приводит SqlCommand к блокировке объекта до завершения выполнения.
Обычно свойство CommandText задает оператор Transact-SQL с допустимым предложением FOR XML.
CommandText Однако также можно указать инструкцию, возвращающую ntext данные, содержащие допустимый XML.
Типичный BeginExecuteXmlReader() запрос можно отформатировать, как показано в следующем примере C#:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Этот метод также можно использовать для получения однострочного результирующий набор с одним столбцом. В этом случае, если возвращается несколько строк, EndExecuteXmlReader(IAsyncResult) метод присоединяет XmlReader значение к первой строке и удаляет остальную часть результирующий набор.
Функция нескольких активных результирующих наборов (MARS) позволяет нескольким действиям использовать одно и то же подключение.
Обратите внимание, что текст команды и параметры отправляются серверу синхронно. Если отправляется большая команда или множество параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения асинхронны. Хотя выполнение команды является асинхронным, получение значений по-прежнему синхронно.
Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчики должны либо опрашивать, чтобы определить, выполнена ли команда, используя IsCompleted свойство IAsyncResultBeginExecuteXmlReader() возвращаемого методом; или дождитесь завершения одной или нескольких команд с помощью AsyncWaitHandle свойства возвращаемого IAsyncResult.
При использовании ExecuteReader() или BeginExecuteReader() доступе к XML-данным SQL Server возвращает все результаты XML, превышающие 2033 символов длиной в нескольких строках из 2033 символов. Чтобы избежать этого поведения, используйте ExecuteXmlReader() или BeginExecuteXmlReader() считывает запросы FOR XML.
Этот метод игнорирует CommandTimeout свойство.
Применяется к
BeginExecuteXmlReader(AsyncCallback, Object)
- Исходный код:
- SqlCommand.cs
- Исходный код:
- SqlCommand.cs
- Исходный код:
- SqlCommand.cs
- Исходный код:
- SqlCommand.cs
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описываемой этим SqlCommand , и возвращает результаты в качестве XmlReader объекта с помощью процедуры обратного вызова.
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 IAsyncResultПараметры
- callback
- AsyncCallback
Делегат AsyncCallback , который вызывается при завершении выполнения команды. Пройти
null ( Nothing в Microsoft Visual Basic) указывает, что обратный вызов не требуется.
- stateObject
- Object
Определяемый пользователем объект состояния, передаваемый процедуре обратного вызова. Извлеките этот объект из процедуры обратного вызова с помощью AsyncState свойства.
Возвращаемое значение
Можно IAsyncResult использовать для опроса, ожидания результатов или обоих. Это значение также необходимо при EndExecuteXmlReader(IAsyncResult) вызове, которое возвращает результаты команды в виде XML.
Исключения
Если задано значение SqlDbType"Двоичный" или "VarBinary", используется Value значение "ДвоичныйStream" или "VarBinary". Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
-или-
Если SqlDbType задано значение "Char", "NChar", "NVarChar", Value" или TextReader"
-или-
Значение SqlDbType , отличное от xml , использовалось при Value установке XmlReader .
Любая ошибка, которая произошла при выполнении текста команды.
-или-
Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
- или -
Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding имеет значение true, а параметр с направлением Output или InputOutput добавлен в коллекцию Parameters .
Ошибка произошла в объекте StreamXmlReader или TextReader объекте во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
Stream Объект XmlReader или TextReader объект был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
Примеры
Следующее приложение Windows демонстрирует использование метода BeginExecuteXmlReader, выполняющего инструкцию Transact-SQL, которая включает в себя задержку в несколько секунд (эмуляция длительной команды). Этот пример передает исполняемый SqlCommand объект в качестве stateObject параметра, что упрощает извлечение SqlCommand объекта из процедуры обратного вызова, чтобы код смог вызвать EndExecuteXmlReader метод, соответствующий первоначальному вызову BeginExecuteXmlReader.
В этом примере демонстрируется множество важных методов. Это включает вызов метода, взаимодействующего с формой из отдельного потока. Кроме того, в этом примере показано, как необходимо запретить пользователям выполнять команду несколько раз одновременно и как необходимо убедиться, что форма не закрывается перед вызовом процедуры обратного вызова.
Чтобы настроить этот пример, создайте новое приложение Windows. Button Поместите элемент управления, ListBox элемент управления и Label элемент управления в форму (принимая имя по умолчанию для каждого элемента управления). Добавьте следующий код в класс формы, изменив строку подключения по мере необходимости для вашей среды.
/* 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>
*/
Комментарии
Метод BeginExecuteXmlReader запускает процесс асинхронного выполнения инструкции Transact-SQL или хранимой процедуры, возвращающей строки в формате XML, чтобы другие задачи могли выполняться одновременно при выполнении инструкции. После завершения инструкции разработчики должны вызвать EndExecuteXmlReader метод, чтобы завершить операцию и получить запрошенные XML-данные. Метод BeginExecuteXmlReader возвращается немедленно, но пока код не выполнит соответствующий EndExecuteXmlReader вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта. EndExecuteXmlReader Вызов вызова перед завершением выполнения команды приводит SqlCommand к блокировке объекта до завершения выполнения.
Обычно свойство CommandText задает оператор Transact-SQL с допустимым предложением FOR XML.
CommandText Однако также можно указать инструкцию, возвращающую данные, содержащие допустимый XML. Этот метод также можно использовать для получения однострочного результирующий набор с одним столбцом. В этом случае, если возвращается несколько строк, EndExecuteXmlReader метод присоединяет XmlReader значение к первой строке и удаляет остальную часть результирующий набор.
Типичный BeginExecuteXmlReader запрос можно отформатировать, как показано в следующем примере C#:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Этот метод также можно использовать для получения однострочного результирующий набор с одним столбцом. В этом случае, если возвращается несколько строк, EndExecuteXmlReader метод присоединяет XmlReader значение к первой строке и удаляет остальную часть результирующий набор.
Функция нескольких активных результирующих наборов (MARS) позволяет нескольким действиям использовать одно и то же подключение.
Параметр callback позволяет указать AsyncCallback делегат, который вызывается при завершении инструкции. Метод можно вызвать EndExecuteXmlReader из этой процедуры делегата или из любого другого расположения в приложении. Кроме того, можно передать любой объект в параметре, а процедура обратного stateObject вызова может получить эти сведения с помощью AsyncState свойства.
Обратите внимание, что текст команды и параметры отправляются серверу синхронно. Если отправляется большая команда или множество параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения асинхронны.
Все ошибки, возникающие во время выполнения операции, возникают в виде исключений в процедуре обратного вызова. Необходимо обработать исключение в процедуре обратного вызова, а не в основном приложении. Дополнительные сведения об обработке исключений в процедуре обратного вызова см. в примере в этом разделе.
Если вы используете ExecuteReader или BeginExecuteReader используете XML-данные, SQL Server вернет все результаты XML, превышающие 2033 символов длиной в нескольких строках из 2033 символов. Чтобы избежать этого поведения, используйте ExecuteXmlReader или BeginExecuteXmlReader считывает запросы FOR XML.
Этот метод игнорирует CommandTimeout свойство.