Aggregates
Last updated
Last updated
The query builder also provides a variety of aggregate methods such as count
, max
, min
, and sum
. These methods take the headache out of setting up these common aggregate functions.
When executing any of the aggregate functions, any where
restrictions on your query will still be applied.
Instead of returning a query, these methods return a simple value.
Returns true
if the query returns any rows. Returns false
otherwise.
Name | Type | Required | Default | Description |
---|---|---|---|---|
Returns true
if the query returns any rows. Throws a RecordNotFound
exception otherwise.
Returns an integer number of rows returned by the query.
Returns the maximum value for the given column.
Returns the minimum value for the given column.
Returns the sum of all returned rows for the given column.
Returns the sum of all returned rows for the expression.
Retrieves the columns for the configured table.
Name
Type
Required
Default
Description
options
struct
false
{}
Any additional queryExecute
options.
options
struct
false
{}
Any additional queryExecute
options.
errorMessage
string
false
An optional string error message.
Name
Type
Required
Default
Description
column
string
false
"*"
The column on which to count records.
options
struct
false
{}
Any additional queryExecute
options.
Name
Type
Required
Default
Description
column
string
true
The column on which to find the max.
options
struct
false
{}
Any additional queryExecute
options.
Name
Type
Required
Default
Description
column
string
true
The column on which to find the min.
options
struct
false
{}
Any additional queryExecute
options.
Name
Type
Required
Default
Description
column
string
true
The column to sum.
options
struct
false
{}
Any additional queryExecute
options.
Name
Type
Required
Default
Description
column
string
true
The column to sum.
options
struct
false
{}
Any additional queryExecute
options.
Name
Type
Required
Default
Description
asQuery
boolean
false
false
Flag to retrieve the columnList as a query instead of an array.
datasource
string
false
Optional datasource to from which to retrieve the columnList.