Search…
Aggregates
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.

exists

Name
Type
Required
Default
Description
options
struct
false
{}
Any additional queryExecute options.
Returns true if the query returns any rows. Returns false otherwise.
QueryBuilder
1
query.from( "users" ).where( "username", "like", "jon%" ).exists();
Copied!
SQL (MySQL)
1
SELECT COUNT(*) AS aggregate FROM `users` WHERE `username` LIKE 'jon%'
Copied!

count

Name
Type
Required
Default
Description
column
string
false
"*"
The column on which to count records.
options
struct
false
{}
Any additional queryExecute options.
Returns an integer number of rows returned by the query.
QueryBuilder
1
query.from( "users" ).count();
Copied!
SQL (MySQL)
SQL Server
1
SELECT COUNT(*) AS aggregate FROM `users`
Copied!
1
SELECT COUNT(*) FROM [users]
Copied!

max

Name
Type
Required
Default
Description
column
string
true
The column on which to find the max.
options
struct
false
{}
Any additional queryExecute options.
Returns the maximum value for the given column.
QueryBuilder
1
query.from( "users" ).max( "age" );
Copied!
SQL (MySQL)
1
SELECT MAX(age) AS aggregate FROM `users`
Copied!

min

Name
Type
Required
Default
Description
column
string
true
The column on which to find the min.
options
struct
false
{}
Any additional queryExecute options.
Returns the minimum value for the given column.
QueryBuilder
1
query.from( "users" ).min( "age" );
Copied!
SQL (MySQL)
1
SELECT MIN(age) AS aggregate FROM `users`
Copied!

sum

Name
Type
Required
Default
Description
column
string
true
The column to sum.
options
struct
false
{}
Any additional queryExecute options.
Returns the sum of all returned rows for the given column.
QueryBuilder
1
query.from( "employees" ).sum( "salary" );
Copied!
SQL (MySQL)
1
SELECT SUM(salary) AS aggregate FROM `employees`
Copied!
Last modified 1yr ago
Copy link