Method GetScalar

Namespace

YndigoBlue.Velocity.Engine

Assembly

YndigoBlue.Velocity.dll

GetScalar(Query)

Executes a query and returns a single scalar value (typically from aggregate functions or single-value queries).

public object GetScalar(Query query)

Parameters

query Query

The Query to execute.

Returns

object

The scalar value as an object.

Examples

using (var m = new Manager(conn))
{
    var schema = m.LoadSchema("app");
    var usersTable = schema["users"];

    // Get count of users
    var query = new Query()
        .Select([new Aggregate(usersTable["id"], AggregateType.Count)])
        .From(usersTable);

    object count = m.GetScalar(query);
    Console.WriteLine($"Total users: {count}");
}

Exceptions

DbException

Thrown when a database error occurs.

GetScalar<T>(Query)

Executes a query and returns a single scalar value cast to a specific type.

public T GetScalar<T>(Query query)

Parameters

query Query

The Query to execute.

Returns

T

The scalar value cast to type T.

Type Parameters

T

The type to cast the scalar value to.

Examples

using (var m = new Manager(conn))
{
    var schema = m.LoadSchema("app");
    var ordersTable = schema["orders"];

    // Get total sales amount
    var query = new Query()
        .Select([new Aggregate(ordersTable["amount"], AggregateType.Sum)])
        .From(ordersTable);

    decimal totalSales = m.GetScalar<decimal>(query);
    Console.WriteLine($"Total sales: ${totalSales:F2}");
}

Exceptions

DbException

Thrown when a database error occurs.