SqlCommand.BeginExecuteReader 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.
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand, dan mengambil satu atau beberapa tataan hasil dari server.
Overload
| BeginExecuteReader() |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand, dan mengambil satu atau beberapa tataan hasil dari server. |
| BeginExecuteReader(CommandBehavior) |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand menggunakan salah CommandBehavior satu nilai. |
| BeginExecuteReader(AsyncCallback, Object) |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengambil satu atau beberapa tataan hasil dari server, mengingat prosedur panggilan balik dan informasi status. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand, menggunakan salah |
BeginExecuteReader()
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand, dan mengambil satu atau beberapa tataan hasil dari server.
public:
IAsyncResult ^ BeginExecuteReader();public IAsyncResult BeginExecuteReader ();member this.BeginExecuteReader : unit -> IAsyncResultPublic Function BeginExecuteReader () As IAsyncResultMengembalikan
IAsyncResult Yang dapat digunakan untuk melakukan polling atau menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil EndExecuteReader(IAsyncResult), yang mengembalikan instans SqlDataReader yang dapat digunakan untuk mengambil baris yang dikembalikan.
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.
Pasangan nama/nilai "Pemrosesan Asinkron=true" tidak disertakan dalam string koneksi mendefinisikan koneksi untuk ini SqlCommand.
-atau-
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Terjadi kesalahan dalam Streamobjek , 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 pembaca data secara asinkron. Saat menunggu hasilnya, aplikasi sederhana ini berada dalam perulangan, menyelidiki IsCompleted nilai properti. Segera setelah proses selesai, kode mengambil SqlDataReader dan menampilkan kontennya.
using System.Data.SqlClient;
class Class1
{
static void Main()
{
// This is a simple example that demonstrates the usage of the
// BeginExecuteReader functionality
// The WAITFOR statement simply adds enough time to prove the
// asynchronous nature of the command.
string commandText =
"WAITFOR DELAY '00:00:03';" +
"SELECT LastName, FirstName FROM Person.Contact " +
"WHERE LastName LIKE 'M%'";
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))
{
try
{
SqlCommand command = new SqlCommand(commandText, connection);
connection.Open();
IAsyncResult result = command.BeginExecuteReader();
// Although it is not necessary, the following code
// 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)
{
count += 1;
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);
}
using (SqlDataReader reader = command.EndExecuteReader(result))
{
DisplayResults(reader);
}
}
catch (SqlException ex)
{
Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
}
catch (InvalidOperationException ex)
{
Console.WriteLine("Error: {0}", ex.Message);
}
catch (Exception ex)
{
// You might want to pass these errors
// back out to the caller.
Console.WriteLine("Error: {0}", ex.Message);
}
}
}
private static void DisplayResults(SqlDataReader reader)
{
// Display the data within the reader.
while (reader.Read())
{
// Display all the columns.
for (int i = 0; i < reader.FieldCount; i++)
Console.Write("{0} ", reader.GetValue(i));
Console.WriteLine();
}
}
private static string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
// If you have not included "Asynchronous Processing=true" in the
// connection string, the command is not able
// to execute asynchronously.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks; Asynchronous Processing=true";
}
}
Imports System.Data.SqlClient
Module Module1
Sub Main()
' This is a simple example that demonstrates the usage of the
' BeginExecuteReader functionality.
' The WAITFOR statement simply adds enough time to prove the
' asynchronous nature of the command.
Dim commandText As String = _
"WAITFOR DELAY '00:00:03';" & _
"SELECT LastName, FirstName FROM Person.Contact " & _
"WHERE LastName LIKE 'M%'"
RunCommandAsynchronously(commandText, GetConnectionString())
Console.WriteLine("Press ENTER to continue.")
Console.ReadLine()
End Sub
Private Sub RunCommandAsynchronously( _
ByVal commandText As String, ByVal connectionString As String)
' 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 connection As New SqlConnection(connectionString)
Try
Dim command As New SqlCommand(commandText, connection)
connection.Open()
Dim result As IAsyncResult = command.BeginExecuteReader()
' 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.
Dim count As Integer
While Not result.IsCompleted
count += 1
Console.WriteLine("Waiting ({0})", count)
' Wait for 1/10 second, so the counter
' does not consume all available resources
' on the main thread.
Threading.Thread.Sleep(100)
End While
' Once the IAsyncResult object signals that it is done
' waiting for results, you can retrieve the results.
Using reader As SqlDataReader = command.EndExecuteReader(result)
DisplayResults(reader)
End Using
Catch ex As SqlException
Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
Catch ex As InvalidOperationException
Console.WriteLine("Error: {0}", ex.Message)
Catch ex As Exception
' You might want to pass these errors
' back out to the caller.
Console.WriteLine("Error: {0}", ex.Message)
End Try
End Using
End Sub
Private Sub DisplayResults(ByVal reader As SqlDataReader)
' Display the data within the reader.
While reader.Read()
' Display all the columns.
For i As Integer = 0 To reader.FieldCount - 1
Console.Write("{0} ", reader.GetValue(i))
Next
Console.WriteLine()
End While
End Sub
Private Function GetConnectionString() As String
' To avoid storing the connection string in your code,
' you can retrieve it from a configuration file.
' If you have not included "Asynchronous Processing=true" in the
' connection string, the command is not able
' to execute asynchronously.
Return "Data Source=(local);Integrated Security=true;" & _
"Initial Catalog=AdventureWorks; Asynchronous Processing=true"
End Function
End Module
Keterangan
Metode ini BeginExecuteReader memulai proses menjalankan pernyataan Transact-SQL atau prosedur tersimpan secara asinkron yang mengembalikan baris, sehingga tugas lain dapat berjalan bersamaan saat pernyataan dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteReader metode untuk menyelesaikan operasi dan mengambil yang SqlDataReader dikembalikan oleh perintah . Metode ini BeginExecuteReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang EndExecuteReader sesuai, metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
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 bersifat asinkron. Meskipun eksekusi perintah tidak sinkron, pengambilan nilai masih sinkron. Ini berarti bahwa panggilan ke Read dapat memblokir jika lebih banyak data diperlukan dan blok operasi baca jaringan yang mendasar.
Karena kelebihan beban ini tidak mendukung prosedur panggilan balik, pengembang harus melakukan polling untuk menentukan apakah perintah telah selesai, menggunakan IsCompleted properti yang IAsyncResult dikembalikan oleh BeginExecuteReader 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 akan mengembalikan hasil XML apa pun yang panjangnya lebih dari 2.033 karakter dalam beberapa baris masing-masing 2.033 karakter. Untuk menghindari perilaku ini, gunakan ExecuteXmlReader atau BeginExecuteXmlReader untuk membaca kueri XML FOR.
Metode ini mengabaikan CommandTimeout properti .
Lihat juga
- Menyambungkan dan Mengambil Data di ADO.NET
- Menggunakan Penyedia Data .NET Framework untuk SQL Server
- Ringkasan ADO.NET
Berlaku untuk
BeginExecuteReader(CommandBehavior)
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand menggunakan salah CommandBehavior satu nilai.
public:
IAsyncResult ^ BeginExecuteReader(System::Data::CommandBehavior behavior);public IAsyncResult BeginExecuteReader (System.Data.CommandBehavior behavior);member this.BeginExecuteReader : System.Data.CommandBehavior -> IAsyncResultPublic Function BeginExecuteReader (behavior As CommandBehavior) As IAsyncResultParameter
- behavior
- CommandBehavior
Salah CommandBehavior satu nilai, menunjukkan opsi untuk eksekusi pernyataan dan pengambilan data.
Mengembalikan
Yang IAsyncResult dapat digunakan untuk melakukan polling, menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil EndExecuteReader(IAsyncResult), yang mengembalikan instans SqlDataReader yang dapat digunakan untuk mengambil baris yang dikembalikan.
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.
Pasangan nama/nilai "Pemrosesan Asinkron=true" tidak disertakan dalam string koneksi mendefinisikan koneksi untuk ini SqlCommand.
-atau-
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Terjadi kesalahan dalam Streamobjek , 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 pembaca data secara asinkron. Saat menunggu hasilnya, aplikasi sederhana ini berada dalam perulangan, menyelidiki IsCompleted nilai properti. Setelah proses selesai, kode mengambil SqlDataReader dan menampilkan kontennya.
Contoh ini juga meneruskan CommandBehavior.CloseConnection nilai dan CommandBehavior.SingleRow dalam parameter perilaku, menyebabkan koneksi ditutup dengan yang dikembalikan SqlDataReader ditutup, dan untuk mengoptimalkan hasil satu baris.
using System.Data.SqlClient;
class Class1
{
static void Main()
{
// This example is not terribly useful, 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 ProductID, Name FROM Production.Product WHERE ListPrice < 100";
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.
try
{
// The code does not need to handle closing the connection explicitly--
// the use of the CommandBehavior.CloseConnection option takes care
// of that for you.
SqlConnection connection = new SqlConnection(connectionString);
SqlCommand command = new SqlCommand(commandText, connection);
connection.Open();
IAsyncResult result = command.BeginExecuteReader(
CommandBehavior.CloseConnection);
// Although it is not necessary, the following code
// 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);
}
using (SqlDataReader reader = command.EndExecuteReader(result))
{
DisplayResults(reader);
}
}
catch (SqlException ex)
{
Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
}
catch (InvalidOperationException ex)
{
Console.WriteLine("Error: {0}", ex.Message);
}
catch (Exception ex)
{
// You might want to pass these errors
// back out to the caller.
Console.WriteLine("Error: {0}", ex.Message);
}
}
private static void DisplayResults(SqlDataReader reader)
{
// Display the data within the reader.
while (reader.Read())
{
// Display all the columns.
for (int i = 0; i < reader.FieldCount; i++)
{
Console.Write("{0}\t", reader.GetValue(i));
}
Console.WriteLine();
}
}
private static string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
// If you have not included "Asynchronous Processing=true" in the
// connection string, the command is not able
// to execute asynchronously.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks; Asynchronous Processing=true";
}
}
Imports System.Data.SqlClient
Module Module1
Sub Main()
' This example is not terribly useful, but it proves a point.
' The WAITFOR statement simply adds enough time to prove the
' asynchronous nature of the command.
Dim commandText As String = _
"WAITFOR DELAY '00:00:03';" & _
"SELECT ProductID, Name FROM Production.Product WHERE ListPrice < 100"
RunCommandAsynchronously(commandText, GetConnectionString())
Console.WriteLine("Press ENTER to continue.")
Console.ReadLine()
End Sub
Private Sub RunCommandAsynchronously( _
ByVal commandText As String, ByVal connectionString As String)
' 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.
Try
' The code does not need to handle closing the connection explicitly--
' the use of the CommandBehavior.CloseConnection option takes care
' of that for you.
Dim connection As New SqlConnection(connectionString)
Dim command As New SqlCommand(commandText, connection)
connection.Open()
Dim result As IAsyncResult = _
command.BeginExecuteReader(CommandBehavior.CloseConnection)
' Although it is not necessary, the following code
' displays a counter in the console window, indicating that
' the main thread is not blocked while awaiting the command
' results.
Dim count As Integer = 0
While Not result.IsCompleted
count += 1
Console.WriteLine("Waiting ({0})", count)
' Wait for 1/10 second, so the counter
' does not consume all available resources
' on the main thread.
Threading.Thread.Sleep(100)
End While
' The "using" statement closes the SqlDataReader when it is
' done executing.
Using reader As SqlDataReader = command.EndExecuteReader(result)
DisplayResults(reader)
End Using
Catch ex As SqlException
Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message)
Catch ex As InvalidOperationException
Console.WriteLine("Error: {0}", ex.Message)
Catch ex As Exception
' You might want to pass these errors
' back out to the caller.
Console.WriteLine("Error: {0}", ex.Message)
End Try
End Sub
Private Sub DisplayResults(ByVal reader As SqlDataReader)
' Display the data within the reader.
While reader.Read()
' Display all the columns.
For i As Integer = 0 To reader.FieldCount - 1
Console.Write("{0} ", reader.GetValue(i))
Next
Console.WriteLine()
End While
End Sub
Private Function GetConnectionString() As String
' To avoid storing the connection string in your code,
' you can retrieve it from a configuration file.
' If you have not included "Asynchronous Processing=true" in the
' connection string, the command is not able
' to execute asynchronously.
Return "Data Source=(local);Integrated Security=true;" & _
"Initial Catalog=AdventureWorks; Asynchronous Processing=true"
End Function
End Module
Keterangan
Metode ini BeginExecuteReader memulai proses menjalankan pernyataan Transact-SQL atau prosedur tersimpan secara asinkron yang mengembalikan baris, sehingga tugas lain dapat berjalan bersamaan saat pernyataan dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteReader metode untuk menyelesaikan operasi dan mengambil yang SqlDataReader dikembalikan oleh perintah . Metode ini BeginExecuteReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang EndExecuteReader sesuai, metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Parameter behavior memungkinkan Anda menentukan opsi yang mengontrol perilaku perintah dan koneksinya. Nilai-nilai ini dapat digabungkan bersama -sama (menggunakan operator bahasa OR pemrograman); umumnya, pengembang menggunakan CommandBehavior.CloseConnection nilai untuk memastikan bahwa koneksi ditutup oleh runtime saat SqlDataReader ditutup.
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 bersifat asinkron. Meskipun eksekusi perintah tidak sinkron, pengambilan nilai masih sinkron. Ini berarti bahwa panggilan ke Read dapat memblokir jika lebih banyak data diperlukan dan blok operasi baca jaringan yang mendasar.
Karena kelebihan beban ini tidak mendukung prosedur panggilan balik, pengembang harus melakukan polling untuk menentukan apakah perintah telah selesai, menggunakan IsCompleted properti yang IAsyncResult dikembalikan oleh BeginExecuteNonQuery 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 apa pun yang panjangnya lebih dari 2.033 karakter dalam beberapa baris masing-masing 2.033 karakter. Untuk menghindari perilaku ini, gunakan ExecuteXmlReader atau BeginExecuteXmlReader untuk membaca kueri XML FOR.
Metode ini mengabaikan CommandTimeout properti .
Lihat juga
- Menyambungkan dan Mengambil Data di ADO.NET
- Menggunakan Penyedia Data .NET Framework untuk SQL Server
- Ringkasan ADO.NET
Berlaku untuk
BeginExecuteReader(AsyncCallback, Object)
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand dan mengambil satu atau beberapa tataan hasil dari server, mengingat prosedur panggilan balik dan informasi status.
public:
IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject);public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject);member this.BeginExecuteReader : AsyncCallback * obj -> IAsyncResultPublic Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object) As IAsyncResultParameter
- callback
- AsyncCallback
Delegasi AsyncCallback yang dipanggil ketika eksekusi perintah telah selesai. Teruskan 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 saat memanggil EndExecuteReader(IAsyncResult), yang mengembalikan instans SqlDataReader yang dapat digunakan untuk mengambil baris yang dikembalikan.
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.
Pasangan nama/nilai "Pemrosesan Asinkron=true" tidak disertakan dalam string koneksi mendefinisikan koneksi untuk ini SqlCommand.
-atau-
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Terjadi kesalahan dalam Streamobjek , 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 BeginExecuteReader, menjalankan pernyataan Transact-SQL yang mencakup penundaan beberapa detik (meniru perintah yang berjalan lama). Karena sampel menjalankan perintah secara asinkron, formulir tetap responsif sambil menunggu hasilnya. Contoh ini meneruskan SqlCommand objek yang dieksekusi sebagai stateObject parameter; melakukannya memudahkan untuk mengambil SqlCommand objek dari dalam prosedur panggilan balik, sehingga kode dapat memanggil EndExecuteReader metode yang sesuai dengan panggilan awal ke BeginExecuteReader.
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, DataGridView 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.
using System.Data.SqlClient;
namespace Microsoft.AdoDotNet.CodeSamples
{
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
}
// Hook up the form's Load event handler (you can double-click on
// the form's design surface in Visual Studio), and then add
// this code to the form's class:
// You need this delegate in order to fill the grid from
// a thread other than the form's thread. See the HandleCallback
// procedure for more information.
private delegate void FillGridDelegate(SqlDataReader reader);
// You need this delegate to update the status bar.
private delegate void DisplayStatusDelegate(string Text);
// This flag ensures that the user does not attempt
// to restart the command or close the form while the
// asynchronous command is executing.
private bool isExecuting = false;
// Because the overloaded version of BeginExecuteReader
// demonstrated here does not allow you to have the connection
// closed automatically, this example maintains the
// connection object externally, so that it is available for closing.
private SqlConnection connection = null;
private void DisplayStatus(string Text)
{
this.label1.Text = Text;
}
private void FillGrid(SqlDataReader reader)
{
try
{
DataTable table = new DataTable();
table.Load(reader);
this.dataGridView1.DataSource = table;
DisplayStatus("Ready");
}
catch (Exception ex)
{
// Because you are guaranteed this procedure
// is running from within the form's thread,
// it can directly interact with members of the form.
DisplayStatus(string.Format("Ready (last attempt failed: {0})",
ex.Message));
}
finally
{
// Do not forget to close the connection, as well.
if (reader != null)
{
reader.Close();
}
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;
SqlDataReader reader = command.EndExecuteReader(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. Therefore you cannot simply call code that
// fills the grid, like this:
// FillGrid(reader);
// 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.
FillGridDelegate del = new FillGridDelegate(FillGrid);
this.Invoke(del, reader);
// Do not close the reader here, because it is being used in
// a separate thread. Instead, have the procedure you have
// called close the reader once it is done with it.
}
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 there is none of
// your code 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 DisplayStatusDelegate(DisplayStatus),
"Error: " + ex.Message);
}
finally
{
isExecuting = false;
}
}
private string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
// If you do not include the Asynchronous Processing=true name/value pair,
// you wo not be able to execute the command asynchronously.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks; Asynchronous Processing=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
{
DisplayStatus("Connecting...");
connection = new SqlConnection(GetConnectionString());
// To emulate a long-running query, wait for
// a few seconds before retrieving the real data.
command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
"SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
connection);
connection.Open();
DisplayStatus("Executing...");
isExecuting = true;
// Although it is not required that you pass the
// SqlCommand object as the second parameter in the
// BeginExecuteReader call, doing so makes it easier
// to call EndExecuteReader in the callback procedure.
AsyncCallback callback = new AsyncCallback(HandleCallback);
command.BeginExecuteReader(callback, command);
}
catch (Exception ex)
{
DisplayStatus("Error: " + ex.Message);
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 FormClosingEventHandler(Form1_FormClosing);
}
void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this, "Cannot close the form until " +
"the pending asynchronous command has completed. Please wait...");
e.Cancel = true;
}
}
}
}
Imports System.Data.SqlClient
Public Class Form1
' Add this code to the form's class:
' You need this delegate in order to fill the grid from
' a thread other than the form's thread. See the HandleCallback
' procedure for more information.
Private Delegate Sub FillGridDelegate(ByVal reader As SqlDataReader)
' You need this delegate to update the status bar.
Private Delegate Sub DisplayStatusDelegate(ByVal Text As String)
' This flag ensures that the user does not attempt
' to restart the command or close the form while the
' asynchronous command is executing.
Private isExecuting As Boolean
' Because the overloaded version of BeginExecuteReader
' demonstrated here does not allow you to have the connection
' closed automatically, this example maintains the
' connection object externally, so that it is available for closing.
Private connection As SqlConnection
Private Sub DisplayStatus(ByVal Text As String)
Me.Label1.Text = Text
End Sub
Private Sub FillGrid(ByVal reader As SqlDataReader)
Try
Dim table As New DataTable
table.Load(reader)
Me.DataGridView1.DataSource = table
DisplayStatus("Ready")
Catch ex As Exception
' Because you are guaranteed this procedure
' is running from within the form's thread,
' it can directly interact with members of the form.
DisplayStatus(String.Format("Ready (last attempt failed: {0})", ex.Message))
Finally
' Do not forget to close the connection, as well.
If Not reader Is Nothing Then
reader.Close()
End If
If Not connection Is Nothing Then
connection.Close()
End If
End Try
End Sub
Private Sub HandleCallback(ByVal result As IAsyncResult)
Try
' Retrieve the original command object, passed
' to this procedure in the AsyncState property
' of the IAsyncResult parameter.
Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
Dim reader As SqlDataReader = command.EndExecuteReader(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. Therefore you cannot simply call code that
' fills the grid, like this:
' FillGrid(reader)
' 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.
Dim del As New FillGridDelegate(AddressOf FillGrid)
Me.Invoke(del, reader)
' Do not close the reader here, because it is being used in
' a separate thread. Instead, have the procedure you have
' called close the reader once it is done with it.
Catch ex As Exception
' 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 there is none of
' your code 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:
Me.Invoke(New DisplayStatusDelegate(AddressOf DisplayStatus), _
"Error: " & ex.Message)
Finally
isExecuting = False
End Try
End Sub
Private Function GetConnectionString() As String
' To avoid storing the connection string in your code,
' you can retrieve it from a configuration file.
' If you do not include the Asynchronous Processing=true name/value pair,
' you wo not be able to execute the command asynchronously.
Return "Data Source=(local);Integrated Security=true;" & _
"Initial Catalog=AdventureWorks; Asynchronous Processing=true"
End Function
Private Sub Button1_Click(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles Button1.Click
If isExecuting Then
MessageBox.Show(Me, _
"Already executing. Please wait until the current query " & _
"has completed.")
Else
Dim command As SqlCommand
Try
DisplayStatus("Connecting...")
connection = New SqlConnection(GetConnectionString())
' To emulate a long-running query, wait for
' a few seconds before retrieving the real data.
command = New SqlCommand( _
"WAITFOR DELAY '0:0:5';" & _
"SELECT ProductID, Name, ListPrice, Weight FROM Production.Product", _
connection)
connection.Open()
DisplayStatus("Executing...")
isExecuting = True
' Although it is not required that you pass the
' SqlCommand object as the second parameter in the
' BeginExecuteReader call, doing so makes it easier
' to call EndExecuteReader in the callback procedure.
Dim callback As New AsyncCallback(AddressOf HandleCallback)
command.BeginExecuteReader(callback, command)
Catch ex As Exception
DisplayStatus("Error: " & ex.Message)
If connection IsNot Nothing Then
connection.Close()
End If
End Try
End If
End Sub
Private Sub Form1_FormClosing(ByVal sender As Object, _
ByVal e As System.Windows.Forms.FormClosingEventArgs) _
Handles Me.FormClosing
If isExecuting Then
MessageBox.Show(Me, "Cannot close the form until " & _
"the pending asynchronous command has completed. Please wait...")
e.Cancel = True
End If
End Sub
End Class
Keterangan
Metode ini BeginExecuteReader memulai proses menjalankan pernyataan Transact-SQL secara asinkron atau prosedur tersimpan yang mengembalikan baris, sehingga tugas lain dapat berjalan secara bersamaan saat pernyataan sedang dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteReader metode untuk menyelesaikan operasi dan mengambil yang SqlDataReader dikembalikan oleh perintah . Metode ini BeginExecuteReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang sesuai EndExecuteReader , metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Parameter callback memungkinkan Anda menentukan AsyncCallback delegasi yang dipanggil ketika pernyataan telah selesai. Anda dapat memanggil EndExecuteReader 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. Meskipun eksekusi perintah tidak sinkron, pengambilan nilai masih sinkron. Ini berarti bahwa panggilan ke Read dapat memblokir jika lebih banyak data diperlukan dan blok operasi baca jaringan yang mendasar.
Karena prosedur panggilan balik dijalankan dari dalam utas latar belakang yang disediakan oleh runtime Microsoft .NET, sangat penting bagi Anda untuk mengambil pendekatan ketat untuk menangani interaksi lintas alur dari dalam aplikasi Anda. Misalnya, Anda tidak boleh berinteraksi dengan konten formulir dari dalam prosedur panggilan balik Anda; jika Anda harus memperbarui formulir, Anda harus beralih kembali ke utas formulir untuk melakukan pekerjaan Anda. Contoh dalam topik ini menunjukkan perilaku ini.
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 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 .
Lihat juga
- Menyambungkan dan Mengambil Data dalam ADO.NET
- Menggunakan Penyedia Data .NET Framework untuk SQL Server
- Ringkasan ADO.NET
Berlaku untuk
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand, menggunakan salah CommandBehavior satu nilai, dan mengambil satu atau beberapa tataan hasil dari server, mengingat prosedur panggilan balik dan informasi status.
public:
IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject, System::Data::CommandBehavior behavior);public IAsyncResult BeginExecuteReader (AsyncCallback callback, object stateObject, System.Data.CommandBehavior behavior);member this.BeginExecuteReader : AsyncCallback * obj * System.Data.CommandBehavior -> IAsyncResultPublic Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object, behavior As CommandBehavior) As IAsyncResultParameter
- callback
- AsyncCallback
Delegasi AsyncCallback yang dipanggil ketika eksekusi perintah telah selesai. Teruskan 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 .
- behavior
- CommandBehavior
Salah CommandBehavior satu nilai, menunjukkan opsi untuk eksekusi pernyataan dan pengambilan data.
Mengembalikan
Yang IAsyncResult dapat digunakan untuk melakukan polling atau menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil EndExecuteReader(IAsyncResult), yang mengembalikan instans SqlDataReader yang dapat digunakan untuk mengambil baris yang dikembalikan.
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.
Pasangan nama/nilai "Pemrosesan Asinkron=true" tidak disertakan dalam string koneksi mendefinisikan koneksi untuk ini SqlCommand.
-atau-
Ditutup SqlConnection atau dihilangkan selama operasi streaming. Untuk informasi selengkapnya tentang streaming, lihat Dukungan Streaming SqlClient.
Terjadi kesalahan dalam Streamobjek , 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 BeginExecuteReader, menjalankan pernyataan Transact-SQL yang mencakup penundaan beberapa detik (meniru perintah yang berjalan lama). Karena sampel menjalankan perintah secara asinkron, formulir tetap responsif sambil menunggu hasilnya. Contoh ini meneruskan SqlCommand objek yang dieksekusi sebagai stateObject parameter; melakukannya memudahkan untuk mengambil SqlCommand objek dari dalam prosedur panggilan balik, sehingga kode dapat memanggil EndExecuteReader metode yang sesuai dengan panggilan awal ke BeginExecuteReader.
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, DataGridView 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.
Contoh ini meneruskan CommandBehavior.CloseConnection nilai dalam behavior parameter, menyebabkan yang dikembalikan SqlDataReader secara otomatis menutup koneksinya saat ditutup.
using System.Data.SqlClient;
namespace Microsoft.AdoDotNet.CodeSamples
{
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
}
// Hook up the form's Load event handler (you can double-click on
// the form's design surface in Visual Studio), and then add
// this code to the form's class:
// You need this delegate in order to fill the grid from
// a thread other than the form's thread. See the HandleCallback
// procedure for more information.
private delegate void FillGridDelegate(SqlDataReader reader);
// You need this delegate to update the status bar.
private delegate void DisplayStatusDelegate(string Text);
// This flag ensures that the user does not attempt
// to restart the command or close the form while the
// asynchronous command is executing.
private bool isExecuting;
private void DisplayStatus(string Text)
{
this.label1.Text = Text;
}
private void FillGrid(SqlDataReader reader)
{
try
{
DataTable table = new DataTable();
table.Load(reader);
this.dataGridView1.DataSource = table;
DisplayStatus("Ready");
}
catch (Exception ex)
{
// Because you are guaranteed this procedure
// is running from within the form's thread,
// it can directly interact with members of the form.
DisplayStatus(string.Format("Ready (last attempt failed: {0})",
ex.Message));
}
finally
{
// Closing the reader also closes the connection,
// because this reader was created using the
// CommandBehavior.CloseConnection value.
if (reader != null)
{
reader.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;
SqlDataReader reader = command.EndExecuteReader(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. Therefore you cannot simply call code that
// fills the grid, like this:
// FillGrid(reader);
// 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.
FillGridDelegate del = new FillGridDelegate(FillGrid);
this.Invoke(del, reader);
// Do not close the reader here, because it is being used in
// a separate thread. Instead, have the procedure you have
// called close the reader once it is done with it.
}
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 there is none of
// your code 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 DisplayStatusDelegate(DisplayStatus), "Error: " +
ex.Message);
}
finally
{
isExecuting = false;
}
}
private string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
// If you do not include the Asynchronous Processing=true name/value pair,
// you wo not be able to execute the command asynchronously.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks; Asynchronous Processing=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;
SqlConnection connection = null;
try
{
DisplayStatus("Connecting...");
connection = new SqlConnection(GetConnectionString());
// To emulate a long-running query, wait for
// a few seconds before retrieving the real data.
command = new SqlCommand("WAITFOR DELAY '0:0:5';" +
"SELECT ProductID, Name, ListPrice, Weight FROM Production.Product",
connection);
connection.Open();
DisplayStatus("Executing...");
isExecuting = true;
// Although it is not required that you pass the
// SqlCommand object as the second parameter in the
// BeginExecuteReader call, doing so makes it easier
// to call EndExecuteReader in the callback procedure.
AsyncCallback callback = new AsyncCallback(HandleCallback);
command.BeginExecuteReader(callback, command,
CommandBehavior.CloseConnection);
}
catch (Exception ex)
{
DisplayStatus("Error: " + ex.Message);
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 FormClosingEventHandler(Form1_FormClosing);
}
void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this, "Cannot close the form until " +
"the pending asynchronous command has completed. Please wait...");
e.Cancel = true;
}
}
}
}
Imports System.Data.SqlClient
Public Class Form1
' Add this code to the form's class:
' You this delegate in order to fill the grid from
' a thread other than the form's thread. See the HandleCallback
' procedure for more information.
Private Delegate Sub FillGridDelegate(ByVal reader As SqlDataReader)
' You need this delegate to update the status bar.
Private Delegate Sub DisplayStatusDelegate(ByVal Text As String)
' This flag ensures that the user does not attempt
' to restart the command or close the form while the
' asynchronous command is executing.
Private isExecuting As Boolean
Private Sub DisplayStatus(ByVal Text As String)
Me.Label1.Text = Text
End Sub
Private Sub FillGrid(ByVal reader As SqlDataReader)
Try
Dim table As New DataTable
table.Load(reader)
Me.DataGridView1.DataSource = table
DisplayStatus("Ready")
Catch ex As Exception
' Because you are guaranteed this procedure
' is running from within the form's thread,
' it can directly interact with members of the form.
DisplayStatus(String.Format("Ready (last attempt failed: {0})", ex.Message))
Finally
' Closing the reader also closes the connection,
' because this reader was created using the
' CommandBehavior.CloseConnection value.
If reader IsNot Nothing Then
reader.Close()
End If
End Try
End Sub
Private Sub HandleCallback(ByVal result As IAsyncResult)
Try
' Retrieve the original command object, passed
' to this procedure in the AsyncState property
' of the IAsyncResult parameter.
Dim command As SqlCommand = CType(result.AsyncState, SqlCommand)
Dim reader As SqlDataReader = command.EndExecuteReader(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. Therefore you cannot simply call code that
' fills the grid, like this:
' FillGrid(reader)
' 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.
Dim del As New FillGridDelegate(AddressOf FillGrid)
Me.Invoke(del, reader)
' Do not close the reader here, because it is being used in
' a separate thread. Instead, have the procedure you have
' called close the reader once it is done with it.
Catch ex As Exception
' 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 there is none of
' your code 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:
Me.Invoke(New DisplayStatusDelegate(AddressOf DisplayStatus), _
"Error: " & ex.Message)
Finally
isExecuting = False
End Try
End Sub
Private Function GetConnectionString() As String
' To avoid storing the connection string in your code,
' you can retrieve it from a configuration file.
' If you do not include the Asynchronous Processing=true name/value pair,
' you wo not be able to execute the command asynchronously.
Return "Data Source=(local);Integrated Security=true;" & _
"Initial Catalog=AdventureWorks; Asynchronous Processing=true"
End Function
Private Sub Button1_Click(ByVal sender As System.Object, _
ByVal e As System.EventArgs) Handles Button1.Click
If isExecuting Then
MessageBox.Show(Me, "Already executing. Please wait until the current query " & _
"has completed.")
Else
Dim connection As SqlConnection
Dim command As SqlCommand
Try
DisplayStatus("Connecting...")
connection = New SqlConnection(GetConnectionString())
' To emulate a long-running query, wait for
' a few seconds before retrieving the real data.
command = New SqlCommand( _
"WAITFOR DELAY '0:0:5';" & _
"SELECT ProductID, Name, ListPrice, Weight FROM Production.Product", _
connection)
connection.Open()
DisplayStatus("Executing...")
isExecuting = True
' Although it is not required that you pass the
' SqlCommand object as the second parameter in the
' BeginExecuteReader call, doing so makes it easier
' to call EndExecuteReader in the callback procedure.
Dim callback As New AsyncCallback(AddressOf HandleCallback)
command.BeginExecuteReader(callback, command, _
CommandBehavior.CloseConnection)
Catch ex As Exception
DisplayStatus("Error: " & ex.Message)
If connection IsNot Nothing Then
connection.Close()
End If
End Try
End If
End Sub
Private Sub Form1_FormClosing(ByVal sender As Object, _
ByVal e As System.Windows.Forms.FormClosingEventArgs) Handles Me.FormClosing
If isExecuting Then
MessageBox.Show(Me, "Cannot close the form until " & _
"the pending asynchronous command has completed. Please wait...")
e.Cancel = True
End If
End Sub
End Class
Keterangan
Metode ini BeginExecuteReader memulai proses menjalankan pernyataan Transact-SQL secara asinkron atau prosedur tersimpan yang mengembalikan baris, sehingga tugas lain dapat berjalan secara bersamaan saat pernyataan sedang dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteReader metode untuk menyelesaikan operasi dan mengambil yang SqlDataReader dikembalikan oleh perintah . Metode ini BeginExecuteReader segera kembali, tetapi sampai kode menjalankan panggilan metode yang sesuai EndExecuteReader , metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteReader sebelum eksekusi perintah selesai menyebabkan objek diblokir SqlCommand hingga eksekusi selesai.
Parameter callback memungkinkan Anda menentukan AsyncCallback delegasi yang dipanggil ketika pernyataan telah selesai. Anda dapat memanggil EndExecuteReader 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 .
Parameter behavior memungkinkan Anda menentukan opsi yang mengontrol perilaku perintah dan koneksinya. Nilai-nilai ini dapat digabungkan bersama-sama (menggunakan operator bahasa Or pemrograman); umumnya, pengembang menggunakan CloseConnection nilai untuk memastikan bahwa koneksi ditutup oleh runtime saat SqlDataReader ditutup. Pengembang juga dapat mengoptimalkan perilaku SqlDataReader dengan menentukan SingleRow nilai ketika diketahui terlebih dahulu bahwa pernyataan Transact-SQL atau prosedur tersimpan hanya mengembalikan satu baris.
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. Ini berarti bahwa panggilan ke Read dapat memblokir jika lebih banyak data diperlukan dan blok operasi baca jaringan yang mendasar.
Karena prosedur panggilan balik dijalankan dari dalam utas latar belakang yang disediakan oleh runtime bahasa umum Microsoft .NET, sangat penting bagi Anda untuk mengambil pendekatan ketat untuk menangani interaksi lintas alur dari dalam aplikasi Anda. Misalnya, Anda tidak boleh berinteraksi dengan konten formulir dari dalam prosedur panggilan balik Anda--jika Anda harus memperbarui formulir, Anda harus beralih kembali ke utas formulir untuk melakukan pekerjaan Anda. Contoh dalam topik ini menunjukkan perilaku ini.
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 .
Lihat juga
- Menyambungkan dan Mengambil Data dalam ADO.NET
- Menggunakan Penyedia Data .NET Framework untuk SQL Server
- Ringkasan ADO.NET
