View Source

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Property Summary

#abs
Create abs(column) expression

#asc
Create an ascending sort expression

#avg
Create an aggregate expression.

#bit_length
Create bit_length(column) expression

#ceil
Create ceil(column) expression

#count
Create an aggregate expression.

#day
Extract day from date

#desc
Create an descending sort expression

#floor
Create floor(column) expression

#hour
Extract hour from date

#isNull
Compare column with null.

#len
Create length(column) expression

#lower
Create lower(column) expression

#max
Create an aggregate expression.

#min
Create an aggregate expression.

#minute
Extract minute from date

#month
Extract month from date

#not
Create a negated condition.

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

#root
Get query builder parent.

#round
Create round(column) expression

#second
Extract second from date

#sqrt
Create sqrt(column) expression

#sum
Create an aggregate expression.

#trim
Create trim(column) expression

#upper
Create upper(column) expression

#year
Extract year from date

Method Summary

#between(value1, value2)
Compare column to a range of 2 values or other columns.

#cast(type)
Create cast(column, type) expression

#concat(arg)
Concatename with value

#divide(arg)
Divide by value

#eq(value)
Compare column with a value or another column.

#ge(value)
Compare column with a value or another column.

#gt(value)
Compare column with a value or another column.

#isin(query)
Compare column with subquery result.

#isin(values)
Compare column with values.

#le(value)
Compare column with a value or another column.

#like(pattern)
Compare column with a value or another column.

#like(pattern, escape)
Compare column with a value or another column.

#locate(arg)
Create locate(arg) expression

#locate(arg, start)
Create locate(arg, start) expression

#lt(value)
Compare column with a value or another column.

#minus(arg)
Subtract value

#mod(arg)
Create mod(arg) expression

#multiply(arg)
Multiply with value

#nullif(arg)
Create nullif(arg) expression

#plus(arg)
Add up value

#substring(pos)
Create substring(pos) expression

#substring(pos, len)
Create substring(pos, len) expression

Property Details

abs

Create abs(column) expression

Returns

Sample

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

asc

Create an ascending sort expression

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
query.sort
.add(query.joins.orders_to_order_details.columns.quantity.asc)
.add(query.columns.companyid)
foundset.loadRecords(query)

avg

Create an aggregate expression.

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
	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

Returns

Sample

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

ceil

Create ceil(column) expression

Returns

Sample

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

count

Create an aggregate expression.

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
	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

Returns

Sample

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

desc

Create an descending sort expression

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
query.sort
.add(query.joins.orders_to_order_details.columns.quantity.desc)
.add(query.columns.companyid)
foundset.loadRecords(query)

floor

Create floor(column) expression

Returns

Sample

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

hour

Extract hour from date

Returns

Sample

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

isNull

Compare column with null.

Returns

Sample

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

len

Create length(column) expression

Returns

Sample

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

lower

Create lower(column) expression

Returns

Sample

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

max

Create an aggregate expression.

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
	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 expression.

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
	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

Returns

Sample

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

month

Extract month from date

Returns

Sample

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

not

Create a negated condition.

Returns

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.

Returns

Sample

/** @type {QBSelect<db:/example_data/person>} */
	var query = databaseManager.createSelect('db:/example_data/person')
	query.where.add(query.joins.person_to_parent.joins.person_to_parent.columns.name.eq('john'))
	foundset.loadRecords(query)

root

Get query builder parent.

Returns

Sample

/** @type {QBSelect<db:/example_data/order_details>} */
	var subquery = databaseManager.createSelect('db:/example_data/order_details')
	
 /** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
	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

Returns

Sample

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

second

Extract second from date

Returns

Sample

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

sqrt

Create sqrt(column) expression

Returns

Sample

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

sum

Create an aggregate expression.

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
	var query = databaseManager.createSelect('db:/example_data/orders')
	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

Returns

Sample

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

upper

Create upper(column) expression

Returns

Sample

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

year

Extract year from date

Returns

Sample

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

Method Details

between

between

(value1, value2)

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

Parameters

{Object} value1
{Object} value2

Returns

Sample

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

cast

cast

(type)

Create cast(column, type) expression

Parameters

{String} type – string type, see QUERY_COLUMN_TYPES

Returns

Sample

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

concat

concat

(arg)

Concatename with value

Parameters

{Object} arg – valeu to concatenate with

Returns

Sample

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

divide

divide

(arg)

Divide by value

Parameters

{Object} arg – nr to divide by

Returns

Sample

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

eq

eq

(value)

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

Parameters

{Object} value

Returns

Sample

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

ge

ge

(value)

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

Parameters

{Object} value

Returns

Sample

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

gt

gt

(value)

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

Parameters

{Object} value

Returns

Sample

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

isin

isin

(query)

Compare column with subquery result.

Parameters

{QBPart} query – subquery

Returns

Sample

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

isin

isin

(values)

Compare column with values.

Parameters

{Object[]} values – array of values

Returns

Sample

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

le

le

(value)

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

Parameters

{Object} value

Returns

Sample

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

like

like

(pattern)

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

Parameters

{String} pattern – the string value of the pattern

Returns

Sample

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

like

like

(pattern, escape)

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

Parameters

{String} pattern – the string value of the pattern
{String} escape – the escape char

Returns

Sample

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

locate

locate

(arg)

Create locate(arg) expression

Parameters

{Object} arg – string to locate

Returns

Sample

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

locate

locate

(arg, start)

Create locate(arg, start) expression

Parameters

{Object} arg – string to locate
{Number} start – start pos

Returns

Sample

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

lt

lt

(value)

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

Parameters

{Object} value

Returns

Sample

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

minus

minus

(arg)

Subtract value

Parameters

{Object} arg – nr to subtract

Returns

Sample

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

mod

mod

(arg)

Create mod(arg) expression

Parameters

{Object} arg – mod arg

Returns

Sample

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

multiply

multiply

(arg)

Multiply with value

Parameters

{Object} arg – nr to multiply with

Returns

Sample

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

nullif

nullif

(arg)

Create nullif(arg) expression

Parameters

{Object} arg – object to compare

Returns

Sample

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

plus

plus

(arg)

Add up value

Parameters

{Object} arg – nr to add

Returns

Sample

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

substring

substring

(pos)

Create substring(pos) expression

Parameters

{Number} pos

Returns

Sample

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

substring

substring

(pos, len)

Create substring(pos, len) expression

Parameters

{Number} pos
{Number} len

Returns

Sample

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