SqlCommand.BeginExecuteReader Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Przeciążenia
| Nazwisko | Opis |
|---|---|
| BeginExecuteReader() |
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej przez ten SqlCommandobiekt i pobiera jeden lub więcej zestawów wyników z serwera. |
| BeginExecuteReader(CommandBehavior) |
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej za pomocą SqlCommand jednej z CommandBehavior wartości. |
| BeginExecuteReader(AsyncCallback, Object) |
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand temacie i pobiera jeden lub więcej zestawów wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej przez ten SqlCommandobiekt , przy użyciu jednej z wartości i pobieranie co najmniej jednego |
BeginExecuteReader()
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej przez ten SqlCommandobiekt i pobiera jeden lub więcej zestawów wyników z serwera.
public:
IAsyncResult ^ BeginExecuteReader();
public IAsyncResult BeginExecuteReader();
member this.BeginExecuteReader : unit -> IAsyncResult
Public Function BeginExecuteReader () As IAsyncResult
Zwraca
Element IAsyncResult , który może służyć do sondowania lub oczekiwania na wyniki albo obu tych elementów. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwracanych wierszy.
Wyjątki
-
Inny SqlDbType niż
BinarylubVarBinarybył używany, gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient. -
Inny SqlDbType niż
Char, ,NCharNVarChar,VarCharlubXmlzostał użyty, gdy Value został ustawiony na TextReader. -
Inny SqlDbType niż
Xmlbył używany, gdy Value został ustawiony na XmlReaderwartość .
- Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.
- Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- EnableOptimizedParameterBinding parametr ma wartość true, a parametr z kierunkiem Output lub InputOutput został dodany do kolekcji Parameters .
Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Stream Obiekt XmlReaderlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Przykłady
Poniższa aplikacja konsolowa uruchamia proces pobierania czytnika danych asynchronicznie. Czekając na wyniki, ta prosta aplikacja znajduje się w pętli, badając IsCompleted wartość właściwości. Po zakończeniu procesu kod pobiera SqlDataReader zawartość i wyświetla jego zawartość.
using System;
using Microsoft.Data.SqlClient;
class Class1
{
static void Main()
{
// This is a simple example that demonstrates the usage of the
// BeginExecuteReader functionality
// The WAITFOR statement simply adds enough time to prove the
// asynchronous nature of the command.
string commandText =
"WAITFOR DELAY '00:00:03';" +
"SELECT LastName, FirstName FROM Person.Contact " +
"WHERE LastName LIKE 'M%'";
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
{
SqlCommand command = new SqlCommand(commandText, connection);
connection.Open();
IAsyncResult result = command.BeginExecuteReader();
// 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)
{
count += 1;
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";
}
}
Uwagi
Metoda BeginExecuteReader() rozpoczyna proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader(IAsyncResult) , aby zakończyć operację i pobrać SqlDataReader zwrócone przez polecenie . BeginExecuteReader() Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader(IAsyncResult) wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader(IAsyncResult) Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.
Należy pamiętać, że tekst polecenia i parametry są wysyłane synchronicznie do serwera. Jeśli wysyłane jest duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli operacje odczytu są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read() , jeśli wymagana jest większa liczba danych i bloki operacji odczytu sieci bazowej.
Ponieważ to przeciążenie nie obsługuje procedury wywołania zwrotnego, deweloperzy muszą sondować, aby określić, czy polecenie zostało ukończone, używając właściwości zwróconej przez IsCompleted metodę; lub poczekać na ukończenie co najmniej jednego polecenia przy użyciu IAsyncResultBeginExecuteReader() właściwości zwróconej AsyncWaitHandle.IAsyncResult
Jeśli używasz ExecuteReader() danych XML lub BeginExecuteReader() uzyskujesz do nich dostęp, program SQL Server zwróci wszystkie wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj polecenia ExecuteXmlReader() lub BeginExecuteXmlReader() do odczytu zapytań XML.
Ta metoda ignoruje CommandTimeout właściwość .
Dotyczy
BeginExecuteReader(CommandBehavior)
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej za pomocą SqlCommand jednej z CommandBehavior wartości.
public:
IAsyncResult ^ BeginExecuteReader(System::Data::CommandBehavior behavior);
public IAsyncResult BeginExecuteReader(System.Data.CommandBehavior behavior);
member this.BeginExecuteReader : System.Data.CommandBehavior -> IAsyncResult
Public Function BeginExecuteReader (behavior As CommandBehavior) As IAsyncResult
Parametry
- behavior
- CommandBehavior
CommandBehavior Jedna z wartości wskazująca opcje wykonywania instrukcji i pobierania danych.
Zwraca
Element IAsyncResult , który może służyć do sondowania, oczekiwania na wyniki lub obu tych elementów. Ta wartość jest również potrzebna podczas wywoływania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwracanych wierszy.
Wyjątki
-
Inny SqlDbType niż
BinarylubVarBinarybył używany, gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient. -
Inny SqlDbType niż
Char, ,NCharNVarChar,VarCharlubXmlzostał użyty, gdy Value został ustawiony na TextReader. -
Inny SqlDbType niż
Xmlbył używany, gdy Value został ustawiony na XmlReaderwartość .
- Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.
- Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- EnableOptimizedParameterBinding parametr ma wartość true, a parametr z kierunkiem Output lub InputOutput został dodany do kolekcji Parameters .
Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Stream Obiekt XmlReaderlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Przykłady
Poniższa aplikacja konsolowa uruchamia proces pobierania czytnika danych asynchronicznie. Czekając na wyniki, ta prosta aplikacja znajduje się w pętli, badając IsCompleted wartość właściwości. Po zakończeniu procesu kod pobiera zawartość SqlDataReader i wyświetla jego zawartość.
W tym przykładzie również przekazuje CloseConnection wartości i SingleRow w parametrze zachowania, powodując zamknięcie połączenia z zwróconym wynikiem SqlDataReader , i zoptymalizowanie pod kątem pojedynczego wiersza.
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";
}
}
Uwagi
Metoda BeginExecuteReader() rozpoczyna proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader(IAsyncResult) , aby zakończyć operację i pobrać SqlDataReader zwrócone przez polecenie . BeginExecuteReader() Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader(IAsyncResult) wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader(IAsyncResult) Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.
Parametr behavior umożliwia określenie opcji, które kontrolują zachowanie polecenia i jego połączenia. Te wartości można łączyć (przy użyciu operatora języka OR programowania), zazwyczaj deweloperzy używają CommandBehavior.CloseConnection tej wartości, aby upewnić się, że połączenie jest zamknięte przez środowisko uruchomieniowe po SqlDataReader zamknięciu.
Należy pamiętać, że tekst polecenia i parametry są wysyłane synchronicznie do serwera. Jeśli wysyłane jest duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli operacje odczytu są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read() , jeśli wymagana jest większa liczba danych i bloki operacji odczytu sieci bazowej.
Ponieważ to przeciążenie nie obsługuje procedury wywołania zwrotnego, deweloperzy muszą sondować, aby określić, czy polecenie zostało ukończone, używając właściwości zwróconej przez IsCompleted metodę; lub poczekać na ukończenie co najmniej jednego polecenia przy użyciu IAsyncResultBeginExecuteNonQuery() właściwości zwróconej AsyncWaitHandle.IAsyncResult
Jeśli używasz ExecuteReader() danych XML lub BeginExecuteReader() uzyskujesz do nich dostęp, program SQL Server zwraca wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj polecenia ExecuteXmlReader() lub BeginExecuteXmlReader() do odczytu zapytań XML.
Ta metoda ignoruje CommandTimeout właściwość .
Dotyczy
BeginExecuteReader(AsyncCallback, Object)
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej w tym SqlCommand temacie i pobiera jeden lub więcej zestawów wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie.
public:
IAsyncResult ^ BeginExecuteReader(AsyncCallback ^ callback, System::Object ^ stateObject);
public IAsyncResult BeginExecuteReader(AsyncCallback callback, object stateObject);
member this.BeginExecuteReader : AsyncCallback * obj -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object) As IAsyncResult
Parametry
- callback
- AsyncCallback
Delegat AsyncCallback wywoływany po zakończeniu wykonywania polecenia. Przekaż null element (Nothing w programie Microsoft Visual Basic), aby wskazać, że nie jest wymagane żadne wywołanie zwrotne.
- stateObject
- Object
Obiekt stanu zdefiniowany przez użytkownika, który jest przekazywany do procedury wywołania zwrotnego. Pobierz ten obiekt z procedury wywołania zwrotnego przy użyciu AsyncState właściwości .
Zwraca
Element IAsyncResult , który może służyć do sondowania, oczekiwania na wyniki lub obu tych elementów. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwracanych wierszy.
Wyjątki
-
Inny SqlDbType niż
BinarylubVarBinarybył używany, gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient. -
Inny SqlDbType niż
Char, ,NCharNVarChar,VarCharlubXmlzostał użyty, gdy Value został ustawiony na TextReader. -
Inny SqlDbType niż
Xmlbył używany, gdy Value został ustawiony na XmlReaderwartość .
- Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.
- Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- EnableOptimizedParameterBinding parametr ma wartość true, a parametr z kierunkiem Output lub InputOutput został dodany do kolekcji Parameters .
Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Stream Obiekt XmlReaderlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Przykłady
Poniższa aplikacja systemu Windows demonstruje użycie BeginExecuteReader() metody , wykonując instrukcję Transact-SQL, która zawiera opóźnienie kilku sekund (emulowanie długotrwałego polecenia). Ponieważ przykład wykonuje polecenie asynchronicznie, formularz pozostaje dynamiczny podczas oczekiwania na wyniki. Ten przykład przekazuje obiekt wykonujący SqlCommand jako stateObject parametr . Dzięki temu można łatwo pobrać SqlCommand obiekt z procedury wywołania zwrotnego, aby kod mógł wywołać EndExecuteReader(IAsyncResult) metodę odpowiadającą początkowemu wywołaniu metody BeginExecuteReader().
W tym przykładzie pokazano wiele ważnych technik. Obejmuje to wywołanie metody, która wchodzi w interakcję z formularzem z oddzielnego wątku. Ponadto w tym przykładzie pokazano, jak należy zablokować użytkownikom wielokrotne wykonywanie polecenia jednocześnie i jak należy się upewnić, że formularz nie jest zamykany przed wywołaniem procedury wywołania zwrotnego.
Aby skonfigurować ten przykład, utwórz nową aplikację systemu Windows. Umieść kontrolkę Button , kontrolkę DataGridView i kontrolkę Label w formularzu (akceptując nazwę domyślną dla każdej kontrolki). Dodaj następujący kod do klasy formularza, modyfikując parametry połączenia zgodnie z potrzebami dla środowiska.
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";
}
}
Uwagi
Metoda BeginExecuteReader() rozpoczyna proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader(IAsyncResult) , aby zakończyć operację i pobrać SqlDataReader zwrócone przez polecenie . BeginExecuteReader() Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader(IAsyncResult) wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader(IAsyncResult) Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.
Parametr callback umożliwia określenie delegata AsyncCallback , który jest wywoływany po zakończeniu instrukcji. Metodę EndExecuteReader(IAsyncResult) można wywołać z poziomu tej procedury delegata lub z dowolnej innej lokalizacji w aplikacji. Ponadto można przekazać dowolny obiekt w parametrze stateObject , a procedura wywołania zwrotnego może pobrać te informacje przy użyciu AsyncState właściwości .
Należy pamiętać, że tekst polecenia i parametry są wysyłane synchronicznie do serwera. Jeśli wysyłane jest duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli operacje odczytu są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read() , jeśli wymagana jest większa liczba danych i bloki operacji odczytu sieci bazowej.
Ponieważ procedura wywołania zwrotnego jest wykonywana z poziomu wątku w tle dostarczonego przez środowisko uruchomieniowe microsoft .NET, bardzo ważne jest, aby zastosować rygorystyczne podejście do obsługi interakcji między wątkami z poziomu aplikacji. Na przykład nie można wchodzić w interakcje z zawartością formularza z poziomu procedury wywołania zwrotnego; jeśli musisz zaktualizować formularz, musisz wrócić do wątku formularza, aby wykonać swoją pracę. W przykładzie w tym temacie pokazano to zachowanie.
Wszystkie błędy występujące podczas wykonywania operacji są zgłaszane jako wyjątki w procedurze wywołania zwrotnego. Należy obsłużyć wyjątek w procedurze wywołania zwrotnego, a nie w głównej aplikacji. Zobacz przykład w tym temacie, aby uzyskać dodatkowe informacje na temat obsługi wyjątków w procedurze wywołania zwrotnego.
Jeśli używasz ExecuteReader() danych XML lub BeginExecuteReader() uzyskujesz do nich dostęp, program SQL Server zwraca wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj polecenia ExecuteXmlReader() lub BeginExecuteXmlReader() do odczytu zapytań XML.
Ta metoda ignoruje CommandTimeout właściwość .
Zobacz też
Dotyczy
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
- Źródło:
- SqlCommand.cs
Inicjuje asynchroniczne wykonywanie instrukcji Transact-SQL lub procedury składowanej opisanej przez ten SqlCommandobiekt , przy użyciu jednej z wartości i pobieranie co najmniej jednego CommandBehavior zestawu wyników z serwera, biorąc pod uwagę procedurę wywołania zwrotnego i informacje o stanie.
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 -> IAsyncResult
Public Function BeginExecuteReader (callback As AsyncCallback, stateObject As Object, behavior As CommandBehavior) As IAsyncResult
Parametry
- callback
- AsyncCallback
Delegat AsyncCallback wywoływany po zakończeniu wykonywania polecenia. Przekaż null element (Nothing w programie Microsoft Visual Basic), aby wskazać, że nie jest wymagane żadne wywołanie zwrotne.
- stateObject
- Object
Obiekt stanu zdefiniowany przez użytkownika, który jest przekazywany do procedury wywołania zwrotnego. Pobierz ten obiekt z procedury wywołania zwrotnego przy użyciu AsyncState właściwości .
- behavior
- CommandBehavior
CommandBehavior Jedna z wartości wskazująca opcje wykonywania instrukcji i pobierania danych.
Zwraca
Element IAsyncResult , który może służyć do sondowania lub oczekiwania na wyniki albo obu tych elementów. Ta wartość jest również potrzebna w przypadku wywołania EndExecuteReader(IAsyncResult)metody , która zwraca SqlDataReader wystąpienie, które może służyć do pobierania zwracanych wierszy.
Wyjątki
-
Inny SqlDbType niż
BinarylubVarBinarybył używany, gdy Value ustawiono wartość Stream. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient. -
Inny SqlDbType niż
Char, ,NCharNVarChar,VarCharlubXmlzostał użyty, gdy Value został ustawiony na TextReader. -
Inny SqlDbType niż
Xmlbył używany, gdy Value został ustawiony na XmlReaderwartość .
- Wszelkie błędy, które wystąpiły podczas wykonywania tekstu polecenia.
- Wystąpił limit czasu podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- Zamknięty SqlConnection lub porzucony podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
- EnableOptimizedParameterBinding parametr ma wartość true, a parametr z kierunkiem Output lub InputOutput został dodany do kolekcji Parameters .
Wystąpił błąd w StreamXmlReader obiekcie lub TextReader podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Stream Obiekt XmlReaderlub TextReader został zamknięty podczas operacji przesyłania strumieniowego. Aby uzyskać więcej informacji na temat przesyłania strumieniowego, zobacz Obsługa przesyłania strumieniowego SqlClient.
Przykłady
Poniższa aplikacja systemu Windows demonstruje użycie BeginExecuteReader() metody , wykonując instrukcję Transact-SQL, która zawiera opóźnienie kilku sekund (emulowanie długotrwałego polecenia). Ponieważ przykład wykonuje polecenie asynchronicznie, formularz pozostaje dynamiczny podczas oczekiwania na wyniki. Ten przykład przekazuje obiekt wykonujący SqlCommand jako stateObject parametr . Dzięki temu można łatwo pobrać SqlCommand obiekt z procedury wywołania zwrotnego, aby kod mógł wywołać EndExecuteReader(IAsyncResult) metodę odpowiadającą początkowemu wywołaniu metody BeginExecuteReader().
W tym przykładzie pokazano wiele ważnych technik. Obejmuje to wywołanie metody, która wchodzi w interakcję z formularzem z oddzielnego wątku. Ponadto w tym przykładzie pokazano, jak należy zablokować użytkownikom wielokrotne wykonywanie polecenia jednocześnie i jak należy się upewnić, że formularz nie jest zamykany przed wywołaniem procedury wywołania zwrotnego.
Aby skonfigurować ten przykład, utwórz nową aplikację systemu Windows. Umieść kontrolkę Button , kontrolkę DataGridView i kontrolkę Label w formularzu (akceptując nazwę domyślną dla każdej kontrolki). Dodaj następujący kod do klasy formularza, modyfikując parametry połączenia zgodnie z potrzebami dla środowiska.
Ten przykład przekazuje CloseConnection wartość w parametrze behavior , co powoduje automatyczne zamknięcie połączenia po SqlDataReader zamknięciu.
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;
}
}
}
}
Uwagi
Metoda BeginExecuteReader() rozpoczyna proces asynchronicznego wykonywania instrukcji Transact-SQL lub procedury składowanej zwracającej wiersze, dzięki czemu inne zadania mogą być uruchamiane współbieżnie podczas wykonywania instrukcji. Po zakończeniu instrukcji deweloperzy muszą wywołać metodę EndExecuteReader(IAsyncResult) , aby zakończyć operację i pobrać SqlDataReader zwrócone przez polecenie . BeginExecuteReader() Metoda zwraca natychmiast, ale dopóki kod nie wykona odpowiedniego EndExecuteReader(IAsyncResult) wywołania metody, nie może wykonać żadnych innych wywołań, które rozpoczynają wykonywanie synchroniczne lub asynchroniczne względem tego samego SqlCommand obiektu. EndExecuteReader(IAsyncResult) Wywołanie polecenia przed wykonaniem polecenia powoduje SqlCommand zablokowanie obiektu do momentu zakończenia wykonywania.
Parametr callback umożliwia określenie delegata AsyncCallback , który jest wywoływany po zakończeniu instrukcji. Metodę EndExecuteReader(IAsyncResult) można wywołać z poziomu tej procedury delegata lub z dowolnej innej lokalizacji w aplikacji. Ponadto można przekazać dowolny obiekt w parametrze stateObject , a procedura wywołania zwrotnego może pobrać te informacje przy użyciu AsyncState właściwości .
Parametr behavior umożliwia określenie opcji, które kontrolują zachowanie polecenia i jego połączenia. Te wartości można łączyć ze sobą (przy użyciu operatora języka Or programowania); zazwyczaj deweloperzy używają CloseConnection tej wartości, aby upewnić się, że połączenie jest zamykane przez środowisko uruchomieniowe po SqlDataReader zamknięciu. Deweloperzy mogą również zoptymalizować zachowanie obiektu SqlDataReader , określając SingleRow wartość, gdy wiadomo z wyprzedzeniem, że instrukcja Transact-SQL lub procedura składowana zwraca tylko jeden wiersz.
Należy pamiętać, że tekst polecenia i parametry są wysyłane synchronicznie do serwera. Jeśli wysyłane jest duże polecenie lub wiele parametrów, ta metoda może blokować podczas zapisu. Po wysłaniu polecenia metoda zwraca natychmiast bez oczekiwania na odpowiedź z serwera — czyli operacje odczytu są asynchroniczne. Mimo że wykonywanie poleceń jest asynchroniczne, pobieranie wartości jest nadal synchroniczne. Oznacza to, że wywołania mogą blokować Read() , jeśli wymagana jest większa liczba danych i bloki operacji odczytu sieci bazowej.
Ponieważ procedura wywołania zwrotnego jest wykonywana z poziomu wątku w tle dostarczonego przez środowisko uruchomieniowe języka wspólnego microsoft .NET, bardzo ważne jest, aby zastosować rygorystyczne podejście do obsługi interakcji między wątkami z poziomu aplikacji. Na przykład nie można wchodzić w interakcje z zawartością formularza z poziomu procedury wywołania zwrotnego — jeśli musisz zaktualizować formularz, musisz wrócić do wątku formularza, aby wykonać swoją pracę. W przykładzie w tym temacie pokazano to zachowanie.
Wszystkie błędy występujące podczas wykonywania operacji są zgłaszane jako wyjątki w procedurze wywołania zwrotnego. Należy obsłużyć wyjątek w procedurze wywołania zwrotnego, a nie w głównej aplikacji. Zobacz przykład w tym temacie, aby uzyskać dodatkowe informacje na temat obsługi wyjątków w procedurze wywołania zwrotnego.
Jeśli używasz ExecuteReader() danych XML lub BeginExecuteReader() uzyskujesz do nich dostęp, program SQL Server zwróci wszystkie wyniki XML większe niż 2033 znaki w wielu wierszach o długości 2033 znaków. Aby uniknąć tego zachowania, użyj polecenia ExecuteXmlReader() lub BeginExecuteXmlReader() do odczytu zapytań XML.
Ta metoda ignoruje CommandTimeout właściwość .