SqlCommand.BeginExecuteNonQuery Método

Definição

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v5.2.0

Sobrecargas

BeginExecuteNonQuery()	Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand .
BeginExecuteNonQuery(AsyncCallback, Object)	Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand , considerando um procedimento de retorno de chamada e informações de estado.

BeginExecuteNonQuery()

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand .

public:
 IAsyncResult ^ BeginExecuteNonQuery();

public IAsyncResult BeginExecuteNonQuery ();

member this.BeginExecuteNonQuery : unit -> IAsyncResult

Public Function BeginExecuteNonQuery () As IAsyncResult

Retornos

IAsyncResult

Um IAsyncResult que pode ser usado para sondar ou aguardar resultados ou ambos; esse valor também é necessário ao invocar EndExecuteNonQuery(IAsyncResult) , que retorna o número de linhas afetadas.

Exceções

InvalidCastException

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido Stream como . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando foi definido TextReader como Value .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido XmlReader como .

SqlException

Qualquer erro ocorrido ao executar o texto do comando.

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

InvalidOperationException

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

IOException

Ocorreu um erro em um Stream objeto ou TextReaderXmlReader durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

ObjectDisposedException

O Stream objeto ou TextReaderXmlReader foi fechado durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

Exemplos

O aplicativo de console a seguir cria dados de atualizações no banco de dados de exemplo AdventureWorks , fazendo seu trabalho de forma assíncrona. Para emular um processo de execução demorada, este exemplo insere uma instrução WAITFOR no texto do comando. Normalmente, você não se esforçaria para fazer com que seus comandos fossem executados mais lentamente, mas fazer isso nesse caso facilita a demonstração do comportamento assíncrono.

// <Snippet1>
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";
    }
}
// </Snippet1>

Comentários

O BeginExecuteNonQuery método inicia o processo de execução assíncrona de uma instrução Transact-SQL ou um procedimento armazenado que não retorna linhas, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está sendo executada. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteNonQuery método para concluir a operação. O BeginExecuteNonQuery método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteNonQuery , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteNonQuery antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.

Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros forem enviados, esse método poderá ser bloqueado durante gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor, ou seja, as leituras são assíncronas.

Como essa sobrecarga não dá suporte a um procedimento de retorno de chamada, os desenvolvedores devem sondar para determinar se o comando foi concluído, usando a propriedade do IAsyncResult retornado pelo BeginExecuteNonQuery método ou aguardar a conclusão de um ou mais comandos usando a AsyncWaitHandle propriedade do retornadoIAsyncResult.IsCompleted

Esse método ignora a CommandTimeout propriedade .

BeginExecuteNonQuery(AsyncCallback, Object)

Inicia a execução assíncrona da instrução Transact-SQL ou do procedimento armazenado descrito por este SqlCommand , considerando um procedimento de retorno de chamada e informações de estado.

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

Parâmetros

callback

AsyncCallback

Um delegado AsyncCallback invocado quando a execução do comando for concluída. Aprovadonull ( Nothing no Microsoft Visual Basic) para indicar que nenhum retorno de chamada é necessário.

stateObject

Object

Um objeto de estado definido pelo usuário passado para o procedimento de retorno de chamada. Recupere esse objeto de dentro do procedimento de retorno de chamada usando a propriedade AsyncState.

Retornos

IAsyncResult

Um IAsyncResult que pode ser usado para sondar ou aguardar resultados ou ambos; esse valor também é necessário ao invocar EndExecuteNonQuery(IAsyncResult) , que retorna o número de linhas afetadas.

Exceções

InvalidCastException

Um SqlDbType diferente de Binary ou VarBinary foi usado quando Value foi definido Stream como . Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- ou -

Um SqlDbType diferente de Char, NChar, NVarChar, VarChar ou Xml foi usado quando foi definido TextReader como Value .

-ou-

Um SqlDbType diferente de Xml foi usado quando Value foi definido XmlReader como .

SqlException

Qualquer erro ocorrido ao executar o texto do comando.

- ou -

Ocorreu um tempo limite durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

InvalidOperationException

O SqlConnection foi fechado ou removido durante uma operação de streaming. Para saber mais sobre o streaming, consulte SqlClient Streaming Support (Suporte de streaming do SqlClient).

- or -

<xref data-throw-if-not-resolved="true" uid="Microssoft.Data.SqlClient.SqlCommand.EnableOptimizedParameterBinding"></xref>
is set to true and a parameter with direction Output or InputOutput has been added to the <xref data-throw-if-not-resolved="true" uid="Microsoft.Data.SqlClient.SqlCommand.Parameters"></xref> collection.

Exemplos

O aplicativo windows a seguir demonstra o uso do BeginExecuteNonQuery método , executando uma instrução Transact-SQL que inclui um atraso de vários segundos (emulando um comando de execução longa).

Este exemplo demonstra muitas técnicas importantes. Isso inclui chamar um método que interage com o formulário de um thread separado. Além disso, este exemplo demonstra como você deve impedir que os usuários executem um comando várias vezes simultaneamente e como você deve garantir que o formulário não feche antes que o procedimento de retorno de chamada seja chamado.

Para configurar este exemplo, crie um aplicativo do Windows. Coloque um Button controle e um Label controle no formulário (aceitando o nome padrão para cada controle). Adicione o código a seguir à classe do formulário, modificando a cadeia de conexão conforme necessário para seu ambiente.

// <Snippet1>
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using Microsoft.Data.SqlClient;

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

        // Hook up the form's Load event handler (you can double-click on 
        // the form's design surface in Visual Studio), and then add 
        // this code to the form's class:
        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();
                }
            }
        }
    }
}
// </Snippet1>

Comentários

O BeginExecuteNonQuery método inicia o processo de execução assíncrona de uma instrução Transact-SQL ou um procedimento armazenado que não retorna linhas, para que outras tarefas possam ser executadas simultaneamente enquanto a instrução está sendo executada. Quando a instrução for concluída, os desenvolvedores deverão chamar o EndExecuteNonQuery método para concluir a operação. O BeginExecuteNonQuery método retorna imediatamente, mas até que o código execute a chamada de método correspondente EndExecuteNonQuery , ele não deve executar nenhuma outra chamada que inicie uma execução síncrona ou assíncrona no mesmo SqlCommand objeto. Chamar o EndExecuteNonQuery antes que a execução do comando seja concluída faz com que o SqlCommand objeto seja bloqueado até que a execução seja concluída.

O callback parâmetro permite especificar um AsyncCallback delegado que é chamado quando a instrução é concluída. Você pode chamar o EndExecuteNonQuery método de dentro desse procedimento delegado ou de qualquer outro local em seu aplicativo. Além disso, você pode passar qualquer objeto no parâmetro e o asyncStateObject procedimento de retorno de chamada pode recuperar essas informações usando a AsyncState propriedade .

Observe que o texto do comando e os parâmetros são enviados para o servidor de forma síncrona. Se um comando grande ou muitos parâmetros forem enviados, esse método poderá ser bloqueado durante gravações. Depois que o comando é enviado, o método retorna imediatamente sem aguardar uma resposta do servidor, ou seja, as leituras são assíncronas.

Como o procedimento de retorno de chamada é executado de dentro de um thread em segundo plano fornecido pelo Common Language Runtime do Microsoft .NET, é muito importante que você tome uma abordagem rigorosa para lidar com interações entre threads de dentro de seus aplicativos. Por exemplo, você não deve interagir com o conteúdo de um formulário de dentro do procedimento de retorno de chamada; caso precise atualizar o formulário, você deve alternar de volta para o thread do formulário para fazer seu trabalho. O exemplo neste tópico demonstra esse comportamento.

Todos os erros que ocorrem durante a execução da operação são gerados como exceções no procedimento de retorno de chamada. Você deve manipular a exceção no procedimento de retorno de chamada, não no aplicativo principal. Consulte o exemplo neste tópico para obter informações adicionais sobre como lidar com exceções no procedimento de retorno de chamada.

Esse método ignora a CommandTimeout propriedade .