The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Session.ExecuteScalar(String) Method

Executes the specified SQL query and returns the first column of the first row in the result set returned by the query.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v19.2.dll

Declaration

public object ExecuteScalar(
    string sql
)
Public Function ExecuteScalar(
    sql As String
) As Object
public object ExecuteScalar(
    string sql
)
Public Function ExecuteScalar(
    sql As String
) As Object

Parameters

Name Type Description
sql String

A String value that specifies an SQL query.

Parameters

Name Type Description
sql String

A String value that specifies an SQL query.

Returns

Type Description
Object

The first column of the first row in the query's result set. If the column is not found in the result set, a null reference (Nothing in Visual Basic) is returned. If the value in the database is null, DBNull.Value is returned.

Returns

Type Description
Object

The first column of the first row in the query's result set. If the column is not found in the result set, a null reference (Nothing in Visual Basic) is returned. If the value in the database is null, DBNull.Value is returned.

Remarks

Use ExecuteScalar to query data stores for a single or aggregate value, without having to retrieve a result set.

The following example demonstrates how to use this method. Here, session is the Session instance.

public int GetOrdersCount() {
    return (int)session.ExecuteScalar(
        "SELECT COUNT(*) FROM [Northwind].[dbo].[Orders]"
    );        
}

To learn more about executing SQL queries in XPO, refer to Direct SQL Queries.

Note

The ExecuteScalar method sends queries directly, so the correct query syntax depends on a particular database server.

See Also