SqlCommand.BeginExecuteNonQuery 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
| BeginExecuteNonQuery() |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand . |
| BeginExecuteNonQuery(AsyncCallback, Object) |
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand , mengingat prosedur panggilan balik dan informasi status. |
BeginExecuteNonQuery()
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand .
public:
IAsyncResult ^ BeginExecuteNonQuery();public IAsyncResult BeginExecuteNonQuery ();member this.BeginExecuteNonQuery : unit -> IAsyncResultPublic Function BeginExecuteNonQuery () As IAsyncResultMengembalikan
IAsyncResult yang dapat digunakan untuk melakukan polling atau menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil EndExecuteNonQuery(IAsyncResult) , yang mengembalikan jumlah baris yang terpengaruh.
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 membuat data pembaruan dalam database sampel AdventureWorks , melakukan pekerjaannya secara asinkron. Untuk meniru proses yang berjalan lama, contoh ini menyisipkan pernyataan WAITFOR dalam teks perintah. Biasanya, Anda tidak akan mengambil upaya untuk membuat perintah Anda berjalan lebih lambat, tetapi melakukan ini dalam hal ini membuatnya lebih mudah untuk menunjukkan perilaku asinkron.
// <Snippet1>
using System;
using System.Data;
using Microsoft.Data.SqlClient;
class Class1
{
static void Main()
{
// This is a simple example that demonstrates the usage of the
// BeginExecuteNonQuery functionality.
// The WAITFOR statement simply adds enough time to prove the
// asynchronous nature of the command.
string commandText =
"UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
"WHERE ReorderPoint Is Not Null;" +
"WAITFOR DELAY '0:0:3';" +
"UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
"WHERE ReorderPoint Is Not Null";
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
{
int count = 0;
SqlCommand command = new SqlCommand(commandText, connection);
connection.Open();
IAsyncResult result = command.BeginExecuteNonQuery();
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);
}
Console.WriteLine("Command complete. Affected {0} rows.",
command.EndExecuteNonQuery(result));
}
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 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=SSPI;" +
"Initial Catalog=AdventureWorks";
}
}
// </Snippet1>
Keterangan
Metode ini BeginExecuteNonQuery memulai proses menjalankan pernyataan Transact-SQL secara asinkron atau prosedur tersimpan yang tidak mengembalikan baris, sehingga tugas lain dapat berjalan bersamaan saat pernyataan sedang dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteNonQuery metode untuk menyelesaikan operasi. Metode ini BeginExecuteNonQuery segera kembali, tetapi sampai kode menjalankan panggilan metode yang sesuai EndExecuteNonQuery , metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteNonQuery 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 tidak sinkron.
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.
Metode ini mengabaikan CommandTimeout properti .
Berlaku untuk
BeginExecuteNonQuery(AsyncCallback, Object)
Memulai eksekusi asinkron dari pernyataan Transact-SQL atau prosedur tersimpan yang dijelaskan oleh ini SqlCommand , mengingat prosedur panggilan balik dan informasi status.
public:
IAsyncResult ^ BeginExecuteNonQuery(AsyncCallback ^ callback, System::Object ^ stateObject);public IAsyncResult BeginExecuteNonQuery (AsyncCallback callback, object stateObject);member this.BeginExecuteNonQuery : AsyncCallback * obj -> IAsyncResultPublic Function BeginExecuteNonQuery (callback As AsyncCallback, stateObject As Object) As IAsyncResultParameter
- callback
- AsyncCallback
Delegasi AsyncCallback yang dipanggil ketika eksekusi perintah telah selesai. Lulusnull ( 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
IAsyncResult yang dapat digunakan untuk melakukan polling atau menunggu hasil, atau keduanya; nilai ini juga diperlukan saat memanggil EndExecuteNonQuery(IAsyncResult) , yang mengembalikan jumlah baris yang terpengaruh.
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.
Contoh
Aplikasi Windows berikut menunjukkan penggunaan BeginExecuteNonQuery metode , menjalankan pernyataan Transact-SQL yang mencakup penundaan beberapa detik (meniru perintah yang berjalan lama).
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 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;
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:
private void Form1_Load(object sender, EventArgs e)
{
this.button1.Click += new System.EventHandler(this.button1_Click);
this.FormClosing += new System.Windows.Forms.
FormClosingEventHandler(this.Form1_FormClosing);
}
// You need this delegate in order to display text from a thread
// other than the form's thread. See the HandleCallback
// procedure for more information.
// This same delegate matches both the DisplayStatus
// and DisplayResults methods.
private delegate void DisplayInfoDelegate(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;
// This example maintains the connection object
// externally, so that it is available for closing.
private SqlConnection connection;
private static string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
private void DisplayStatus(string Text)
{
this.label1.Text = Text;
}
private void DisplayResults(string Text)
{
this.label1.Text = Text;
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
{
DisplayResults("");
DisplayStatus("Connecting...");
connection = new SqlConnection(GetConnectionString());
// To emulate a long-running query, wait for
// a few seconds before working with the data.
// This command does not do much, but that's the point--
// it does not change your data, in the long run.
string commandText =
"WAITFOR DELAY '0:0:05';" +
"UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
"WHERE ReorderPoint Is Not Null;" +
"UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
"WHERE ReorderPoint Is Not Null";
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
// BeginExecuteNonQuery call, doing so makes it easier
// to call EndExecuteNonQuery in the callback procedure.
AsyncCallback callback = new AsyncCallback(HandleCallback);
command.BeginExecuteNonQuery(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;
int rowCount = command.EndExecuteNonQuery(result);
string rowText = " rows affected.";
if (rowCount == 1)
{
rowText = " row affected.";
}
rowText = rowCount + rowText;
// 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
// displays the results, like this:
// DisplayResults(rowText)
// 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.
DisplayInfoDelegate del = new DisplayInfoDelegate(DisplayResults);
this.Invoke(del, rowText);
}
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();
}
}
}
}
}
// </Snippet1>
Keterangan
Metode ini BeginExecuteNonQuery memulai proses menjalankan pernyataan Transact-SQL secara asinkron atau prosedur tersimpan yang tidak mengembalikan baris, sehingga tugas lain dapat berjalan bersamaan saat pernyataan sedang dijalankan. Ketika pernyataan telah selesai, pengembang harus memanggil EndExecuteNonQuery metode untuk menyelesaikan operasi. Metode ini BeginExecuteNonQuery segera kembali, tetapi sampai kode menjalankan panggilan metode yang sesuai EndExecuteNonQuery , metode tersebut tidak boleh menjalankan panggilan lain yang memulai eksekusi sinkron atau asinkron terhadap objek yang sama SqlCommand . Memanggil EndExecuteNonQuery 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 EndExecuteNonQuery metode dari dalam prosedur delegasi ini, atau dari lokasi lain dalam aplikasi Anda. Selain itu, Anda dapat meneruskan objek apa pun dalam asyncStateObject 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.
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.
Metode ini mengabaikan CommandTimeout properti .