QBAggregate

Overview

The QBAggregate class represents aggregate expressions, such as count, min, and max, within a QBSelect query. It provides a range of methods and properties for constructing and manipulating aggregate expressions, allowing for customization of query results and conditions.

Aggregates can be used to calculate summaries, apply mathematical functions, or manipulate data within a query. Properties like count, sum, and avg allow direct creation of aggregate expressions, while others like abs or round perform mathematical operations. Sorting and conditional operations can also be applied using properties such as asc, desc, and isNull.

Methods extend the functionality of aggregates by enabling operations like comparison (eq, between, like), mathematical manipulation (plus, minus, mod), and substring extraction (substring). These features provide fine-grained control over how aggregate data is computed and retrieved.

The QBAggregate class integrates with query builder constructs like QBColumn, QBCondition, and QBSort, enabling complex query logic and data transformations.

Properties Summarized

Type	Name	Summary
QBColumn	abs	Create abs(column) expression
QBSort	asc	Create an ascending sort expression
QBColumn	avg	Create an aggregate average expression.
QBColumn	bit_length	Create bit_length(column) expression
QBColumn	ceil	Create ceil(column) expression
QBColumn	count	Create an aggregate count expression.
QBColumn	day	Extract day from date
QBSort	desc	Create an descending sort expression
QBColumn	distinct	Add a distinct qualifier to the aggregate
QBColumn	floor	Create floor(column) expression
QBColumn	hour	Extract hour from date
QBCondition	isNull	Compare column with null.
QBColumn	len	Create length(column) expression
QBColumn	lower	Create lower(column) expression
QBColumn	max	Create an aggregate max expression.
QBColumn	min	Create an aggregate min expression.
QBColumn	minute	Extract minute from date
QBColumn	month	Extract month from date
QBColumn	not	Create a negated condition.
QBTableClause	parent	Get query builder parent table clause, this may be a query or a join clause.
QBSelect	root	Get query builder parent.
QBColumn	round	Create round(column) expression
QBColumn	second	Extract second from date
QBColumn	sqrt	Create sqrt(column) expression
QBColumn	sum	Create an aggregate sum expression.
QBColumn	trim	Create trim(column) expression
QBColumn	upper	Create upper(column) expression
QBColumn	year	Extract year from date

Methods Summarized

Type	Name	Summary
QBCondition	between(value1, value2)	Compare column to a range of 2 values or other columns.
QBColumn	cast(type)	Create cast(column, type) expression
QBColumn	concat(arg)	Concatename with value
QBColumn	divide(arg)	Divide by value
QBCondition	eq(value)	Compare column with a value or another column.
QBCondition	ge(value)	Compare column with a value or another column.
Number	getFlags()	The flags are a bit pattern consisting of 1 or more of the following bits: - JSColumn.
String	getTypeAsString()	Column type as a string
QBCondition	gt(value)	Compare column with a value or another column.
QBCondition	isin(query)	Compare column with subquery result.
QBCondition	isin(values)	Compare column with values.
QBCondition	isin(customQuery, args)	Compare column with custom query result.
QBCondition	le(value)	Compare column with a value or another column.
QBCondition	like(pattern)	Compare column with a value or another column.
QBCondition	like(pattern, escape)	Compare column with a value or another column.
QBColumn	locate(arg)	Create locate(arg) expression
QBColumn	locate(arg, start)	Create locate(arg, start) expression
QBCondition	lt(value)	Compare column with a value or another column.
QBColumn	minus(arg)	Subtract value
QBColumn	mod(arg)	Create mod(arg) expression
QBColumn	multiply(arg)	Multiply with value
QBColumn	nullif(arg)	Create nullif(arg) expression
QBColumn	plus(arg)	Add up value
QBColumn	substring(pos)	Create substring(pos) expression
QBColumn	substring(pos, len)	Create substring(pos, len) expression

Properties Detailed

abs

Create abs(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.abs)

asc

Create an ascending sort expression

Type QBSort

Sample

var query = datasources.db.example_data.orders.createSelect();
query.sort
.add(query.joins.orders_to_order_details.columns.quantity.asc)
.add(query.columns.companyid)
foundset.loadRecords(query)

avg

Create an aggregate average expression.

Type QBColumn

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.avg.eq(1))
	foundset.loadRecords(query)

bit_length

Create bit_length(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.bit_length)

ceil

Create ceil(column) expression

Type QBColumn

Sample

query.result.add(query.columns.mycol.ceil)

count

Create an aggregate count expression.

Type QBColumn

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.count.eq(0))
	foundset.loadRecords(query)

day

Extract day from date

Type QBColumn

Sample

query.result.add(query.columns.mydatecol.day)

desc

Create an descending sort expression

Type QBSort

Sample

var query = datasources.db.example_data.orders.createSelect();
query.sort
.add(query.joins.orders_to_order_details.columns.quantity.desc)
.add(query.columns.companyid)
foundset.loadRecords(query)

distinct

Add a distinct qualifier to the aggregate

Type QBColumn

Sample

// count the number of countries that we ship orders to
var query = datasources.db.example_data.orders.createSelect();
query.result.add(query.columns.shipcountry.count.distinct);

floor

Create floor(column) expression

Type QBColumn

Sample

query.result.add(query.columns.mycol.floor)

hour

Extract hour from date

Type QBColumn

Sample

query.result.add(query.columns.mydatecol.hour)

isNull

Compare column with null.

Type QBCondition

Sample

query.where.add(query.columns.flag.isNull)

len

Create length(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.len)

lower

Create lower(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.lower)

max

Create an aggregate max expression.

Type QBColumn

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.count.max(10))
	foundset.loadRecords(query)

min

Create an aggregate min expression.

Type QBColumn

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.count.min(10))
	foundset.loadRecords(query)

minute

Extract minute from date

Type QBColumn

Sample

query.result.add(query.columns.mydatecol.minute)

month

Extract month from date

Type QBColumn

Sample

query.result.add(query.columns.mydatecol.month)

not

Create a negated condition.

Type QBColumn

Sample

query.where.add(query.columns.flag.not.eq(1))

parent

Get query builder parent table clause, this may be a query or a join clause.

Type QBTableClause

Sample

var query = datasources.db.example_data.person.createSelect();
	query.where.add(query.joins.person_to_parent.joins.person_to_parent.columns.name.eq('john'))
	foundset.loadRecords(query)

root

Get query builder parent.

Type QBSelect

Sample

var subquery = datasources.db.example_data.order_details.createSelect();

	var query = datasources.db.example_data.orders.createSelect();
	query.where.add(query
		.or
			.add(query.columns.order_id.not.isin([1, 2, 3]))

			.add(query.exists(
					subquery.where.add(subquery.columns.orderid.eq(query.columns.order_id)).root
			))
		)

	foundset.loadRecords(query)

round

Create round(column) expression

Type QBColumn

Sample

query.result.add(query.columns.mycol.round)

second

Extract second from date

Type QBColumn

Sample

query.result.add(query.columns.mydatecol.second)

sqrt

Create sqrt(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.sqrt)

sum

Create an aggregate sum expression.

Type QBColumn

Sample

var query = datasources.db.example_data.orders.createSelect();
	query.groupBy.addPk() // have to group by on pk when using having-conditions in (foundset) pk queries
	.root.having.add(query.joins.orders_to_order_details.columns.quantity.count.sum(10))
	foundset.loadRecords(query)

trim

Create trim(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.trim)

upper

Create upper(column) expression

Type QBColumn

Sample

query.result.add(query.columns.custname.upper)

year

Extract year from date

Type QBColumn

Sample

query.result.add(query.columns.mydatecol.year)

Methods Detailed

between(value1, value2)

Compare column to a range of 2 values or other columns.

Parameters

• Object value1 ;

• Object value2 ;

Returns: QBCondition

Sample

query.where.add(query.columns.flag.between(0, 5))

cast(type)

Create cast(column, type) expression

Parameters

• String type string type, see QUERY_COLUMN_TYPES

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.cast(QUERY_COLUMN_TYPES.TYPE_INTEGER))

concat(arg)

Concatename with value

Parameters

• Object arg valeu to concatenate with

Returns: QBColumn

Sample

query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname))

divide(arg)

Divide by value

Parameters

• Object arg nr to divide by

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.divide(2))

eq(value)

Compare column with a value or another column. Operator: equals

Parameters

• Object value ;

Returns: QBCondition

Sample

query.where.add(query.columns.flag.eq(1))

ge(value)

Compare column with a value or another column. Operator: greaterThanOrEqual

Parameters

• Object value ;

Returns: QBCondition

Sample

query.where.add(query.columns.flag.ge(2))

getFlags()

The flags are a bit pattern consisting of 1 or more of the following bits: - JSColumn.UUID_COLUMN - JSColumn.EXCLUDED_COLUMN - JSColumn.TENANT_COLUMN

Returns: Number

getTypeAsString()

Column type as a string

Returns: String

gt(value)

Compare column with a value or another column. Operator: greaterThan

Parameters

• Object value ;

Returns: QBCondition

Sample

query.where.add(query.columns.flag.gt(0))

isin(query)

Compare column with subquery result.

Parameters

• QBPart query subquery

Returns: QBCondition

Sample

query.where.add(query.columns.flag.isin(query2))

isin(values)

Compare column with values.

Parameters

• Array values array of values

Returns: QBCondition

Sample

query.where.add(query.columns.flag.isin([1, 5, 99]))

isin(customQuery, args)

Compare column with custom query result.

Parameters

• String customQuery custom query

• Array args query arguments

Returns: QBCondition

Sample

query.where.add(query.columns.ccy.isin("select ccycode from currencies c where c.category = " + query.getTableAlias() + ".currency_category and c.flag = ?", ['T']))

le(value)

Compare column with a value or another column. Operator: lessThanOrEqual

Parameters

• Object value ;

Returns: QBCondition

Sample

query.where.add(query.columns.flag.le(2))

like(pattern)

Compare column with a value or another column. Operator: like

Parameters

• Object pattern the string value of the pattern

Returns: QBCondition

Sample

query.where.add(query.columns.companyname.like('Serv%'))

// case-insensitive compares can be done using the upper (or lower) functions,
// this can be useful when using for example German letters like ß,
query.where.add(query.columns.companyname.upper.like(query.functions.upper('groß%')))

like(pattern, escape)

Compare column with a value or another column. Operator: like, with escape character

Parameters

• Object pattern the string value of the pattern

• Number escape the escape char

Returns: QBCondition

Sample

query.where.add(query.columns.companyname.like('X_%', '_'))

locate(arg)

Create locate(arg) expression

Parameters

• Object arg string to locate

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.locate('sample'))

locate(arg, start)

Create locate(arg, start) expression

Parameters

• Object arg string to locate

• Number start start pos

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.locate('sample', 5))

lt(value)

Compare column with a value or another column. Operator: lessThan

Parameters

• Object value ;

Returns: QBCondition

Sample

query.where.add(query.columns.flag.lt(99))

minus(arg)

Subtract value

Parameters

• Object arg nr to subtract

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.minus(2))

mod(arg)

Create mod(arg) expression

Parameters

• Object arg mod arg

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.mod(2))

multiply(arg)

Multiply with value

Parameters

• Object arg nr to multiply with

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.multiply(2))

nullif(arg)

Create nullif(arg) expression

Parameters

• Object arg object to compare

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.nullif('none'))

plus(arg)

Add up value

Parameters

• Object arg nr to add

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.plus(2))

substring(pos)

Create substring(pos) expression

Parameters

• Number pos ;

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.substring(3))

substring(pos, len)

Create substring(pos, len) expression

Parameters

• Number pos ;

• Number len ;

Returns: QBColumn

Sample

query.result.add(query.columns.mycol.substring(3, 2))

---