SqlCommand.BeginExecuteNonQuery Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Přetížení
| BeginExecuteNonQuery() |
Inicializuje asynchronní provádění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand . |
| BeginExecuteNonQuery(AsyncCallback, Object) |
Inicializuje asynchronní provádění Transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand , vzhledem k postupu zpětného volání a informace o stavu. |
BeginExecuteNonQuery()
Inicializuje asynchronní provádění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand .
public:
IAsyncResult ^ BeginExecuteNonQuery();public IAsyncResult BeginExecuteNonQuery ();member this.BeginExecuteNonQuery : unit -> IAsyncResultPublic Function BeginExecuteNonQuery () As IAsyncResultNávraty
Hodnota IAsyncResult , která se dá použít k dotazování nebo čekání na výsledky, nebo obojí; tato hodnota je také potřeba při vyvolání EndExecuteNonQuery(IAsyncResult) , která vrátí počet ovlivněných řádků.
Výjimky
Při SqlDbType nastavení na Stream hodnotu byla použita Value jiná hodnota než Binary nebo VarBinary. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
-nebo-
Při SqlDbType nastavení na TextReader hodnotu se použila Value jiná hodnota než Char, NChar, NVarChar, VarChar nebo Xml.
-nebo-
Při SqlDbType nastavení na XmlReader hodnotu byla použita Value jiná hodnota než XML.
Všechny chyby, ke kterým došlo při provádění textu příkazu.
-nebo-
Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Zavřený SqlConnection nebo vynechaný během operace streamování. Další informace o streamování najdete v tématu Podpora streamování 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.
Během operace streamování došlo v objektu Stream nebo TextReaderXmlReader k chybě. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Objekt Stream , XmlReader nebo TextReader byl uzavřen během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Příklady
Následující konzolová aplikace vytváří data aktualizací v ukázkové databázi AdventureWorks a provádí svou práci asynchronně. Aby bylo možné emulovat dlouhotrvající proces, vloží tento příklad do textu příkazu příkaz WAITFOR. Za normálních okolností byste nevyužívali úsilí k tomu, aby příkazy běžely pomaleji, ale v tomto případě to usnadňuje předvedení asynchronního chování.
// <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>
Poznámky
Metoda BeginExecuteNonQuery spustí proces asynchronního spuštění příkazu jazyka Transact-SQL nebo uložené procedury, která nevrací řádky, aby další úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři k dokončení operace volat EndExecuteNonQuery metodu . Metoda BeginExecuteNonQuery vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteNonQuery volání metody, nesmí spouštět žádná jiná volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteNonQuery Volání metody před dokončením provádění příkazu způsobí, že SqlCommand se objekt zablokuje, dokud se provádění nedokončí.
Všimněte si, že text příkazu a parametry se na server odesílají synchronně. Pokud je odeslán velký příkaz nebo mnoho parametrů, tato metoda může blokovat během zápisu. Po odeslání příkazu se metoda okamžitě vrátí, aniž by čekala na odpověď ze serveru – to znamená, že čtení jsou asynchronní.
Vzhledem k tomu, že toto přetížení nepodporuje proceduru zpětného volání, musí se vývojáři dotazovat, zda byl příkaz dokončen, pomocí IsCompleted vlastnosti IAsyncResult vrácené metodou BeginExecuteNonQuery ; nebo počkat na dokončení jednoho nebo více příkazů pomocí AsyncWaitHandle vlastnosti vráceného IAsyncResultobjektu .
Tato metoda ignoruje CommandTimeout vlastnost .
Platí pro
BeginExecuteNonQuery(AsyncCallback, Object)
Inicializuje asynchronní provádění Transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand , vzhledem k postupu zpětného volání a informace o stavu.
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 IAsyncResultParametry
- callback
- AsyncCallback
Delegát AsyncCallback , který je vyvolán po dokončení provádění příkazu. Úspěšné absolvovánínull ( Nothing v jazyce Microsoft Visual Basic) označující, že není vyžadováno žádné zpětné volání.
- stateObject
- Object
Uživatelem definovaný objekt stavu, který je předán procedura zpětného volání. Načtěte tento objekt z procedury zpětného volání pomocí AsyncState vlastnosti .
Návraty
Hodnota IAsyncResult , která se dá použít k dotazování nebo čekání na výsledky, nebo obojí; tato hodnota je také potřeba při vyvolání EndExecuteNonQuery(IAsyncResult) , která vrátí počet ovlivněných řádků.
Výjimky
Při SqlDbType nastavení na Stream hodnotu byla použita Value jiná hodnota než Binary nebo VarBinary. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
-nebo-
Při SqlDbType nastavení na TextReader hodnotu se použila Value jiná hodnota než Char, NChar, NVarChar, VarChar nebo Xml.
-nebo-
Při SqlDbType nastavení na XmlReader hodnotu byla použita Value jiná hodnota než XML.
Všechny chyby, ke kterým došlo při provádění textu příkazu.
-nebo-
Během operace streamování došlo k vypršení časového limitu. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
Zavřený SqlConnection nebo vynechaný během operace streamování. Další informace o streamování najdete v tématu Podpora streamování 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.
Příklady
Následující aplikace systému Windows demonstruje použití BeginExecuteNonQuery metody, spuštění příkazu jazyka Transact-SQL, který obsahuje zpoždění několik sekund (emuluje dlouhotrvající příkaz).
Tento příklad ukazuje mnoho důležitých technik. To zahrnuje volání metody, která komunikuje s formulářem ze samostatného vlákna. Kromě toho tento příklad ukazuje, jak je nutné blokovat uživatelům spuštění příkazu vícekrát současně a jak se musíte ujistit, že formulář se nezavře před voláním procedury zpětného volání.
Pokud chcete nastavit tento příklad, vytvořte novou aplikaci pro Windows. Button Umístěte ovládací prvek a Label ovládací prvek do formuláře (přijměte výchozí název každého ovládacího prvku). Do třídy formuláře přidejte následující kód a upravte připojovací řetězec podle potřeby pro vaše prostředí.
// <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>
Poznámky
Metoda BeginExecuteNonQuery spustí proces asynchronního spuštění příkazu jazyka Transact-SQL nebo uložené procedury, která nevrací řádky, aby další úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři k dokončení operace volat EndExecuteNonQuery metodu . Metoda BeginExecuteNonQuery vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteNonQuery volání metody, nesmí spouštět žádná jiná volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteNonQuery Volání metody před dokončením provádění příkazu způsobí, že SqlCommand se objekt zablokuje, dokud se provádění nedokončí.
Parametr callback umožňuje určit delegáta AsyncCallback , který se volá po dokončení příkazu. Metodu EndExecuteNonQuery můžete volat z této procedury delegáta nebo z libovolného jiného umístění v rámci vaší aplikace. Kromě toho můžete předat libovolný objekt v parametru asyncStateObject a procedura zpětného volání může tyto informace načíst pomocí AsyncState vlastnosti .
Všimněte si, že text příkazu a parametry se na server odesílají synchronně. Pokud je odeslán velký příkaz nebo mnoho parametrů, tato metoda může blokovat během zápisu. Po odeslání příkazu se metoda okamžitě vrátí, aniž by čekala na odpověď ze serveru – to znamená, že čtení jsou asynchronní.
Vzhledem k tomu, že procedura zpětného volání se spouští z vlákna na pozadí, které poskytuje modul runtime Microsoft .NET Common Language Runtime, je velmi důležité, abyste ve svých aplikacích provedli přísný přístup ke zpracování interakcí mezi vlákny. Například nesmíte pracovat s obsahem formuláře v rámci postupu zpětného volání; Pokud budete muset formulář aktualizovat, musíte přepnout zpět do vlákna formuláře, abyste mohli pracovat. Příklad v tomto tématu ukazuje toto chování.
Všechny chyby, ke kterým dojde během provádění operace, jsou vyvolán jako výjimky v proceduře zpětného volání. Výjimku musíte zpracovat v proceduře zpětného volání, nikoli v hlavní aplikaci. Další informace o zpracování výjimek v postupu zpětného volání najdete v příkladu v tomto tématu.
Tato metoda ignoruje CommandTimeout vlastnost .