SqlCommand.BeginExecuteReader Yöntem
Tanım
Önemli
Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.
Aşırı Yüklemeler
| Name | Description |
|---|---|
| BeginExecuteReader() |
bu SqlCommandtarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütülmesini başlatır ve sunucudan bir veya daha fazla sonuç kümesi alır. |
| BeginExecuteReader(CommandBehavior) |
Değerlerden birini kullanarak Transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini CommandBehavior başlatır. |
| BeginExecuteReader(AsyncCallback, Object) |
Bu SqlCommand tarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütmesini başlatır ve geri çağırma yordamı kullanarak sonuçları nesne XmlReader olarak döndürür. |
| BeginExecuteReader(AsyncCallback, Object, CommandBehavior) |
bu SqlCommand tarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütülmesini başlatır.
|
BeginExecuteReader()
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
bu SqlCommandtarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütülmesini başlatır ve sunucudan bir veya daha fazla sonuç kümesi alır.
public:
IAsyncResult ^ BeginExecuteReader();public IAsyncResult BeginExecuteReader();member this.BeginExecuteReader : unit -> IAsyncResultPublic Function BeginExecuteReader () As IAsyncResultDöndürülenler
IAsyncResult Yoklama yapmak veya sonuçları beklemek için veya her ikisini birden yapmak için kullanılabilecek bir değer; bu değer, döndürülen satırları almak için kullanılabilecek bir EndExecuteReader(IAsyncResult) örnek döndüren çağrılırken SqlDataReaderde gereklidir.
Özel durumlar
-
SqlDbType olarak ayarlandığında veya
VarBinarydışındaBinarybir değer kullanılmıştır ValueStream. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği. -
, ,
NChar,NVarChar,VarCharveyaXmldışındaCharbir SqlDbType değer olarak ayarlandığında TextReaderkullanılmıştırValue. -
SqlDbType olarak ayarlandığında XmlReaderkullanılan Value dışında
Xmlbir değer.
- Komut metni yürütülürken oluşan herhangi bir hata.
- Akış işlemi sırasında zaman aşımı oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
- Akış SqlConnection işlemi sırasında kapatılan veya bırakılan. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
- EnableOptimizedParameterBinding true olarak ayarlanır ve çıkış veya InputOutput yönüne sahip bir parametre koleksiyona Parameters eklenmiştir.
Akış işlemi sırasında bir Streamveya XmlReaderTextReader nesnesinde hata oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
bir Streamakış işlemi sırasında , XmlReader veya TextReader nesnesi kapatıldı. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
Örnekler
Aşağıdaki konsol uygulaması, veri okuyucuyu zaman uyumsuz olarak alma işlemini başlatır. Sonuçları beklerken, bu basit uygulama bir döngüde durur ve özellik değerini inceler IsCompleted . İşlem tamamlanır tamamlanmaz kod öğesini alır SqlDataReader ve içeriğini görüntüler.
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";
}
}
Açıklamalar
yöntemi, BeginExecuteReader() deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır döndüren bir Transact-SQL deyimini veya saklı yordamı zaman uyumsuz olarak yürütme işlemini başlatır. Deyimi tamamlandığında, geliştiricilerin işlemi tamamlamak ve komutu tarafından döndürüleni EndExecuteReader(IAsyncResult) almak için yöntemini çağırması SqlDataReader gerekir. BeginExecuteReader() yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader(IAsyncResult) yöntem çağrısını yürütene kadar, aynı SqlCommand nesneye karşı zaman uyumlu veya zaman uyumsuz yürütme başlatan diğer çağrıları yürütmemelidir. EndExecuteReader(IAsyncResult) Komutun yürütülmesi tamamlanmadan önce öğesini çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olurSqlCommand.
Komut metninin ve parametrelerinin sunucuya zaman uyumlu olarak gönderildiğini unutmayın. Büyük bir komut veya çok sayıda parametre gönderilirse, bu yöntem yazma işlemleri sırasında engelleyebilir. Komut gönderildikten sonra, yöntem sunucudan yanıt beklemeden hemen geri döner; yani okumalar zaman uyumsuzdur. Komut yürütme zaman uyumsuz olsa da, değer getirme hala zaman uyumludur. Bu, daha fazla veri gerektiğinde ve temel ağın okuma işlemi blokları olduğunda çağrısının Read() engellenebileceği anlamına gelir.
Bu aşırı yükleme geri çağırma yordamını desteklemediğinden, geliştiricilerin komutun tamamlanıp tamamlanmadığını belirlemek için yoklaması, yöntemi tarafından IsCompleted döndürülen özelliğini IAsyncResult kullanarak BeginExecuteReader() veya döndürülen AsyncWaitHandleözelliğini kullanarak IAsyncResult bir veya daha fazla komutun tamamlanmasını beklemesi gerekir.
XML verilerine erişmek için veya ExecuteReader() kullanırsanızBeginExecuteReader(), SQL Server her biri 2.033 karakterden oluşan birden çok satırda 2.033 karakterden uzun tüm XML sonuçlarını döndürür. Bu davranışı önlemek için veya ExecuteXmlReader() komutunu kullanarak BeginExecuteXmlReader() FOR XML sorgularını okuyun.
Bu yöntem özelliğini yoksayar CommandTimeout .
Şunlara uygulanır
BeginExecuteReader(CommandBehavior)
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
Değerlerden birini kullanarak Transact-SQL deyiminin veya bunun SqlCommand tarafından açıklanan saklı yordamın zaman uyumsuz yürütülmesini CommandBehavior başlatır.
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 IAsyncResultParametreler
- behavior
- CommandBehavior
CommandBehavior Deyim yürütme ve veri alma seçeneklerini gösteren değerlerden biri.
Döndürülenler
IAsyncResult Yoklama yapmak, sonuçları beklemek veya her ikisini birden yapmak için kullanılabilecek bir değer; döndürülen satırları almak için kullanılabilecek bir EndExecuteReader(IAsyncResult) örnek döndüren çağrılırken SqlDataReaderde bu değer gereklidir.
Özel durumlar
-
SqlDbType olarak ayarlandığında veya
VarBinarydışındaBinarybir değer kullanılmıştır ValueStream. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği. -
, ,
NChar,NVarChar,VarCharveyaXmldışındaCharbir SqlDbType değer olarak ayarlandığında TextReaderkullanılmıştırValue. -
SqlDbType olarak ayarlandığında XmlReaderkullanılan Value dışında
Xmlbir değer.
- Komut metni yürütülürken oluşan herhangi bir hata.
- Akış işlemi sırasında zaman aşımı oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
- Akış SqlConnection işlemi sırasında kapatılan veya bırakılan. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
- EnableOptimizedParameterBinding true olarak ayarlanır ve çıkış veya InputOutput yönüne sahip bir parametre koleksiyona Parameters eklenmiştir.
Akış işlemi sırasında bir Streamveya XmlReaderTextReader nesnesinde hata oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
bir Streamakış işlemi sırasında , XmlReader veya TextReader nesnesi kapatıldı. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
Örnekler
Aşağıdaki konsol uygulaması, veri okuyucuyu zaman uyumsuz olarak alma işlemini başlatır. Sonuçları beklerken, bu basit uygulama bir döngüde durur ve özellik değerini inceler IsCompleted . İşlem tamamlandıktan sonra kod öğesini alır SqlDataReader ve içeriğini görüntüler.
Bu örnek ayrıca davranış parametresindeki CloseConnection ve SingleRow değerlerini geçirir ve döndürülen SqlDataReader bağlantının kapatılmasına ve tek bir satır sonucu için en iyi duruma getirmesine neden olur.
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";
}
}
Açıklamalar
yöntemi, BeginExecuteReader() deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır döndüren bir Transact-SQL deyimini veya saklı yordamı zaman uyumsuz olarak yürütme işlemini başlatır. Deyimi tamamlandığında, geliştiricilerin işlemi tamamlamak ve komutu tarafından döndürüleni EndExecuteReader(IAsyncResult) almak için yöntemini çağırması SqlDataReader gerekir. BeginExecuteReader() yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader(IAsyncResult) yöntem çağrısını yürütene kadar, aynı SqlCommand nesneye karşı zaman uyumlu veya zaman uyumsuz yürütme başlatan diğer çağrıları yürütmemelidir. EndExecuteReader(IAsyncResult) Komutun yürütülmesi tamamlanmadan önce öğesini çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olurSqlCommand.
parametresi, behavior komutun ve bağlantısının davranışını denetleye seçenekleri belirtmenize olanak tanır. Bu değerler birleştirilebilir (programlama dilinin OR işleci kullanılarak); genellikle geliştiriciler, kapatıldığında SqlDataReader bağlantının çalışma zamanı tarafından kapatıldığından emin olmak için bu değeri kullanırCommandBehavior.CloseConnection.
Komut metninin ve parametrelerinin sunucuya zaman uyumlu olarak gönderildiğini unutmayın. Büyük bir komut veya çok sayıda parametre gönderilirse, bu yöntem yazma işlemleri sırasında engelleyebilir. Komut gönderildikten sonra, yöntem sunucudan yanıt beklemeden hemen geri döner; yani okumalar zaman uyumsuzdur. Komut yürütme zaman uyumsuz olsa da, değer getirme hala zaman uyumludur. Bu, daha fazla veri gerektiğinde ve temel ağın okuma işlemi blokları olduğunda çağrısının Read() engellenebileceği anlamına gelir.
Bu aşırı yükleme geri çağırma yordamını desteklemediğinden, geliştiricilerin komutun tamamlanıp tamamlanmadığını belirlemek için yoklaması, yöntemi tarafından IsCompleted döndürülen özelliğini IAsyncResult kullanarak BeginExecuteNonQuery() veya döndürülen AsyncWaitHandleözelliğini kullanarak IAsyncResult bir veya daha fazla komutun tamamlanmasını beklemesi gerekir.
XML verilerine erişmek için veya ExecuteReader() kullanırsanızBeginExecuteReader(), SQL Server her biri 2.033 karakterden oluşan birden çok satırda 2.033 karakterden uzun xml sonuçları döndürür. Bu davranışı önlemek için veya ExecuteXmlReader() komutunu kullanarak BeginExecuteXmlReader() FOR XML sorgularını okuyun.
Bu yöntem özelliğini yoksayar CommandTimeout .
Şunlara uygulanır
BeginExecuteReader(AsyncCallback, Object)
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
Bu SqlCommand tarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütmesini başlatır ve geri çağırma yordamı kullanarak sonuçları nesne XmlReader olarak döndürür.
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 IAsyncResultParametreler
- callback
- AsyncCallback
AsyncCallback Komutun yürütülmesi tamamlandığında çağrılan bir temsilci. Geçirmek Geri çağırma gerekmediğini belirtmek için null (Microsoft Visual Basic'da Nothing).
- stateObject
- Object
Geri çağırma yordamına geçirilen kullanıcı tanımlı durum nesnesi. özelliğini kullanarak AsyncState geri çağırma yordamının içinden bu nesneyi alın.
Döndürülenler
IAsyncResult Yoklama yapmak, sonuçları beklemek veya her ikisini birden yapmak için kullanılabilecek bir değer; komutun sonuçlarını XML olarak döndüren çağrıldığında EndExecuteXmlReader(IAsyncResult) da bu değer gereklidir.
Özel durumlar
SqlDbType olarak ayarlandığında Streamİkili veya VarBinary dışında bir değer kullanıldıValue. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
-veya-
SqlDbType Olarak ayarlandığında TextReaderChar, NChar, NVarChar, VarChar veya Xml dışında bir değer kullanıldıValue.
-veya-
SqlDbType olarak ayarlandığında XmlReaderXml dışında bir değer kullanıldıValue.
Komut metni yürütülürken oluşan herhangi bir hata.
-veya-
Akış işlemi sırasında zaman aşımı oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
Akış SqlConnection işlemi sırasında kapatılan veya bırakılan. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
- 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.
Akış işlemi sırasında bir Stream veya XmlReaderTextReader nesnesinde hata oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
bir Stream akış işlemi sırasında , XmlReader veya TextReader nesnesi kapatıldı. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
Örnekler
Aşağıdaki Windows uygulaması, BeginExecuteXmlReader yönteminin kullanımını gösterir; birkaç saniyelik bir gecikme içeren (uzun süre çalışan bir komutu öykünme) bir Transact-SQL deyimi yürütür. Bu örnek, yürüten SqlCommand nesneyi parametresi olarak stateObject geçirir; bunu yaptığınızda, kodun ilk çağrısına SqlCommandkarşılık gelen yöntemi çağırabilmesi EndExecuteXmlReader için geri çağırma yordamının içinden nesneyi almayı BeginExecuteXmlReader basitleştirir.
Bu örnekte birçok önemli teknik gösterilmektedir. Bu, formla ayrı bir iş parçacığından etkileşim kuran bir yöntemi çağırmayı içerir. Buna ek olarak, bu örnekte kullanıcıların komutu eşzamanlı olarak birden çok kez yürütmesini nasıl engellemeniz gerektiği ve geri çağırma yordamı çağrılmadan önce formun kapanmadığından nasıl emin olmanız gerektiği gösterilmektedir.
Bu örneği ayarlamak için yeni bir Windows uygulaması oluşturun. Forma bir Button denetim, bir ListBox denetim ve bir Label denetim koyun (her denetim için varsayılan adı kabul etme). Ortamınız için gerekli bağlantı dizesini değiştirerek formun sınıfına aşağıdaki kodu ekleyin.
/* This does not compile, as multiple methods are missing.
// <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 SqlCommand_BeginExecuteXmlReaderAsync
{
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>
*/
Açıklamalar
yöntemi, BeginExecuteXmlReader deyim yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satırları XML olarak döndüren bir Transact-SQL deyimini veya saklı yordamı zaman uyumsuz olarak yürütme işlemini başlatır. Deyimi tamamlandığında, geliştiricilerin işlemi tamamlamak ve istenen XML verilerini almak için yöntemini çağırması EndExecuteXmlReader gerekir. BeginExecuteXmlReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteXmlReader yöntem çağrısını yürütene kadar, aynı SqlCommand nesneye karşı zaman uyumlu veya zaman uyumsuz yürütme başlatan diğer çağrıları yürütmemelidir. EndExecuteXmlReader Komutun yürütülmesi tamamlanmadan önce öğesini çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olurSqlCommand.
CommandText özelliği normalde geçerli bir FOR XML yan tümcesine sahip bir Transact-SQL deyimi belirtir. Ancak, CommandText geçerli XML içeren verileri döndüren bir deyim de belirtebilir. Bu yöntem, tek satırlı, tek sütunlu sonuç kümesini almak için de kullanılabilir. Bu durumda, birden fazla satır döndürülürse, EndExecuteXmlReader yöntemi ilk satırdaki değere öğesini ekler XmlReader ve sonuç kümesinin geri kalanını atar.
Tipik BeginExecuteXmlReader bir sorgu aşağıdaki C# örneğinde olduğu gibi biçimlendirilebilir:
SqlCommand command = new SqlCommand("SELECT ContactID, FirstName, LastName FROM Contact FOR XML AUTO, XMLDATA", SqlConn);
Bu yöntem, tek satırlı, tek sütunlu sonuç kümesini almak için de kullanılabilir. Bu durumda, birden fazla satır döndürülürse, EndExecuteXmlReader yöntemi ilk satırdaki değere öğesini ekler XmlReader ve sonuç kümesinin geri kalanını atar.
Birden çok etkin sonuç kümesi (MARS) özelliği, birden çok eylemin aynı bağlantıyı kullanmasına olanak tanır.
parametresi, callback deyimi tamamlandığında çağrılan bir AsyncCallback temsilci belirtmenize olanak tanır. Yöntemini bu temsilci yordamından veya uygulamanızın içinde başka bir konumdan çağırabilirsiniz EndExecuteXmlReader . Ayrıca parametresindeki stateObject herhangi bir nesneyi geçirebilirsiniz ve geri çağırma yordamınız özelliğini kullanarak AsyncState bu bilgileri alabilir.
Komut metninin ve parametrelerinin sunucuya zaman uyumlu olarak gönderildiğini unutmayın. Büyük bir komut veya çok sayıda parametre gönderilirse, bu yöntem yazma işlemleri sırasında engelleyebilir. Komut gönderildikten sonra, yöntem sunucudan yanıt beklemeden hemen geri döner; yani okumalar zaman uyumsuzdur.
İşlemin yürütülmesi sırasında oluşan tüm hatalar geri çağırma yordamında özel durumlar olarak oluşturulur. Özel durumu ana uygulamada değil geri çağırma yordamında işlemeniz gerekir. Geri çağırma yordamındaki özel durumları işleme hakkında ek bilgi için bu konudaki örne bakın.
XML verilerine erişmek için veya ExecuteReader kullanırsanızBeginExecuteReader, SQL Server her biri 2.033 karakterden oluşan birden çok satırda 2.033 karakterden uzun tüm XML sonuçlarını döndürür. Bu davranışı önlemek için veya ExecuteXmlReader komutunu kullanarak BeginExecuteXmlReader FOR XML sorgularını okuyun.
Bu yöntem özelliğini yoksayar CommandTimeout .
Ayrıca bkz.
Şunlara uygulanır
BeginExecuteReader(AsyncCallback, Object, CommandBehavior)
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
- Kaynak:
- SqlCommand.cs
bu SqlCommand tarafından açıklanan Transact-SQL deyiminin veya saklı yordamın zaman uyumsuz yürütülmesini başlatır.
CommandBehavior değerler ve bir geri çağırma yordamı ve durum bilgileri verilip sunucudan bir veya daha fazla sonuç kümesi alınır.
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 IAsyncResultParametreler
- callback
- AsyncCallback
AsyncCallback Komutun yürütülmesi tamamlandığında çağrılan bir temsilci. Geçirmek Geri çağırma gerekmediğini belirtmek için null (Microsoft Visual Basic'da Nothing).
- stateObject
- Object
Geri çağırma yordamına geçirilen kullanıcı tanımlı durum nesnesi. özelliğini kullanarak AsyncState geri çağırma yordamının içinden bu nesneyi alın.
- behavior
- CommandBehavior
CommandBehavior Deyim yürütme ve veri alma seçeneklerini gösteren değerlerden biri.
Döndürülenler
IAsyncResult Yoklama yapmak veya sonuçları beklemek için veya her ikisini birden yapmak için kullanılabilecek bir değer; döndürülen satırları almak için kullanılabilecek bir SqlDataReader örnek döndüren çağrılırken EndExecuteReader(IAsyncResult) de bu değer gereklidir.
Özel durumlar
SqlDbType olarak ayarlandığında Streamİkili veya VarBinary dışında bir değer kullanıldıValue. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
-veya-
SqlDbType Olarak ayarlandığında TextReaderChar, NChar, NVarChar, VarChar veya Xml dışında bir değer kullanıldıValue.
-veya-
SqlDbType olarak ayarlandığında XmlReaderXml dışında bir değer kullanıldıValue.
Komut metni yürütülürken oluşan herhangi bir hata.
-veya-
Akış işlemi sırasında zaman aşımı oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
Akış SqlConnection işlemi sırasında kapatılan veya bırakılan. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
- 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.
Akış işlemi sırasında bir Stream veya XmlReaderTextReader nesnesinde hata oluştu. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
bir Stream akış işlemi sırasında , XmlReader veya TextReader nesnesi kapatıldı. Akış hakkında daha fazla bilgi için bkz. SqlClient Akış Desteği.
Örnekler
Aşağıdaki Windows uygulaması, BeginExecuteReader yönteminin kullanımını gösterir; birkaç saniyelik bir gecikme içeren (uzun süre çalışan bir komutu öykünme) bir Transact-SQL deyimi yürütür. Örnek komutu zaman uyumsuz olarak yürüttüğünden, form sonuçları beklerken yanıt vermeye devam eder. Bu örnek, yürüten SqlCommand nesneyi parametresi olarak stateObject geçirir; bunu yaptığınızda, kodun ilk çağrısına SqlCommandkarşılık gelen yöntemi çağırabilmesi EndExecuteReader için geri çağırma yordamının içinden nesnenin alınması BeginExecuteReader basitleştirilir.
Bu örnekte birçok önemli teknik gösterilmektedir. Bu, formla ayrı bir iş parçacığından etkileşim kuran bir yöntemi çağırmayı içerir. Buna ek olarak, bu örnekte kullanıcıların komutu eşzamanlı olarak birden çok kez yürütmesini nasıl engellemeniz gerektiği ve geri çağırma yordamı çağrılmadan önce formun kapanmadığından nasıl emin olmanız gerektiği gösterilmektedir.
Bu örneği ayarlamak için yeni bir Windows uygulaması oluşturun. Forma bir Button denetim, bir DataGridView denetim ve bir Label denetim koyun (her denetim için varsayılan adı kabul etme). Ortamınız için gerekli bağlantı dizesini değiştirerek formun sınıfına aşağıdaki kodu ekleyin.
Bu örnek parametresindeki CommandBehavior.CloseConnectionbehavior değeri geçirir ve döndürülen SqlDataReader değerin kapatıldığında bağlantısını otomatik olarak kapatmasına neden olur.
#if NETFRAMEWORK
#nullable enable
// <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 SqlCommand_BeginExecuteReaderAsyncBehavior
{
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
this.label1 = new Label();
this.dataGridView1 = new DataGridView();
this.button1 = new Button();
}
private void 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 Label label1 { get; set; }
private DataGridView dataGridView1 { get; set; }
private Button button1 { get; set; }
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>
#endif
Açıklamalar
yöntemi, BeginExecuteReader deyimi yürütülürken diğer görevlerin eşzamanlı olarak çalışabilmesi için satır döndüren bir Transact-SQL deyimini veya saklı yordamı zaman uyumsuz olarak yürütme işlemini başlatır. Deyimi tamamlandığında, geliştiricilerin işlemi tamamlamak ve komutu tarafından döndürüleni EndExecuteReader almak için yöntemini çağırması SqlDataReader gerekir. BeginExecuteReader yöntemi hemen döndürür, ancak kod karşılık gelen EndExecuteReader yöntem çağrısını yürütene kadar, aynı SqlCommand nesneye karşı zaman uyumlu veya zaman uyumsuz yürütme başlatan diğer çağrıları yürütmemelidir. EndExecuteReader Komutun yürütülmesi tamamlanmadan önce öğesini çağırmak, yürütme tamamlanana kadar nesnesinin engellenmesine neden olurSqlCommand.
parametresi, callback deyimi tamamlandığında çağrılan bir AsyncCallback temsilci belirtmenize olanak tanır. Yöntemini bu temsilci yordamından veya uygulamanızın içinde başka bir konumdan çağırabilirsiniz EndExecuteReader . Ayrıca parametresindeki stateObject herhangi bir nesneyi geçirebilirsiniz ve geri çağırma yordamınız özelliğini kullanarak AsyncState bu bilgileri alabilir.
parametresi, behavior komutun ve bağlantısının davranışını denetleye seçenekleri belirtmenize olanak tanır. Bu değerler birlikte birleştirilebilir (programlama dilinin Or işleci kullanılarak); genellikle geliştiriciler, kapatıldığında CloseConnection bağlantının çalışma zamanı tarafından kapatıldığından emin olmak için bu değeri kullanırSqlDataReader. Geliştiriciler ayrıca, Transact-SQL deyiminin SqlDataReader veya saklı yordamın SingleRow yalnızca tek bir satır döndürdüğü önceden bilindiğinde değerini belirterek öğesinin davranışını iyileştirebilir.
Komut metninin ve parametrelerinin sunucuya zaman uyumlu olarak gönderildiğini unutmayın. Büyük bir komut veya çok sayıda parametre gönderilirse, bu yöntem yazma işlemleri sırasında engelleyebilir. Komut gönderildikten sonra, yöntem sunucudan yanıt beklemeden hemen geri döner; yani okumalar zaman uyumsuzdur. Komut yürütme zaman uyumsuz olsa da, değer getirme hala zaman uyumludur. Bu, daha fazla veri gerektiğinde ve temel ağın okuma işlemi blokları olduğunda çağrısının Read engellenebileceği anlamına gelir.
Geri çağırma yordamı Microsoft .NET ortak dil çalışma zamanı tarafından sağlanan bir arka plan iş parçacığı içinden yürütülür, çünkü uygulamalarınızdan çapraz iş parçacıkları etkileşimlerini işlemeye yönelik sıkı bir yaklaşım benimsemeniz çok önemlidir. Örneğin, geri çağırma yordamınızın içinden bir formun içeriğiyle etkileşim kurmamalısınız; formu güncelleştirmeniz gerekiyorsa, işinizi yapmak için formun iş parçacığına geri dönmeniz gerekir. Bu konudaki örnekte bu davranış gösterilmektedir.
İşlemin yürütülmesi sırasında oluşan tüm hatalar geri çağırma yordamında özel durumlar olarak oluşturulur. Özel durumu ana uygulamada değil geri çağırma yordamında işlemeniz gerekir. Geri çağırma yordamındaki özel durumları işleme hakkında ek bilgi için bu konudaki örne bakın.
XML verilerine erişmek için veya ExecuteReader kullanırsanızBeginExecuteReader, SQL Server her biri 2.033 karakterden oluşan birden çok satırda 2.033 karakterden uzun tüm XML sonuçlarını döndürür. Bu davranışı önlemek için veya ExecuteXmlReader komutunu kullanarak BeginExecuteXmlReader FOR XML sorgularını okuyun.
Bu yöntem özelliğini yoksayar CommandTimeout .