SqlCommand.BeginExecuteReader 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í
| BeginExecuteReader() |
Inicializuje asynchronní provádění Transact-SQL příkaz nebo uložená procedura, která je popsána a SqlCommand vrátí výsledky jako XmlReader objekt. |
| BeginExecuteReader(CommandBehavior) |
Inicializuje asynchronní spuštění Transact-SQL příkaz nebo uložená procedura, která je popsána pomocí SqlCommand jedné z CommandBehavior hodnot. |
| BeginExecuteReader(AsyncCallback, Object) |
Inicializuje asynchronní spuštění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand a vrátí výsledky jako XmlReader objekt pomocí procedury zpětného volání. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
Inicializuje asynchronní provádění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand , pomocí jednoho z |
BeginExecuteReader()
Inicializuje asynchronní provádění Transact-SQL příkaz nebo uložená procedura, která je popsána a SqlCommand vrátí výsledky jako XmlReader objekt.
public:
IAsyncResult ^ BeginExecuteReader();public IAsyncResult BeginExecuteReader ();member this.BeginExecuteReader : unit -> IAsyncResultPublic Function BeginExecuteReader () 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íEndExecuteXmlReader , která vrátí jednu hodnotu XML.
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 spustí proces asynchronního načítání dat XML. Při čekání na výsledky se tato jednoduchá aplikace nachází ve smyčce a zkoumá IsCompleted hodnotu vlastnosti. Po dokončení procesu kód načte KÓD XML a zobrazí jeho obsah.
[!code-csharp[SqlCommand_BeginExecuteXmlReader#1]((~/.. /sqlclient/doc/samples/SqlCommand_BeginExecuteXmlReader.cs)]
Poznámky
Metoda BeginExecuteXmlReader spustí proces asynchronního spuštění příkazu jazyka Transact-SQL, který vrací řádky jako XML, aby bylo možné souběžně spustit další úlohy během provádění příkazu. Po dokončení příkazu musí vývojáři zavolat metodu EndExecuteXmlReader k dokončení operace a načtení XML vráceného příkazem. Metoda BeginExecuteXmlReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteXmlReader volání metody, nesmí spouštět žádná jiná volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteXmlReader 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čí.
Vlastnost CommandText obvykle určuje transact-SQL příkaz s platnou klauzulí FOR XML. CommandText Může však také zadat příkaz, který vrací ntext data, která obsahují platný kód XML.
Typický BeginExecuteXmlReader dotaz je možné naformátovat jako v následujícím příkladu jazyka C#:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM dbo.Contact FOR XML AUTO, XMLDATA", SqlConn);
Tuto metodu lze také použít k načtení sady výsledků dotazu s jedním řádkem a jedním sloupcem. V tomto případě, pokud je vrácen více než jeden řádek, EndExecuteXmlReader metoda připojí XmlReader k hodnotě na prvním řádku a zahodí zbytek sady výsledků.
Funkce MARS (Multiple Active Result Set) umožňuje, aby několik akcí používalo stejné připojení.
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í. Přestože je provádění příkazu asynchronní, načítání hodnot je stále synchronní.
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 BeginExecuteXmlReader nebo počkat na dokončení jednoho nebo více příkazů pomocí AsyncWaitHandle vlastnosti vráceného IAsyncResult.
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků v několika řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost .
Platí pro
BeginExecuteReader(CommandBehavior)
Inicializuje asynchronní spuštění Transact-SQL příkaz nebo uložená procedura, která je popsána pomocí SqlCommand jedné z CommandBehavior hodnot.
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 IAsyncResultParametry
- behavior
- CommandBehavior
Jedna z CommandBehavior hodnot, která označuje možnosti pro provádění příkazů a načítání dat.
Návraty
Hodnota IAsyncResult , která se dá použít k dotazování, čekání na výsledky nebo obojí; tato hodnota je také potřeba při vyvolání EndExecuteReader(IAsyncResult) , která vrací SqlDataReader instanci, která se dá použít k načtení vrácený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 spustí proces asynchronního načtení čtečky dat. Při čekání na výsledky se tato jednoduchá aplikace nachází ve smyčce a zkoumá IsCompleted hodnotu vlastnosti. Po dokončení procesu kód načte SqlDataReader a zobrazí jeho obsah.
Tento příklad také předá CommandBehavior.CloseConnection hodnoty a CommandBehavior.SingleRow v parametru chování, což způsobí ukončení připojení s vrácenou SqlDataReader hodnotou je uzavřeno a optimalizuje se pro jeden řádek výsledku.
// <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>
Poznámky
Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu jazyka Transact-SQL nebo uložené procedury, která vrací řádky, aby bylo možné souběžně spustit další úlohy během provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteReader k dokončení operace a načtení vráceného SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí spouštět žádná jiná volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader 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 behavior umožňuje zadat možnosti, které řídí chování příkazu a jeho připojení. Tyto hodnoty lze kombinovat dohromady (pomocí operátoru programovacího OR jazyka); obecně platí, že vývojáři používají CommandBehavior.CloseConnection hodnotu k zajištění toho, aby bylo připojení ukončeno modulem runtime při SqlDataReader zavření.
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í. Přestože je provádění příkazu asynchronní, načítání hodnot je stále synchronní. To znamená, že volání metody můžou být Read blokovaná, pokud je potřeba více dat a operace čtení v podkladové síti blokuje.
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 .
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků v několika řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost .
Platí pro
BeginExecuteReader(AsyncCallback, Object)
Inicializuje asynchronní spuštění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand a vrátí výsledky jako XmlReader objekt pomocí procedury zpětného volání.
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 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í, čekání na výsledky nebo obojí; tato hodnota je také potřeba při EndExecuteXmlReader(IAsyncResult) volání metody , která vrátí výsledky příkazu ve formátu XML.
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í aplikace systému Windows demonstruje použití BeginExecuteXmlReader metody, která spouští příkaz jazyka Transact-SQL, který obsahuje zpoždění několik sekund (emuluje dlouhotrvající příkaz). Tento příklad předá spouštěný SqlCommand objekt jako stateObject parametr – tím se zjednoduší načtení objektu SqlCommand z procedury zpětného volání, aby kód mohl volat metodu EndExecuteXmlReader odpovídající počátečnímu BeginExecuteXmlReadervolání metody .
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, ListBox 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;
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>
Poznámky
Metoda BeginExecuteXmlReader spustí proces asynchronního spuštění příkazu jazyka Transact-SQL nebo uložené procedury, která vrací řádky jako XML, aby další úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři zavolat metodu EndExecuteXmlReader k dokončení operace a načtení požadovaných dat XML. Metoda BeginExecuteXmlReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteXmlReader volání metody, nesmí spouštět žádná jiná volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteXmlReader 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čí.
Vlastnost CommandText obvykle určuje transact-SQL příkaz s platnou klauzulí FOR XML. CommandText Může však také zadat příkaz, který vrací data, která obsahují platný kód XML. Tuto metodu lze také použít k načtení sady výsledků dotazu s jedním řádkem a jedním sloupcem. V tomto případě, pokud je vrácen více než jeden řádek, EndExecuteXmlReader metoda připojí XmlReader k hodnotě na prvním řádku a zahodí zbytek sady výsledků.
Typický BeginExecuteXmlReader dotaz je možné naformátovat jako v následujícím příkladu jazyka C#:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Tuto metodu lze také použít k načtení sady výsledků dotazu s jedním řádkem a jedním sloupcem. V tomto případě, pokud je vrácen více než jeden řádek, EndExecuteXmlReader metoda připojí XmlReader k hodnotě na prvním řádku a zahodí zbytek sady výsledků.
Funkce MARS (Multiple Active Result Set) umožňuje, aby několik akcí používalo stejné připojení.
Parametr callback umožňuje určit delegáta AsyncCallback , který se volá po dokončení příkazu. Metodu EndExecuteXmlReader 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 stateObject 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ů, může tato metoda 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í.
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.
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků ve více řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost .
Viz také
Platí pro
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
Inicializuje asynchronní provádění transact-SQL příkaz nebo uložená procedura, která je popsána v tomto SqlCommand , pomocí jednoho zCommandBehavior a načtení jedné nebo více sad výsledků ze serveru s ohledem na postup zpětného volání a informace o stavu.
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 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 .
- behavior
- CommandBehavior
Jedna z CommandBehavior hodnot, která označuje možnosti pro provádění příkazů a načítání dat.
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í EndExecuteReader(IAsyncResult) , která vrací SqlDataReader instanci, která se dá použít k načtení vrácený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í aplikace systému Windows demonstruje použití BeginExecuteReader metody, která spouští příkaz jazyka Transact-SQL, který obsahuje zpoždění několik sekund (emuluje dlouhotrvající příkaz). Vzhledem k tomu, že ukázka provádí příkaz asynchronně, zůstane formulář při čekání na výsledky responzivní. Tento příklad předá spouštěný SqlCommand objekt jako stateObject parametr. Tím se zjednoduší načtení objektu SqlCommand z procedury zpětného volání, aby kód mohl volat metodu EndExecuteReader odpovídající počátečnímu BeginExecuteReadervolání metody .
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, DataGridView 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í.
Tento příklad předá CommandBehavior.CloseConnection hodnotu v parametru behavior , což způsobí, že vrácený SqlDataReader objekt po ukončení automaticky ukončí své připojení.
// <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>
Poznámky
Metoda BeginExecuteReader spustí proces asynchronního spuštění příkazu jazyka Transact-SQL nebo uložené procedury, která vrací řádky, aby bylo možné souběžně spustit další úlohy během provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteReader k dokončení operace a načtení vráceného SqlDataReader příkazem. Metoda BeginExecuteReader vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteReader volání metody, nesmí spouštět žádná jiná volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteReader 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 EndExecuteReader 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 stateObject a procedura zpětného volání může tyto informace načíst pomocí AsyncState vlastnosti .
Parametr behavior umožňuje zadat možnosti, které řídí chování příkazu a jeho připojení. Tyto hodnoty lze kombinovat dohromady (pomocí operátoru programovacího Or jazyka); obecně platí, že vývojáři používají CloseConnection hodnotu k zajištění toho, aby bylo připojení ukončeno modulem runtime při SqlDataReader zavření. Vývojáři mohou také optimalizovat chování SqlDataReaderSingleRow zadáním hodnoty, pokud je předem známo, že transact-SQL příkaz nebo uložená procedura vrací pouze jeden řádek.
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í. Přestože je provádění příkazu asynchronní, načítání hodnot je stále synchronní. To znamená, že volání metody můžou být Read blokovaná, pokud je potřeba více dat a operace čtení v podkladové síti blokuje.
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 procedury zpětného volání – pokud byste museli aktualizovat formulář, musíte přepnout zpět na vlákno formuláře, abyste mohli svoji práci provést. 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.
Pokud používáte ExecuteReader nebo BeginExecuteReader pro přístup k datům XML, vrátí SQL Server všechny výsledky XML delší než 2 033 znaků ve více řádcích po 2 033 znacích. Chcete-li se tomuto chování vyhnout, použijte ExecuteXmlReader nebo BeginExecuteXmlReader ke čtení dotazů FOR XML.
Tato metoda ignoruje CommandTimeout vlastnost .