SqlCommand.BeginExecuteNonQuery Метод

Определение

Пространство имен:

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.dll

Пакет:

Microsoft.Data.SqlClient v5.2.0

Перегрузки

BeginExecuteNonQuery()	Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описанной в этом SqlCommand .
BeginExecuteNonQuery(AsyncCallback, Object)	Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описанной в данном SqlCommand параметре , с учетом процедуры обратного вызова и сведений о состоянии.

BeginExecuteNonQuery()

Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описанной в этом SqlCommand .

public:
 IAsyncResult ^ BeginExecuteNonQuery();

public IAsyncResult BeginExecuteNonQuery ();

member this.BeginExecuteNonQuery : unit -> IAsyncResult

Public Function BeginExecuteNonQuery () As IAsyncResult

Возвращаемое значение

IAsyncResult

Объект , IAsyncResult который можно использовать для опроса или ожидания результатов, или и того, и другого; это значение также необходимо при вызове EndExecuteNonQuery(IAsyncResult) , который возвращает количество затронутых строк.

Исключения

InvalidCastException

Если SqlDbType для параметра задано значение Stream , отличное от Binary или VarBinary, использовался Value . Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.

-или-

Если SqlDbType для параметра задано значение TextReader , кроме Char, NChar, NVarChar, VarChar или Xml, использовался Value объект , отличный от Char, NChar, NVarChar, VarChar или Xml.

-или-

Объект , отличный SqlDbType от XML , использовался, когда Value для параметра задано значение XmlReader .

SqlException

Любая ошибка, произошедшая во время выполнения текста команды.

-или-

Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.

InvalidOperationException

Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи 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

Ошибка в объекте Stream или XmlReaderTextReader во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.

ObjectDisposedException

Объект Stream или XmlReaderTextReader был закрыт во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.

Примеры

Следующее консольное приложение создает данные обновлений в образце базы данных AdventureWorks , выполняя свою работу асинхронно. Чтобы эмулировать длительный процесс, в этом примере в текст команды вставляется инструкция WAITFOR. Как правило, вы не будете предпринимать усилия, чтобы замедлить выполнение команд, но в этом случае это упростит демонстрацию асинхронного поведения.

// <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>

Комментарии

Метод BeginExecuteNonQuery запускает процесс асинхронного выполнения инструкции Transact-SQL или хранимой процедуры, которая не возвращает строки, чтобы другие задачи могли выполняться параллельно во время выполнения инструкции. После завершения инструкции разработчики должны вызвать EndExecuteNonQuery метод , чтобы завершить операцию. Метод BeginExecuteNonQuery возвращает немедленно, но пока код не выполнит соответствующий EndExecuteNonQuery вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта. EndExecuteNonQuery Вызов до завершения выполнения команды приводит к блокировке SqlCommand объекта до завершения выполнения.

Обратите внимание, что текст команды и параметры отправляются на сервер синхронно. Если отправляется большая команда или много параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения являются асинхронными.

Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчики должны либо выполнить опрос, чтобы определить, выполнена ли команда, используя IsCompleted свойство IAsyncResult объекта , возвращаемого методом BeginExecuteNonQuery , либо дождаться завершения одной или нескольких команд с помощью AsyncWaitHandle свойства возвращаемого IAsyncResultобъекта .

Этот метод игнорирует CommandTimeout свойство .

BeginExecuteNonQuery(AsyncCallback, Object)

Инициирует асинхронное выполнение инструкции Transact-SQL или хранимой процедуры, описанной в данном SqlCommand параметре , с учетом процедуры обратного вызова и сведений о состоянии.

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

Параметры

callback

AsyncCallback

Делегат AsyncCallback, вызываемый по завершении выполнения команды. Успехnull ( Nothing в Microsoft Visual Basic), чтобы указать, что обратный вызов не требуется.

stateObject

Object

Определяемый пользователем объект состояния, передаваемый процедуре обратного вызова. Извлечение этого объекта в процедуре обратного вызова осуществляется посредством свойства AsyncState.

Возвращаемое значение

IAsyncResult

Объект , IAsyncResult который можно использовать для опроса или ожидания результатов, или и того, и другого; это значение также необходимо при вызове EndExecuteNonQuery(IAsyncResult) , который возвращает количество затронутых строк.

Исключения

InvalidCastException

Если SqlDbType для параметра задано значение Stream , отличное от Binary или VarBinary, использовался Value . Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.

-или-

Если SqlDbType для параметра задано значение TextReader , кроме Char, NChar, NVarChar, VarChar или Xml, использовался Value объект , отличный от Char, NChar, NVarChar, VarChar или Xml.

-или-

Объект , отличный SqlDbType от XML , использовался, когда Value для параметра задано значение XmlReader .

SqlException

Любая ошибка, произошедшая во время выполнения текста команды.

-или-

Во время операции потоковой передачи истекло время ожидания. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи SqlClient.

InvalidOperationException

Подключение SqlConnection, закрытое или удаленное во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе Поддержка потоковой передачи 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.

Примеры

В следующем приложении Windows демонстрируется использование BeginExecuteNonQuery метода , выполняющего инструкцию Transact-SQL с задержкой в несколько секунд (эмуляция длительно выполняющейся команды).

В этом примере демонстрируется множество важных методов. Сюда входит вызов метода, который взаимодействует с формой из отдельного потока. Кроме того, в этом примере показано, как запретить пользователям выполнять команду несколько раз одновременно и как убедиться, что форма не закрывается до вызова процедуры обратного вызова.

Чтобы настроить этот пример, создайте новое приложение Windows. Поместите элемент Button управления и Label элемент управления в форму (принимая имена по умолчанию для каждого элемента управления). Добавьте следующий код в класс формы, изменив строку подключения по мере необходимости для вашей среды.

// <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>

Комментарии

Метод BeginExecuteNonQuery запускает процесс асинхронного выполнения инструкции Transact-SQL или хранимой процедуры, которая не возвращает строки, чтобы другие задачи могли выполняться параллельно во время выполнения инструкции. После завершения инструкции разработчики должны вызвать EndExecuteNonQuery метод , чтобы завершить операцию. Метод BeginExecuteNonQuery возвращает немедленно, но пока код не выполнит соответствующий EndExecuteNonQuery вызов метода, он не должен выполнять другие вызовы, запускающие синхронное или асинхронное выполнение для того же SqlCommand объекта. EndExecuteNonQuery Вызов до завершения выполнения команды приводит к блокировке SqlCommand объекта до завершения выполнения.

Параметр callback позволяет указать AsyncCallback делегат, который вызывается после завершения инструкции. Метод можно вызвать из этой процедуры делегата EndExecuteNonQuery или из любого другого расположения в приложении. Кроме того, можно передать любой объект в параметре , а процедура обратного asyncStateObject вызова может получить эти сведения с помощью AsyncState свойства .

Обратите внимание, что текст команды и параметры отправляются на сервер синхронно. Если отправляется большая команда или много параметров, этот метод может блокироваться во время записи. После отправки команды метод возвращается немедленно, не ожидая ответа от сервера, то есть операции чтения являются асинхронными.

Так как процедура обратного вызова выполняется из фонового потока, предоставляемого средой CLR Microsoft .NET, очень важно тщательно подходить к обработке взаимодействий между потоками из приложений. Например, нельзя взаимодействовать с содержимым формы из процедуры обратного вызова; Если необходимо обновить форму, необходимо вернуться к потоку формы, чтобы выполнить свою работу. Это поведение демонстрируется в примере в этом разделе.

Все ошибки, возникающие во время выполнения операции, создаются как исключения в процедуре обратного вызова. Исключение необходимо обрабатывать в процедуре обратного вызова, а не в основном приложении. Дополнительные сведения об обработке исключений в процедуре обратного вызова см. в этом разделе.

Этот метод игнорирует CommandTimeout свойство .