SqlCommand.BeginExecuteXmlReader Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| BeginExecuteXmlReader() |
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, определенной в данном объекте SqlCommand, и возвращает результаты в виде объекта XmlReader, используя процедуру обратного вызова. |
BeginExecuteXmlReader()
Инициирует асинхронное выполнение инструкции 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, NVarChar, VarChar или Xml , использовалось, если Value для параметра задано значение TextReader .
-или-
Объект , отличный SqlDbType от XML , использовался, если Value для параметра задано значение XmlReader .
Любая ошибка, произошедшая во время выполнения текста команды.
-или-
Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
- or -
<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.
Произошла ошибка в объекте Stream или XmlReaderTextReader во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Объект Stream , XmlReader или TextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Примеры
Следующее консольное приложение запускает процесс получения XML-данных асинхронно. В ожидании результатов это простое приложение находится в цикле, исследуя IsCompleted значение свойства. После завершения процесса код извлекает XML-код и отображает его содержимое.
[!code-csharp[SqlCommand_BeginExecuteXmlReader#1]((~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]
Комментарии
Метод BeginExecuteXmlReader запускает процесс асинхронного выполнения инструкции Transact-SQL, которая возвращает строки в виде XML, чтобы другие задачи могли выполняться параллельно во время выполнения инструкции. После завершения инструкции разработчики должны вызвать EndExecuteXmlReader метод , чтобы завершить операцию и получить XML-код, возвращенный командой . Метод BeginExecuteXmlReader возвращается немедленно, но до тех пор, пока код не выполнит соответствующий EndExecuteXmlReader вызов метода, он не должен выполнять другие вызовы, которые запускают синхронное или асинхронное выполнение для того же 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 метод присоединяет XmlReader к значению в первой строке и удаляет остальную часть результированного набора.
Функция MARS позволяет нескольким действиям использовать одно и то же подключение.
Обратите внимание, что текст команды и параметры отправляются на сервер синхронно. Если отправляется большая команда или много параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не дожидаясь ответа от сервера, то есть операции чтения являются асинхронными. Хотя выполнение команды является асинхронным, выборка значений по-прежнему является синхронной.
Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчикам необходимо либо выполнить опрос, чтобы определить, выполнена ли команда, используя IsCompleted свойство IAsyncResult объекта , возвращаемое методом BeginExecuteXmlReader , либо дождаться завершения одной или нескольких команд с помощью AsyncWaitHandle свойства возвращаемого IAsyncResultобъекта .
Если вы используете ExecuteReader или BeginExecuteReader для доступа к XML-данным, SQL Server возвращает любые XML-результаты длиной более 2033 символов в нескольких строках по 2033 символа в каждой. Чтобы избежать такого поведения, используйте ExecuteXmlReader или BeginExecuteXmlReader для чтения запросов FOR XML.
Этот метод игнорирует CommandTimeout свойство .
Применяется к
BeginExecuteXmlReader(AsyncCallback, Object)
Инициирует асинхронное выполнение инструкции 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 от Binary или VarBinary , использовался, если Value для параметра задано значение Stream . Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
-или-
Значение , отличное SqlDbType от Char, NChar, NVarChar, VarChar или Xml , использовалось, если Value для параметра задано значение TextReader .
-или-
Объект , отличный SqlDbType от XML , использовался, если Value для параметра задано значение XmlReader .
Любая ошибка, произошедшая во время выполнения текста команды.
-или-
Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
- or -
<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.
Произошла ошибка в объекте Stream или XmlReaderTextReader во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Объект Stream , XmlReader или TextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.
Примеры
Следующее приложение Windows демонстрирует использование метода BeginExecuteXmlReader, выполняющего инструкцию Transact-SQL, которая включает в себя задержку в несколько секунд (эмуляция длительной команды). В этом примере выполняется передача объекта SqlCommand в качестве stateObject параметра, что упрощает извлечение SqlCommand объекта из процедуры обратного вызова, чтобы код смог вызвать EndExecuteXmlReader метод, соответствующий первоначальному вызову BeginExecuteXmlReader.
В этом примере демонстрируется множество важных методов. Сюда входит вызов метода, который взаимодействует с формой из отдельного потока. Кроме того, в этом примере показано, как запретить пользователям выполнять команду несколько раз одновременно и как убедиться, что форма не закрывается перед вызовом процедуры обратного вызова.
Чтобы настроить этот пример, создайте новое приложение Windows. Button Поместите элемент управления, ListBox элемент управления и Label элемент управления в форму (принимая имя по умолчанию для каждого элемента управления). Добавьте следующий код в класс формы, изменив строку подключения по мере необходимости для вашей среды.
// <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 Microsoft.AdoDotNet.CodeSamples
{
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 свойство .