SqlCommand.BeginExecuteNonQuery Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| BeginExecuteNonQuery() |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand . |
| BeginExecuteNonQuery(AsyncCallback, Object) |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand , en fonction d’une procédure de rappel et d’informations d’état. |
BeginExecuteNonQuery()
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand .
public:
IAsyncResult ^ BeginExecuteNonQuery();public IAsyncResult BeginExecuteNonQuery ();member this.BeginExecuteNonQuery : unit -> IAsyncResultPublic Function BeginExecuteNonQuery () As IAsyncResultRetours
IAsyncResult qui peut être utilisé pour interroger ou attendre des résultats, ou les deux ; cette valeur est également nécessaire lors de l’appel de EndExecuteNonQuery(IAsyncResult) , qui retourne le nombre de lignes affectées.
Exceptions
Autre SqlDbType que Binary ou VarBinary a été utilisé lorsque Value a été défini sur Stream . Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
- ou -
Autre SqlDbType que Char, NChar, NVarChar, VarChar ou Xml a été utilisé lorsque Value a été défini sur TextReader .
-ou-
Un SqlDbType autre que Xml a été utilisé lorsque Value a été défini sur XmlReader .
Toute erreur qui s’est produite pendant l’exécution du texte de la commande.
- ou -
Un délai d’attente a été dépassé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
La SqlConnection a été fermée ou supprimée pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour 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.
Une erreur s’est produite dans un Stream objet ou XmlReaderTextReader pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
L’objet Stream ou XmlReaderTextReader a été fermé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
Exemples
L’application console suivante crée des données de mise à jour dans l’exemple de base de données AdventureWorks , en effectuant son travail de manière asynchrone. Afin d’émuler un processus de longue durée, cet exemple insère une instruction WAITFOR dans le texte de la commande. Normalement, vous ne devez pas faire d’efforts pour que vos commandes s’exécutent plus lentement, mais dans ce cas, il est plus facile de démontrer le comportement asynchrone.
// <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>
Remarques
La BeginExecuteNonQuery méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL ou d’une procédure stockée qui ne retourne pas de lignes, afin que d’autres tâches puissent s’exécuter simultanément pendant l’exécution de l’instruction. Une fois l’instruction terminée, les développeurs doivent appeler la EndExecuteNonQuery méthode pour terminer l’opération. La BeginExecuteNonQuery méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteNonQuery , elle ne doit pas exécuter d’autres appels qui démarrent une exécution synchrone ou asynchrone sur le même SqlCommand objet. L’appel du EndExecuteNonQuery avant la fin de l’exécution de la commande entraîne le blocage de l’objet SqlCommand jusqu’à ce que l’exécution soit terminée.
Notez que le texte de la commande et les paramètres sont envoyés au serveur de manière synchrone. Si une commande volumineuse ou de nombreux paramètres sont envoyés, cette méthode peut se bloquer pendant les écritures. Une fois la commande envoyée, la méthode retourne immédiatement sans attendre une réponse du serveur, c’est-à-dire que les lectures sont asynchrones.
Étant donné que cette surcharge ne prend pas en charge une procédure de rappel, les développeurs doivent soit interroger pour déterminer si la commande est terminée, à l’aide de la IsCompletedIAsyncResult propriété du retourné par la BeginExecuteNonQuery méthode , soit attendre l’achèvement d’une ou plusieurs commandes à l’aide de la AsyncWaitHandle propriété du retourné IAsyncResult.
Cette méthode ignore la CommandTimeout propriété .
S’applique à
BeginExecuteNonQuery(AsyncCallback, Object)
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand , en fonction d’une procédure de rappel et d’informations d’état.
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 IAsyncResultParamètres
- callback
- AsyncCallback
Délégué AsyncCallback qui est appelé une fois l’exécution de la commande terminée. Réussitenull ( Nothing dans Microsoft Visual Basic) pour indiquer qu’aucun rappel n’est requis.
- stateObject
- Object
Objet d'état défini par l'utilisateur qui est transmis à la procédure de rappel. Récupérez cet objet à partir de la procédure de rappel à l’aide de la propriété AsyncState.
Retours
IAsyncResult qui peut être utilisé pour interroger ou attendre des résultats, ou les deux ; cette valeur est également nécessaire lors de l’appel de EndExecuteNonQuery(IAsyncResult) , qui retourne le nombre de lignes affectées.
Exceptions
Autre SqlDbType que Binary ou VarBinary a été utilisé lorsque Value a été défini sur Stream . Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
- ou -
Autre SqlDbType que Char, NChar, NVarChar, VarChar ou Xml a été utilisé lorsque Value a été défini sur TextReader .
-ou-
Un SqlDbType autre que Xml a été utilisé lorsque Value a été défini sur XmlReader .
Toute erreur qui s’est produite pendant l’exécution du texte de la commande.
- ou -
Un délai d’attente a été dépassé pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour SqlClient.
La SqlConnection a été fermée ou supprimée pendant une opération de diffusion en continu. Pour plus d’informations sur le streaming, consultez Prise en charge du streaming pour 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.
Exemples
L’application Windows suivante illustre l’utilisation de la BeginExecuteNonQuery méthode, en exécutant une instruction Transact-SQL qui inclut un délai de plusieurs secondes (émulation d’une commande de longue durée).
Cet exemple illustre de nombreuses techniques importantes. Cela inclut l’appel d’une méthode qui interagit avec le formulaire à partir d’un thread distinct. En outre, cet exemple montre comment vous devez empêcher les utilisateurs d’exécuter une commande plusieurs fois simultanément, et comment vous devez vous assurer que le formulaire ne se ferme pas avant l’appel de la procédure de rappel.
Pour configurer cet exemple, créez une nouvelle application Windows. Placez un Button contrôle et un Label contrôle sur le formulaire (en acceptant le nom par défaut pour chaque contrôle). Ajoutez le code suivant à la classe du formulaire, en modifiant la chaîne de connexion en fonction des besoins de votre environnement.
// <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>
Remarques
La BeginExecuteNonQuery méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL ou d’une procédure stockée qui ne retourne pas de lignes, afin que d’autres tâches puissent s’exécuter simultanément pendant l’exécution de l’instruction. Une fois l’instruction terminée, les développeurs doivent appeler la EndExecuteNonQuery méthode pour terminer l’opération. La BeginExecuteNonQuery méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteNonQuery , elle ne doit pas exécuter d’autres appels qui démarrent une exécution synchrone ou asynchrone sur le même SqlCommand objet. L’appel du EndExecuteNonQuery avant la fin de l’exécution de la commande entraîne le blocage de l’objet SqlCommand jusqu’à ce que l’exécution soit terminée.
Le callback paramètre vous permet de spécifier un AsyncCallback délégué appelé lorsque l’instruction est terminée. Vous pouvez appeler la EndExecuteNonQuery méthode à partir de cette procédure déléguée ou de n’importe quel autre emplacement au sein de votre application. En outre, vous pouvez passer n’importe quel objet dans le asyncStateObject paramètre, et votre procédure de rappel peut récupérer ces informations à l’aide de la AsyncState propriété .
Notez que le texte de la commande et les paramètres sont envoyés au serveur de manière synchrone. Si une commande volumineuse ou de nombreux paramètres sont envoyés, cette méthode peut se bloquer pendant les écritures. Une fois la commande envoyée, la méthode retourne immédiatement sans attendre une réponse du serveur, c’est-à-dire que les lectures sont asynchrones.
Étant donné que la procédure de rappel s’exécute à partir d’un thread d’arrière-plan fourni par le Common Language Runtime Microsoft .NET, il est très important que vous preniez une approche rigoureuse de la gestion des interactions entre threads à partir de vos applications. Par exemple, vous ne devez pas interagir avec le contenu d’un formulaire à partir de votre procédure de rappel ; si vous devez mettre à jour le formulaire, vous devez revenir au thread du formulaire pour effectuer votre travail. L’exemple de cette rubrique illustre ce comportement.
Toutes les erreurs qui se produisent pendant l’exécution de l’opération sont levées en tant qu’exceptions dans la procédure de rappel. Vous devez gérer l’exception dans la procédure de rappel, et non dans l’application principale. Pour plus d’informations sur la gestion des exceptions dans la procédure de rappel, consultez l’exemple de cette rubrique.
Cette méthode ignore la CommandTimeout propriété .