SqlCommand.ExecuteScalar Метод

Определение

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

System.Data.SqlClient

Сборка:

System.Data.dll

Выполняет запрос и возвращает первый столбец первой строки в результирующий набор, возвращенный запросом. Такие же дополнительные столбцы также определены.

public:
 override System::Object ^ ExecuteScalar();

public override object ExecuteScalar ();

override this.ExecuteScalar : unit -> obj

Public Overrides Function ExecuteScalar () As Object

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

Object

Первый столбец первой строки набора результатов или пустая ссылка (Nothing в Visual Basic), если набор результатов пуст. Возвращает не более 2033 символов.

Исключения

InvalidCastException

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

-или-

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

-или-

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

SqlException

Возникло исключение при выполнении команды в заблокированной строке. Это исключение не создается при использовании платформы Microsoft .NET Framework версии 1.0.

-или-

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

InvalidOperationException

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

IOException

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

ObjectDisposedException

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

Примеры

В следующем примере создается SqlCommand и выполняется с помощью ExecuteScalar. В этом примере передается строка, представляющая новое значение для вставки в таблицу, и строка, используемая для подключения к источнику данных. Функция возвращает новое значение столбца Identity , если была вставлена новая строка, 0 при сбое.

static public int AddProductCategory(string newName, string connString)
{
    Int32 newProdID = 0;
    string sql =
        "INSERT INTO Production.ProductCategory (Name) VALUES (@Name); "
        + "SELECT CAST(scope_identity() AS int)";
    using (SqlConnection conn = new SqlConnection(connString))
    {
        SqlCommand cmd = new SqlCommand(sql, conn);
        cmd.Parameters.Add("@Name", SqlDbType.VarChar);
        cmd.Parameters["@name"].Value = newName;
        try
        {
            conn.Open();
            newProdID = (Int32)cmd.ExecuteScalar();
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
    return (int)newProdID;
}

Public Function AddProductCategory( _
  ByVal newName As String, ByVal connString As String) As Integer
    Dim newProdID As Int32 = 0
    Dim sql As String = _
     "INSERT INTO Production.ProductCategory (Name) VALUES (@Name); " _
       & "SELECT CAST(scope_identity() AS int);"

    Using conn As New SqlConnection(connString)
        Dim cmd As New SqlCommand(sql, conn)
        cmd.Parameters.Add("@Name", SqlDbType.VarChar)
        cmd.Parameters("@Name").Value = newName
        Try
            conn.Open()
            newProdID = Convert.ToInt32(cmd.ExecuteScalar())
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Using

    Return newProdID
End Function

Комментарии

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

Типичный ExecuteScalar запрос можно отформатировать, как показано в следующем примере C#:

cmd.CommandText = "SELECT COUNT(*) FROM dbo.region";
Int32 count = (Int32) cmd.ExecuteScalar();

См. также раздел

• Подключение и получение данных в ADO.NET
• Использование поставщика данных платформа .NET Framework для SQL Server
• Общие сведения об ADO.NET