SqlCommand.BeginExecuteNonQuery Metoda

Definice

Obor názvů:

Microsoft.Data.SqlClient

Sestavení:

Microsoft.Data.SqlClient.dll

Balíček:

Microsoft.Data.SqlClient v7.0.1

Přetížení

Name	Description
BeginExecuteNonQuery()	Iniciuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand.
BeginExecuteNonQuery(AsyncCallback, Object)	Iniciuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommandzpůsobem , zadanou procedurou zpětného volání a informace o stavu.

BeginExecuteNonQuery()

Iniciuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommand.

public:
 IAsyncResult ^ BeginExecuteNonQuery();

public IAsyncResult BeginExecuteNonQuery();

member this.BeginExecuteNonQuery : unit -> IAsyncResult

Public Function BeginExecuteNonQuery () As IAsyncResult

Návraty

IAsyncResult

Tuto IAsyncResult hodnotu je možné použít k dotazování nebo čekání na výsledky nebo obojí; tato hodnota je také nutná při vyvolání EndExecuteNonQuery(IAsyncResult), která vrátí počet ovlivněných řádků.

Výjimky

InvalidCastException

• Jiný SqlDbType než Binary nebo VarBinary byl použit při Value nastavení Stream. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• Jiný SqlDbType než Char, , NChar, NVarCharVarCharnebo Xml byl použit při Value nastavení TextReader.
• Jiné SqlDbType , než Xml bylo použito při Value nastavení XmlReader.

SqlException

• Jakákoli chyba, ke které došlo při provádění textu příkazu.
• 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.

InvalidOperationException

• Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• EnableOptimizedParameterBinding je nastavena na hodnotu true a parametr se směrem Output nebo InputOutput byl přidán do Parameters kolekce.

IOException

Během operace streamování došlo k chybě nebo TextReader objektuStreamXmlReader. Další informace o streamování najdete v tématu Podpora streamování SqlClient.

ObjectDisposedException

Stream Objekt XmlReadernebo TextReader objekt 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 vytvoří data aktualizací v ukázkové databázi AdventureWorks a provádí svou práci asynchronně. Aby bylo možné emulovat dlouhotrvající proces, vloží tento příklad WAITFOR příkaz do textu příkazu. Za normálních okolností byste se nemuseli snažit, aby příkazy běžely pomaleji, ale v tomto případě to usnadňuje předvedení asynchronního chování.

using System;
using System.Data;
using Microsoft.Data.SqlClient;

class Class1
{
    static void Main()
    {
        // This is a simple example that demonstrates the usage of the
        // BeginExecuteNonQuery functionality.
        // The WAITFOR statement simply adds enough time to prove the
        // asynchronous nature of the command.

        string commandText =
            "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
            "WHERE ReorderPoint Is Not Null;" +
            "WAITFOR DELAY '0:0:3';" +
            "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
            "WHERE ReorderPoint Is Not Null";

        RunCommandAsynchronously(commandText, GetConnectionString());

        Console.WriteLine("Press ENTER to continue.");
        Console.ReadLine();
    }

    private static void RunCommandAsynchronously(string commandText, string connectionString)
    {
        // Given command text and connection string, asynchronously execute
        // the specified command against the connection. For this example,
        // the code displays an indicator as it is working, verifying the
        // asynchronous behavior.
        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            try
            {
                int count = 0;
                SqlCommand command = new SqlCommand(commandText, connection);
                connection.Open();

                IAsyncResult result = command.BeginExecuteNonQuery();
                while (!result.IsCompleted)
                {
                    Console.WriteLine("Waiting ({0})", count++);
                    // Wait for 1/10 second, so the counter
                    // does not consume all available resources
                    // on the main thread.
                    System.Threading.Thread.Sleep(100);
                }

                Console.WriteLine("Command complete. Affected {0} rows.",
                    command.EndExecuteNonQuery(result));
            }
            catch (SqlException ex)
            {
                Console.WriteLine("Error ({0}): {1}", ex.Number, ex.Message);
            }
            catch (InvalidOperationException ex)
            {
                Console.WriteLine("Error: {0}", ex.Message);
            }
            catch (Exception ex)
            {
                // You might want to pass these errors
                // back out to the caller.
                Console.WriteLine("Error: {0}", ex.Message);
            }
        }
    }

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file.
        return "Data Source=(local);Integrated Security=SSPI;" +
               "Initial Catalog=AdventureWorks";
    }
}

Poznámky

Metoda BeginExecuteNonQuery() spustí proces asynchronního provádění příkazu Transact-SQL nebo uložené procedury, která nevrací řádky, aby ostatní úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteNonQuery(IAsyncResult) , aby operaci dokončili. Metoda BeginExecuteNonQuery() vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteNonQuery(IAsyncResult) volání metody, nesmí provádět žádné další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteNonQuery(IAsyncResult) Voláním před dokončením SqlCommand příkazu se objekt zablokuje, dokud se provádění nedokončí.

Všimněte si, že text příkazu a parametry se odesílají synchronně na server. Pokud se odešle velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu vrátí metoda okamžitě bez čekání na odpověď ze serveru – to znamená, že čtení jsou asynchronní.

Vzhledem k tomu, že toto přetížení nepodporuje proceduru zpětného volání, musí vývojáři buď 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é IAsyncResult.

Tato metoda ignoruje CommandTimeout vlastnost.

BeginExecuteNonQuery(AsyncCallback, Object)

Iniciuje asynchronní spuštění příkazu Transact-SQL nebo uložené procedury, která je popsána tímto SqlCommandzpůsobem , zadanou procedurou zpětného volání a informace o stavu.

public:
 IAsyncResult ^ BeginExecuteNonQuery(AsyncCallback ^ callback, System::Object ^ stateObject);

public IAsyncResult BeginExecuteNonQuery(AsyncCallback callback, object stateObject);

member this.BeginExecuteNonQuery : AsyncCallback * obj -> IAsyncResult

Public Function BeginExecuteNonQuery (callback As AsyncCallback, stateObject As Object) As IAsyncResult

Parametry

callback

AsyncCallback

AsyncCallback Delegát, který je vyvolán po dokončení provádění příkazu. Předáním null (Nothing v jazyce Microsoft Visual Basic) označíte, že není vyžadováno žádné zpětné volání.

stateObject

Object

Objekt stavu definovaný uživatelem, který se předává do procedury zpětného volání. Načtěte tento objekt z procedury zpětného volání pomocí AsyncState vlastnosti.

Návraty

IAsyncResult

Tuto IAsyncResult hodnotu je možné použít k dotazování nebo čekání na výsledky nebo obojí; tato hodnota je také nutná při vyvolání EndExecuteNonQuery(IAsyncResult), která vrátí počet ovlivněných řádků.

Výjimky

InvalidCastException

• Jiný SqlDbType než Binary nebo VarBinary byl použit při Value nastavení Stream. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• Jiný SqlDbType než Char, , NChar, NVarCharVarCharnebo Xml byl použit při Value nastavení TextReader.
• Jiné SqlDbType , než Xml bylo použito při Value nastavení XmlReader.

SqlException

• Jakákoli chyba, ke které došlo při provádění textu příkazu.
• 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.

InvalidOperationException

• Zavřený SqlConnection nebo ukončený během operace streamování. Další informace o streamování najdete v tématu Podpora streamování SqlClient.
• EnableOptimizedParameterBinding je nastavena na hodnotu true a parametr se směrem Output nebo InputOutput byl přidán do Parameters kolekce.

Příklady

Následující aplikace systému Windows ukazuje použití BeginExecuteNonQuery() metody, spuštění příkazu Transact-SQL, který zahrnuje zpoždění několika sekund (emulace dlouhotrvajícího příkazu).

Tento příklad ukazuje mnoho důležitých technik. To zahrnuje volání metody, která komunikuje s formulářem z samostatného vlákna. Kromě toho tento příklad ukazuje, jak je nutné uživatelům zablokovat provádění příkazu vícekrát souběžně a jak musíte zajistit, aby se formulář nezavřel před voláním procedury zpětného volání.

Pokud chcete tento příklad nastavit, vytvořte novou aplikaci pro Windows. Button Umístěte 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 podle potřeby upravte připojovací řetězec pro vaše prostředí.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;

namespace Microsoft.AdoDotNet.CodeSamples
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        // Hook up the form's Load event handler (you can double-click on
        // the form's design surface in Visual Studio), and then add
        // this code to the form's class:
        private void Form1_Load(object sender, EventArgs e)
        {
            this.button1.Click += new System.EventHandler(this.button1_Click);
            this.FormClosing += new System.Windows.Forms.
                FormClosingEventHandler(this.Form1_FormClosing);
        }

        // You need this delegate in order to display text from a thread
        // other than the form's thread. See the HandleCallback
        // procedure for more information.
        // This same delegate matches both the DisplayStatus
        // and DisplayResults methods.
        private delegate void DisplayInfoDelegate(string Text);

        // This flag ensures that the user does not attempt
        // to restart the command or close the form while the
        // asynchronous command is executing.
        private bool isExecuting;

        // This example maintains the connection object
        // externally, so that it is available for closing.
        private SqlConnection connection;

        private static string GetConnectionString()
        {
            // To avoid storing the connection string in your code,
            // you can retrieve it from a configuration file.
            return "Data Source=(local);Integrated Security=true;" +
                   "Initial Catalog=AdventureWorks";
        }

        private void DisplayStatus(string Text)
        {
            this.label1.Text = Text;
        }

        private void DisplayResults(string Text)
        {
            this.label1.Text = Text;
            DisplayStatus("Ready");
        }

        private void Form1_FormClosing(object sender, System.Windows.Forms.FormClosingEventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this, "Cannot close the form until " +
                    "the pending asynchronous command has completed. Please wait...");
                e.Cancel = true;
            }
        }

        private void button1_Click(object sender, System.EventArgs e)
        {
            if (isExecuting)
            {
                MessageBox.Show(this,
                    "Already executing. Please wait until the current query " +
                    "has completed.");
            }
            else
            {
                SqlCommand command = null;
                try
                {
                    DisplayResults("");
                    DisplayStatus("Connecting...");
                    connection = new SqlConnection(GetConnectionString());
                    // To emulate a long-running query, wait for
                    // a few seconds before working with the data.
                    // This command does not do much, but that's the point--
                    // it does not change your data, in the long run.
                    string commandText =
                        "WAITFOR DELAY '0:0:05';" +
                        "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
                        "WHERE ReorderPoint Is Not Null;" +
                        "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
                        "WHERE ReorderPoint Is Not Null";

                    command = new SqlCommand(commandText, connection);
                    connection.Open();

                    DisplayStatus("Executing...");
                    isExecuting = true;
                    // Although it is not required that you pass the
                    // SqlCommand object as the second parameter in the
                    // BeginExecuteNonQuery call, doing so makes it easier
                    // to call EndExecuteNonQuery in the callback procedure.
                    AsyncCallback callback = new AsyncCallback(HandleCallback);
                    command.BeginExecuteNonQuery(callback, command);

                }
                catch (Exception ex)
                {
                    isExecuting = false;
                    DisplayStatus(string.Format("Ready (last error: {0})", ex.Message));
                    if (connection != null)
                    {
                        connection.Close();
                    }
                }
            }
        }

        private void HandleCallback(IAsyncResult result)
        {
            try
            {
                // Retrieve the original command object, passed
                // to this procedure in the AsyncState property
                // of the IAsyncResult parameter.
                SqlCommand command = (SqlCommand)result.AsyncState;
                int rowCount = command.EndExecuteNonQuery(result);
                string rowText = " rows affected.";
                if (rowCount == 1)
                {
                    rowText = " row affected.";
                }

                rowText = rowCount + rowText;

                // You may not interact with the form and its contents
                // from a different thread, and this callback procedure
                // is all but guaranteed to be running from a different thread
                // than the form. Therefore you cannot simply call code that
                // displays the results, like this:
                // DisplayResults(rowText)

                // Instead, you must call the procedure from the form's thread.
                // One simple way to accomplish this is to call the Invoke
                // method of the form, which calls the delegate you supply
                // from the form's thread.
                DisplayInfoDelegate del = new DisplayInfoDelegate(DisplayResults);
                this.Invoke(del, rowText);

            }
            catch (Exception ex)
            {
                // Because you are now running code in a separate thread,
                // if you do not handle the exception here, none of your other
                // code catches the exception. Because none of
                // your code is on the call stack in this thread, there is nothing
                // higher up the stack to catch the exception if you do not
                // handle it here. You can either log the exception or
                // invoke a delegate (as in the non-error case in this
                // example) to display the error on the form. In no case
                // can you simply display the error without executing a delegate
                // as in the try block here.

                // You can create the delegate instance as you
                // invoke it, like this:
                this.Invoke(new DisplayInfoDelegate(DisplayStatus),
                    String.Format("Ready(last error: {0}", ex.Message));
            }
            finally
            {
                isExecuting = false;
                if (connection != null)
                {
                    connection.Close();
                }
            }
        }
    }
}

Poznámky

Metoda BeginExecuteNonQuery() spustí proces asynchronního provádění příkazu Transact-SQL nebo uložené procedury, která nevrací řádky, aby ostatní úlohy mohly běžet souběžně během provádění příkazu. Po dokončení příkazu musí vývojáři volat metodu EndExecuteNonQuery(IAsyncResult) , aby operaci dokončili. Metoda BeginExecuteNonQuery() vrátí okamžitě, ale dokud kód neprovede odpovídající EndExecuteNonQuery(IAsyncResult) volání metody, nesmí provádět žádné další volání, která spustí synchronní nebo asynchronní spuštění proti stejnému SqlCommand objektu. EndExecuteNonQuery(IAsyncResult) Voláním před dokončením SqlCommand příkazu se objekt zablokuje, dokud se provádění nedokončí.

Parametr callback umožňuje zadat delegáta AsyncCallback , který je volána po dokončení příkazu. Metodu EndExecuteNonQuery(IAsyncResult) můžete volat z tohoto postupu delegáta nebo z libovolného jiného umístění v aplikaci. Kromě toho můžete předat libovolný objekt v parametru stateObject a procedura zpětného AsyncState volání může načíst tyto informace pomocí vlastnosti.

Všimněte si, že text příkazu a parametry se odesílají synchronně na server. Pokud se odešle velký příkaz nebo mnoho parametrů, může tato metoda blokovat během zápisu. Po odeslání příkazu metoda vrátí okamžitě bez čekání na odpověď ze serveru - to znamená, čtení jsou asynchronní.

Vzhledem k tomu, že se procedura zpětného volání provádí z vlákna na pozadí dodaného modulem Clr (Common Language Runtime) Microsoft .NET, je velmi důležité, abyste při zpracování interakcí mezi vlákny z vašich aplikací provedli důkladný přístup. Například nesmíte pracovat s obsahem formuláře v rámci procedury zpětného volání; pokud chcete formulář aktualizovat, musíte přepnout zpět na vlákno formuláře, abyste mohli pracovat. Příklad v tomto tématu ukazuje toto chování.

Všechny chyby, ke kterým dochází během provádění operace, jsou vyvolány jako výjimky v postupu zpětného volání. Výjimku musíte zpracovat v postupu 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.

Tato metoda ignoruje CommandTimeout vlastnost.