SqlCommand.BeginExecuteXmlReader Metode
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Overload
| BeginExecuteXmlReader() |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek. |
| BeginExecuteXmlReader(AsyncCallback, Object) |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek, menggunakan prosedur panggilan balik. |
BeginExecuteXmlReader()
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek.
public:
IAsyncResult ^ BeginExecuteXmlReader();public IAsyncResult BeginExecuteXmlReader();member this.BeginExecuteXmlReader : unit -> IAsyncResultPublic Function BeginExecuteXmlReader () As IAsyncResultMengembalikan
IAsyncResult yang dapat digunakan untuk melakukan polling atau menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil
EndExecuteXmlReader , yang mengembalikan satu nilai XML.
Pengecualian
Selain SqlDbTypeBiner atau VarBinary digunakan ketika Value diatur ke Stream . Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
-atau-
Selain SqlDbTypeChar, NChar, NVarChar, VarChar, atau Xml digunakan saat Value diatur ke TextReader .
-atau-
Selain SqlDbTypeXml digunakan ketika Value diatur ke XmlReader .
Kesalahan apa pun yang terjadi saat menjalankan teks perintah.
-atau-
Waktu habis terjadi selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming 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.
Terjadi kesalahan dalam Stream objek , XmlReader atau TextReader selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Objek Stream , XmlReader atau TextReader ditutup selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Contoh
Aplikasi konsol berikut memulai proses pengambilan data XML secara asinkron. Saat menunggu hasilnya, aplikasi sederhana ini berada dalam perulangan, menyelidiki IsCompleted nilai properti. Setelah proses selesai, kode mengambil XML dan menampilkan kontennya.
[!code-csharp[SqlCommand_BeginExecuteXmlReader#1]((~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]
Keterangan
Metode ini BeginExecuteXmlReader memulai proses menjalankan pernyataan Transact-SQL secara asinkron yang mengembalikan baris sebagai XML, sehingga tugas lain dapat berjalan bersamaan saat pernyataan sedang dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteXmlReader metode untuk menyelesaikan operasi dan mengambil XML yang dikembalikan oleh perintah . Metode ini BeginExecuteXmlReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang sesuai EndExecuteXmlReader , metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteXmlReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Properti CommandText biasanya menentukan pernyataan Transact-SQL dengan klausa FOR XML yang valid. Namun, CommandText juga dapat menentukan pernyataan yang mengembalikan ntext data yang berisi XML yang valid.
Kueri umum BeginExecuteXmlReader dapat diformat seperti dalam contoh C# berikut:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Metode ini juga dapat digunakan untuk mengambil kumpulan hasil kolom tunggal satu baris. Dalam hal ini, jika lebih dari satu baris dikembalikan, EndExecuteXmlReader metode melampirkan XmlReader ke nilai pada baris pertama, dan membuang sisa kumpulan hasil.
Fitur beberapa kumpulan hasil aktif (MARS) memungkinkan beberapa tindakan menggunakan koneksi yang sama.
Perhatikan bahwa teks perintah dan parameter dikirim ke server secara sinkron. Jika perintah besar atau banyak parameter dikirim, metode ini dapat memblokir selama penulisan. Setelah perintah dikirim, metode segera kembali tanpa menunggu jawaban dari server--yaitu, bacaan tidak sinkron. Meskipun eksekusi perintah tidak sinkron, pengambilan nilai masih sinkron.
Karena kelebihan beban ini tidak mendukung prosedur panggilan balik, pengembang perlu melakukan polling untuk menentukan apakah perintah telah selesai, menggunakan IsCompleted properti yang IAsyncResult dikembalikan oleh BeginExecuteXmlReader metode ; atau menunggu penyelesaian satu atau beberapa perintah menggunakan AsyncWaitHandle properti dari yang dikembalikan IAsyncResult.
Jika Anda menggunakan ExecuteReader atau BeginExecuteReader untuk mengakses data XML, SQL Server mengembalikan hasil XML yang lebih besar dari 2.033 karakter dalam beberapa baris masing-masing 2.033 karakter. Untuk menghindari perilaku ini, gunakan ExecuteXmlReader atau BeginExecuteXmlReader untuk membaca kueri XML.
Metode ini mengabaikan CommandTimeout properti .
Berlaku untuk
BeginExecuteXmlReader(AsyncCallback, Object)
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengembalikan hasil sebagai XmlReader objek, menggunakan prosedur panggilan balik.
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 IAsyncResultParameter
- callback
- AsyncCallback
Delegasi AsyncCallback yang dipanggil ketika eksekusi perintah telah selesai. Lulus
null ( Nothing di Microsoft Visual Basic) untuk menunjukkan bahwa tidak ada panggilan balik yang diperlukan.
- stateObject
- Object
Objek status yang ditentukan pengguna yang diteruskan ke prosedur panggilan balik. Ambil objek ini dari dalam prosedur panggilan balik menggunakan AsyncState properti .
Mengembalikan
yang IAsyncResult dapat digunakan untuk melakukan polling, menunggu hasil, atau keduanya; nilai ini juga diperlukan ketika EndExecuteXmlReader(IAsyncResult) dipanggil, yang mengembalikan hasil perintah sebagai XML.
Pengecualian
Selain SqlDbTypeBiner atau VarBinary digunakan ketika Value diatur ke Stream . Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
-atau-
Selain SqlDbTypeChar, NChar, NVarChar, VarChar, atau Xml digunakan saat Value diatur ke TextReader .
-atau-
Selain SqlDbTypeXml digunakan ketika Value diatur ke XmlReader .
Kesalahan apa pun yang terjadi saat menjalankan teks perintah.
-atau-
Waktu habis terjadi selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming 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.
Terjadi kesalahan dalam Stream objek , XmlReader atau TextReader selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Objek Stream , XmlReader atau TextReader ditutup selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Contoh
Aplikasi Windows berikut menunjukkan penggunaan metode BeginExecuteXmlReader, menjalankan pernyataan Transact-SQL yang mencakup penundaan beberapa detik (meniru perintah yang berjalan lama). Contoh ini meneruskan SqlCommand objek yang dieksekusi sebagai stateObject parameter--melakukannya sehingga memudahkan untuk mengambil SqlCommand objek dari dalam prosedur panggilan balik, sehingga kode dapat memanggil EndExecuteXmlReader metode yang sesuai dengan panggilan awal ke BeginExecuteXmlReader.
Contoh ini menunjukkan banyak teknik penting. Ini termasuk memanggil metode yang berinteraksi dengan formulir dari utas terpisah. Selain itu, contoh ini menunjukkan bagaimana Anda harus memblokir pengguna agar tidak menjalankan perintah beberapa kali secara bersamaan, dan bagaimana Anda harus memastikan bahwa formulir tidak ditutup sebelum prosedur panggilan balik dipanggil.
Untuk menyiapkan contoh ini, buat aplikasi Windows baru. Letakkan Button kontrol, ListBox kontrol, dan Label kontrol pada formulir (menerima nama default untuk setiap kontrol). Tambahkan kode berikut ke kelas formulir, ubah string koneksi sesuai kebutuhan untuk lingkungan Anda.
// <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>
Keterangan
Metode ini BeginExecuteXmlReader memulai proses menjalankan pernyataan Transact-SQL secara asinkron atau prosedur tersimpan yang mengembalikan baris sebagai XML, sehingga tugas lain dapat berjalan bersamaan saat pernyataan sedang dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteXmlReader metode untuk menyelesaikan operasi dan mengambil data XML yang diminta. Metode ini BeginExecuteXmlReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang sesuai EndExecuteXmlReader , metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteXmlReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Properti CommandText biasanya menentukan pernyataan Transact-SQL dengan klausa FOR XML yang valid. Namun, CommandText juga dapat menentukan pernyataan yang mengembalikan data yang berisi XML yang valid. Metode ini juga dapat digunakan untuk mengambil kumpulan hasil kolom tunggal satu baris. Dalam hal ini, jika lebih dari satu baris dikembalikan, EndExecuteXmlReader metode melampirkan XmlReader ke nilai pada baris pertama, dan membuang sisa kumpulan hasil.
Kueri umum BeginExecuteXmlReader dapat diformat seperti dalam contoh C# berikut:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Metode ini juga dapat digunakan untuk mengambil kumpulan hasil kolom tunggal satu baris. Dalam hal ini, jika lebih dari satu baris dikembalikan, EndExecuteXmlReader metode melampirkan XmlReader ke nilai pada baris pertama, dan membuang sisa kumpulan hasil.
Fitur beberapa kumpulan hasil aktif (MARS) memungkinkan beberapa tindakan menggunakan koneksi yang sama.
Parameter callback memungkinkan Anda menentukan AsyncCallback delegasi yang dipanggil ketika pernyataan telah selesai. Anda dapat memanggil EndExecuteXmlReader metode dari dalam prosedur delegasi ini, atau dari lokasi lain dalam aplikasi Anda. Selain itu, Anda dapat meneruskan objek apa pun dalam stateObject parameter , dan prosedur panggilan balik Anda dapat mengambil informasi ini menggunakan AsyncState properti .
Perhatikan bahwa teks perintah dan parameter dikirim ke server secara sinkron. Jika perintah besar atau banyak parameter dikirim, metode ini dapat memblokir selama penulisan. Setelah perintah dikirim, metode segera kembali tanpa menunggu jawaban dari server--yaitu, bacaan tidak sinkron.
Semua kesalahan yang terjadi selama eksekusi operasi dilemparkan sebagai pengecualian dalam prosedur panggilan balik. Anda harus menangani pengecualian dalam prosedur panggilan balik, bukan di aplikasi utama. Lihat contoh dalam topik ini untuk informasi tambahan tentang penanganan pengecualian dalam prosedur panggilan balik.
Jika Anda menggunakan ExecuteReader atau BeginExecuteReader untuk mengakses data XML, SQL Server akan mengembalikan hasil XML apa pun yang lebih besar dari 2.033 karakter dalam beberapa baris masing-masing 2.033 karakter. Untuk menghindari perilaku ini, gunakan ExecuteXmlReader atau BeginExecuteXmlReader untuk membaca kueri XML.
Metode ini mengabaikan CommandTimeout properti .