SqlCommand.BeginExecuteNonQuery Метод

Определение

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

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.dll

Пакет:

Microsoft.Data.SqlClient v7.0.1

Перегрузки

Имя	Описание
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 , отличное Binary от или VarBinary используемое, если Value задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
• ЗначениеSqlDbType, отличное от Char, NChar, NVarCharVarCharили Xml использовалось при Value установкеTextReader.
• Значение SqlDbType , отличное от Xml используемого при Value установке XmlReader.

SqlException

• Любая ошибка, которая произошла при выполнении текста команды.
• Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

InvalidOperationException

• Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
• EnableOptimizedParameterBinding имеет значение true, а параметр с направлением Output или InputOutput добавлен в коллекцию Parameters .

IOException

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

ObjectDisposedException

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

Примеры

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

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

Комментарии

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

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

Так как эта перегрузка не поддерживает процедуру обратного вызова, разработчики должны либо провести опрос, чтобы определить, выполнена ли команда, используя IsCompleted свойство IAsyncResultBeginExecuteNonQuery() возвращаемого методом; или дождитесь завершения одной или нескольких команд с помощью 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 , отличное Binary от или VarBinary используемое, если Value задано значение Stream. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
• ЗначениеSqlDbType, отличное от Char, NChar, NVarCharVarCharили Xml использовалось при Value установкеTextReader.
• Значение SqlDbType , отличное от Xml используемого при Value установке XmlReader.

SqlException

• Любая ошибка, которая произошла при выполнении текста команды.
• Время ожидания произошло во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".

InvalidOperationException

• Закрытый SqlConnection или удаленный во время операции потоковой передачи. Дополнительные сведения о потоковой передаче см. в разделе "Поддержка потоковой передачи SqlClient".
• EnableOptimizedParameterBinding имеет значение true, а параметр с направлением Output или InputOutput добавлен в коллекцию Parameters .

Примеры

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

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

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

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();
                }
            }
        }
    }
}

Комментарии

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

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

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

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

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

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