SqlCommand.BeginExecuteReader 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
| BeginExecuteReader() |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand et retourne les résultats sous forme d’objet XmlReader. |
| BeginExecuteReader(CommandBehavior) |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée qui est décrite par ce SqlCommand à l’aide de l’une des valeurs de CommandBehavior. |
| BeginExecuteReader(AsyncCallback, Object) |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée qui est décrite par cet SqlCommand et retourne les résultats en tant qu’objet XmlReader à l’aide d’une procédure de rappel. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand , à l’aide de l’un des éléments |
BeginExecuteReader()
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand et retourne les résultats sous forme d’objet XmlReader.
public:
IAsyncResult ^ BeginExecuteReader();public IAsyncResult BeginExecuteReader ();member this.BeginExecuteReader : unit -> IAsyncResultPublic Function BeginExecuteReader () As IAsyncResultRetours
IAsyncResult qui peut être utilisé pour interroger ou attendre les résultats, ou les deux ; cette valeur est également nécessaire lors de l’appelEndExecuteXmlReader , qui retourne une seule valeur XML.
Exceptions
Un SqlDbType autre 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 -
Un SqlDbType autre que Char, NChar, NVarChar, VarChar ou Xml a été utilisé quand 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 démarre le processus de récupération des données XML de manière asynchrone. En attendant les résultats, cette application simple se trouve dans une boucle, examinant la valeur de la IsCompleted propriété. Une fois le processus terminé, le code récupère le code XML et affiche son contenu.
[!code-csharp[SqlCommand_BeginExecuteXmlReader#1]((~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]
Remarques
La BeginExecuteXmlReader méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL qui retourne des lignes au format XML, 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 EndExecuteXmlReader méthode pour terminer l’opération et récupérer le code XML retourné par la commande. La BeginExecuteXmlReader méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteXmlReader , 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 EndExecuteXmlReader 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.
La CommandText propriété spécifie normalement une instruction Transact-SQL avec une clause FOR XML valide. Toutefois, CommandText peut également spécifier une instruction qui retourne ntext des données qui contiennent du code XML valide.
Une requête classique BeginExecuteXmlReader peut être mise en forme comme dans l’exemple C# suivant :
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Cette méthode peut également être utilisée pour récupérer un jeu de résultats à une seule ligne et à colonne unique. Dans ce cas, si plusieurs lignes sont retournées, la EndExecuteXmlReader méthode attache le XmlReader à la valeur de la première ligne et ignore le reste du jeu de résultats.
La fonctionnalité mars (multiple active result set) permet à plusieurs actions d’utiliser la même connexion.
Notez que le texte et les paramètres de la commande 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 la réponse du serveur. Autrement dit, les lectures sont asynchrones. Bien que l’exécution des commandes soit asynchrone, l’extraction de valeur est toujours synchrone.
Étant donné que cette surcharge ne prend pas en charge une procédure de rappel, les développeurs doivent interroger pour déterminer si la commande est terminée, à l’aide de la IsCompleted propriété du IAsyncResult retourné par la BeginExecuteXmlReader méthode ; ou attendre l’achèvement d’une ou plusieurs commandes à l’aide de la AsyncWaitHandle propriété du retourné IAsyncResult.
Si vous utilisez ExecuteReader ou BeginExecuteReader pour accéder à des données XML, SQL Server retourne les résultats XML d’une longueur supérieure à 2 033 caractères dans plusieurs lignes de 2 033 caractères chacune. Pour éviter ce comportement, utilisez ExecuteXmlReader ou BeginExecuteXmlReader pour lire des requêtes FOR XML.
Cette méthode ignore la CommandTimeout propriété .
S’applique à
BeginExecuteReader(CommandBehavior)
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée qui est décrite par ce SqlCommand à l’aide de l’une des valeurs de CommandBehavior.
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 IAsyncResultParamètres
- behavior
- CommandBehavior
Une des valeurs de CommandBehavior, indiquant les options pour l’exécution d’instructions et la récupération de données.
Retours
IAsyncResult qui peut être utilisé pour interroger, attendre les résultats ou les deux ; cette valeur est également nécessaire lors de l’appel de EndExecuteReader(IAsyncResult) , qui retourne une SqlDataReader instance qui peut être utilisée pour récupérer les lignes retournées.
Exceptions
Un SqlDbType autre 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 -
Un SqlDbType autre que Char, NChar, NVarChar, VarChar ou Xml a été utilisé quand 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 démarre le processus de récupération asynchrone d’un lecteur de données. En attendant les résultats, cette application simple se trouve dans une boucle, examinant la valeur de la IsCompleted propriété. Une fois le processus terminé, le code récupère et SqlDataReader affiche son contenu.
Cet exemple transmet également les CommandBehavior.CloseConnection valeurs et CommandBehavior.SingleRow dans le paramètre de comportement, ce qui entraîne la fermeture de la connexion avec le retourné SqlDataReader est fermée et l’optimisation pour un résultat de ligne unique.
// <Snippet1>
using System;
using System.Data;
using Microsoft.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.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
}
// </Snippet1>
Remarques
La BeginExecuteReader méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL ou d’une procédure stockée qui retourne des 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 EndExecuteReader méthode pour terminer l’opération et récupérer le SqlDataReader retourné par la commande. La BeginExecuteReader méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteReader , 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 EndExecuteReader 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 behavior paramètre vous permet de spécifier des options qui contrôlent le comportement de la commande et sa connexion. Ces valeurs peuvent être combinées (à l’aide de l’opérateur du langage de OR programmation). En règle générale, les développeurs utilisent la CommandBehavior.CloseConnection valeur pour s’assurer que la connexion est fermée par le runtime lorsque le SqlDataReader est fermé.
Notez que le texte et les paramètres de la commande 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 la réponse du serveur. Autrement dit, les lectures sont asynchrones. Bien que l’exécution des commandes soit asynchrone, l’extraction de valeur est toujours synchrone. Cela signifie que les appels à Read peuvent bloquer si davantage de données sont requises et si l’opération de lecture du réseau sous-jacent est bloquée.
Étant donné que cette surcharge ne prend pas en charge une procédure de rappel, les développeurs doivent interroger pour déterminer si la commande est terminée, à l’aide de la IsCompleted propriété du retourné par la BeginExecuteNonQuery méthode ; ou attendre l’achèvement d’une ou plusieurs commandes à l’aide de la AsyncWaitHandle propriété du retournéIAsyncResult.IAsyncResult
Si vous utilisez ExecuteReader ou BeginExecuteReader pour accéder à des données XML, SQL Server retourne les résultats XML d’une longueur supérieure à 2 033 caractères dans plusieurs lignes de 2 033 caractères chacune. Pour éviter ce comportement, utilisez ExecuteXmlReader ou BeginExecuteXmlReader pour lire des requêtes FOR XML.
Cette méthode ignore la CommandTimeout propriété .
S’applique à
BeginExecuteReader(AsyncCallback, Object)
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée qui est décrite par cet SqlCommand et retourne les résultats en tant qu’objet XmlReader à l’aide d’une procédure de rappel.
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 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
Un IAsyncResult qui peut être utilisé pour interroger ou attendre les résultats, ou bien les deux ; cette valeur est également requise quand le EndExecuteXmlReader(IAsyncResult) est appelé, ce qui retourne les résultats de la commande en tant que XML.
Exceptions
Un SqlDbType autre 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 Windows suivante illustre l’utilisation de la méthode BeginExecuteXmlReader, en exécutant une instruction Transact-SQL qui comprend un délai de quelques secondes (en émulant une commande longue). Cet exemple montre comment faire passer l’objet en cours d’exécution SqlCommand en tant que stateObject paramètre. Il est donc facile de récupérer l’objet SqlCommand à partir de la procédure de rappel, afin que le code puisse appeler la EndExecuteXmlReader méthode correspondant à l’appel initial à BeginExecuteXmlReader.
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, un ListBox contrôle et un Label contrôle sur le formulaire (en acceptant le nom par défaut de 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;
using System.Xml;
namespace Microsoft.AdoDotNet.CodeSamples
{
public partial class Form1 : Form
{
// Hook up the form's Load event handler and then add
// this code to the form's class:
// You need these delegates in order to display text from a thread
// other than the form's thread. See the HandleCallback
// procedure for more information.
private delegate void DisplayInfoDelegate(string Text);
private delegate void DisplayReaderDelegate(XmlReader reader);
private bool isExecuting;
// This example maintains the connection object
// externally, so that it is available for closing.
private SqlConnection connection;
public Form1()
{
InitializeComponent();
}
private string GetConnectionString()
{
// To avoid storing the connection string in your code,
// you can retrieve it from a configuration file.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
private void DisplayStatus(string Text)
{
this.label1.Text = Text;
}
private void ClearProductInfo()
{
// Clear the list box.
this.listBox1.Items.Clear();
}
private void DisplayProductInfo(XmlReader reader)
{
// Display the data within the reader.
while (reader.Read())
{
// Skip past items that are not from the correct table.
if (reader.LocalName.ToString() == "Production.Product")
{
this.listBox1.Items.Add(String.Format("{0}: {1:C}",
reader["Name"], Convert.ToDecimal(reader["ListPrice"])));
}
}
DisplayStatus("Ready");
}
private void Form1_FormClosing(object sender,
System.Windows.Forms.FormClosingEventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this, "Cannot close the form until " +
"the pending asynchronous command has completed. Please wait...");
e.Cancel = true;
}
}
private void button1_Click(object sender, System.EventArgs e)
{
if (isExecuting)
{
MessageBox.Show(this,
"Already executing. Please wait until the current query " +
"has completed.");
}
else
{
SqlCommand command = null;
try
{
ClearProductInfo();
DisplayStatus("Connecting...");
connection = new SqlConnection(GetConnectionString());
// To emulate a long-running query, wait for
// a few seconds before working with the data.
string commandText =
"WAITFOR DELAY '00:00:03';" +
"SELECT Name, ListPrice FROM Production.Product " +
"WHERE ListPrice < 100 " +
"FOR XML AUTO, XMLDATA";
command = new SqlCommand(commandText, connection);
connection.Open();
DisplayStatus("Executing...");
isExecuting = true;
// Although it is not required that you pass the
// SqlCommand object as the second parameter in the
// BeginExecuteXmlReader call, doing so makes it easier
// to call EndExecuteXmlReader in the callback procedure.
AsyncCallback callback = new AsyncCallback(HandleCallback);
command.BeginExecuteXmlReader(callback, command);
}
catch (Exception ex)
{
isExecuting = false;
DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
if (connection != null)
{
connection.Close();
}
}
}
}
private void HandleCallback(IAsyncResult result)
{
try
{
// Retrieve the original command object, passed
// to this procedure in the AsyncState property
// of the IAsyncResult parameter.
SqlCommand command = (SqlCommand)result.AsyncState;
XmlReader reader = command.EndExecuteXmlReader(result);
// You may not interact with the form and its contents
// from a different thread, and this callback procedure
// is all but guaranteed to be running from a different thread
// than the form.
// Instead, you must call the procedure from the form's thread.
// One simple way to accomplish this is to call the Invoke
// method of the form, which calls the delegate you supply
// from the form's thread.
DisplayReaderDelegate del = new DisplayReaderDelegate(DisplayProductInfo);
this.Invoke(del, reader);
}
catch (Exception ex)
{
// Because you are now running code in a separate thread,
// if you do not handle the exception here, none of your other
// code catches the exception. Because none of
// your code is on the call stack in this thread, there is nothing
// higher up the stack to catch the exception if you do not
// handle it here. You can either log the exception or
// invoke a delegate (as in the non-error case in this
// example) to display the error on the form. In no case
// can you simply display the error without executing a delegate
// as in the try block here.
// You can create the delegate instance as you
// invoke it, like this:
this.Invoke(new DisplayInfoDelegate(DisplayStatus),
String.Format("Ready(last error: {0}", ex.Message));
}
finally
{
isExecuting = false;
if (connection != null)
{
connection.Close();
}
}
}
private void Form1_Load(object sender, System.EventArgs e)
{
this.button1.Click += new System.EventHandler(this.button1_Click);
this.FormClosing += new System.Windows.Forms.
FormClosingEventHandler(this.Form1_FormClosing);
}
}
}
// </Snippet1>
Remarques
La BeginExecuteXmlReader méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL ou d’une procédure stockée qui retourne des lignes au format XML, 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 EndExecuteXmlReader méthode pour terminer l’opération et récupérer les données XML demandées. La BeginExecuteXmlReader méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteXmlReader , 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 EndExecuteXmlReader 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.
La CommandText propriété spécifie généralement une instruction Transact-SQL avec une clause FOR XML valide. Toutefois, CommandText peut également spécifier une instruction qui retourne des données qui contiennent du code XML valide. Cette méthode peut également être utilisée pour récupérer un jeu de résultats à une seule ligne et à colonne unique. Dans ce cas, si plusieurs lignes sont retournées, la EndExecuteXmlReader méthode attache le XmlReader à la valeur de la première ligne et ignore le reste du jeu de résultats.
Une requête classique BeginExecuteXmlReader peut être mise en forme comme dans l’exemple C# suivant :
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Cette méthode peut également être utilisée pour récupérer un jeu de résultats à une seule ligne et à colonne unique. Dans ce cas, si plusieurs lignes sont retournées, la EndExecuteXmlReader méthode attache le XmlReader à la valeur de la première ligne et ignore le reste du jeu de résultats.
La fonctionnalité MARS (Multiple Active Result Set) permet à plusieurs actions d’utiliser la même connexion.
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 EndExecuteXmlReader 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 stateObject 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 est envoyé, 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.
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.
Si vous utilisez ExecuteReader ou BeginExecuteReader pour accéder à des données XML, SQL Server retourne les résultats XML d’une longueur supérieure à 2 033 caractères dans plusieurs lignes de 2 033 caractères chacune. Pour éviter ce comportement, utilisez ExecuteXmlReader ou BeginExecuteXmlReader pour lire des requêtes FOR XML.
Cette méthode ignore la CommandTimeout propriété .
Voir aussi
S’applique à
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
Lance l’exécution asynchrone de l’instruction Transact-SQL ou de la procédure stockée décrite par ce SqlCommand , à l’aide de l’un des élémentsCommandBehavior et la récupération d’un ou plusieurs jeux de résultats à partir du serveur, en fonction d’une procédure de rappel et d’informations d’état.
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 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.
- behavior
- CommandBehavior
Une des valeurs de CommandBehavior, indiquant les options pour l’exécution d’instructions et la récupération de données.
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 EndExecuteReader(IAsyncResult) , qui retourne une SqlDataReader instance qui peut être utilisée pour récupérer les lignes retourné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 Windows suivante illustre l’utilisation de la méthode BeginExecuteReader, en exécutant une instruction Transact-SQL qui comprend un délai de quelques secondes (en émulant une commande longue). Étant donné que l’exemple exécute la commande de manière asynchrone, le formulaire reste réactif en attendant les résultats. Cet exemple passe l’objet en cours d’exécution SqlCommand en tant que stateObject paramètre ; cela simplifie la récupération de l’objet SqlCommand à partir de la procédure de rappel, afin que le code puisse appeler la EndExecuteReader méthode correspondant à l’appel initial à BeginExecuteReader.
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, un DataGridView 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.
Cet exemple montre comment transmettre la CommandBehavior.CloseConnection valeur dans le behavior paramètre, ce qui entraîne la fermeture automatique de la connexion retournée SqlDataReader .
// <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:
// 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.
return "Data Source=(local);Integrated Security=true;" +
"Initial Catalog=AdventureWorks";
}
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;
}
}
}
}
// </Snippet1>
Remarques
La BeginExecuteReader méthode démarre le processus d’exécution asynchrone d’une instruction Transact-SQL ou d’une procédure stockée qui retourne des 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 EndExecuteReader méthode pour terminer l’opération et récupérer le SqlDataReader retourné par la commande . La BeginExecuteReader méthode retourne immédiatement, mais tant que le code n’exécute pas l’appel de méthode correspondant EndExecuteReader , 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 EndExecuteReader 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 EndExecuteReader 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 stateObject paramètre, et votre procédure de rappel peut récupérer ces informations à l’aide de la AsyncState propriété .
Le behavior paramètre vous permet de spécifier des options qui contrôlent le comportement de la commande et sa connexion. Ces valeurs peuvent être combinées (à l’aide de l’opérateur du langage de Or programmation). En règle générale, les développeurs utilisent la CloseConnection valeur pour s’assurer que la connexion est fermée par le runtime lorsque le SqlDataReader est fermé. Les développeurs peuvent également optimiser le comportement de en SqlDataReader spécifiant la SingleRow valeur lorsqu’il est connu à l’avance que l’instruction Transact-SQL ou la procédure stockée ne retourne qu’une seule ligne.
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. Bien que l’exécution de la commande soit asynchrone, l’extraction de valeur est toujours synchrone. Cela signifie que les appels à Read peuvent bloquer si davantage de données sont requises et si l’opération de lecture du réseau sous-jacent est bloquée.
É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.
Si vous utilisez ExecuteReader ou BeginExecuteReader pour accéder à des données XML, SQL Server retourne les résultats XML d’une longueur supérieure à 2 033 caractères dans plusieurs lignes de 2 033 caractères chacune. Pour éviter ce comportement, utilisez ExecuteXmlReader ou BeginExecuteXmlReader pour lire des requêtes FOR XML.
Cette méthode ignore la CommandTimeout propriété .