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

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

root
Get query builder parent.

Method Summary

abs(value)
Create abs(column) expression

bit_length(value)
Create bit_length(column) expression

cast(value, type)
Cast using type name.

ceil(arg)
Create ceil(column) expression

coalesce(args)
Create year(date) expression

concat(arg1, arg2)
Create concat(args, arg2) expression

day(arg)
Create day(date) expression

divide(arg1, arg2)
Create divide(args, arg2) expression

floor(arg)
Create floor(column) expression

hour(arg)
Create hour(date) expression

len(value)
Create length(column) expression

locate(string1, string2)
Create locate(str1, str2) expression

locate(string1, string2, start)
Create locate(str1, str2, start) expression

lower(value)
Create lower(column) expression

minus(arg1, arg2)
Create minus(args, arg2) expression

minute(arg)
Create minute(date) expression

mod(dividend, divisor)
Create mod(dividend, divisor) expression

month(arg)
Create month(date) expression

multiply(arg1, arg2)
Create multiply(args, arg2) expression

nullif(arg1)
Create nullif(arg1, arg2) expression

plus(arg1, arg2)
Create plus(args, arg2) expression

round(arg)
Create round(column) expression

second(arg)
Create second(date) expression

sqrt(value)
Create sqrt(column) expression

substring(arg, pos)
Create substring(column, pos) expression

substring(arg, pos, len)
Create substring(column, pos, len) expression

trim(value)
Create trim(column) expression

upper(value)
Create upper(column) expression

year(arg)
Create year(date) expression

Property Details

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)

Method Details

abs

abs

(value)

Create abs(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynum.abs.eq(query.functions.abs(myval)))
foundset.loadRecords(query);

bit_length

bit_length

(value)

Create bit_length(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.bit_length.eq(query.functions.bit_length('Sample')))
foundset.loadRecords(query);

cast

cast

(value, type)

Cast using type name.

Parameters

{Object} value - object to cast
{String} type - type see QUERY_COLUMN_TYPES

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.result.add(query.functions.cast("22",QUERY_COLUMN_TYPES.TYPE_INTEGER)).add(query.columns.amt_discount.cast(QUERY_COLUMN_TYPES.TYPE_STRING));
application.output(databaseManager.getDataSetByQuery(query,1).getAsHTML())

ceil

ceil

(arg)

Create ceil(column) expression

Parameters

{Object} arg - number object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.ceil.eq(query.functions.ceil(myvar))
foundset.loadRecords(query);

coalesce

coalesce

(args)

Create year(date) expression

Parameters

{Object...} args - arguments to coalesce

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mycol.coalesce('defval').eq(query.functions.coalesce(myvar, 'defval'))
foundset.loadRecords(query);

concat

concat

(arg1, arg2)

Create concat(args, arg2) expression

Parameters

{Object} arg1
{Object} arg2

Returns

Sample

/** @type {QBSelect<db:/udm/contacts>} */
	var query = databaseManager.createSelect('db:/udm/contacts') //$NON-NLS-1$
	query.result.add(query.columns.name_first.concat(' ').concat(query.columns.name_last))
	var ds = databaseManager.getDataSetByQuery(query, -1)

day

day

(arg)

Create day(date) expression

Parameters

{Object} arg - date object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mydatecol.day.eq(query.functions.day(mydatevar))
foundset.loadRecords(query);

divide

divide

(arg1, arg2)

Create divide(args, arg2) expression

Parameters

{Object} arg1
{Object} arg2

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.divide(2).eq(query.functions.divide(myvar, 2))
foundset.loadRecords(query);

floor

floor

(arg)

Create floor(column) expression

Parameters

{Object} arg - number object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.floor.eq(query.functions.floor(myvar))
foundset.loadRecords(query);

hour

hour

(arg)

Create hour(date) expression

Parameters

{Object} arg - date object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mydatecol.hour.eq(query.functions.hour(mydatevar))
foundset.loadRecords(query);

len

len

(value)

Create length(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.len.eq(query.functions.len('Sample')))
foundset.loadRecords(query);

locate

locate

(string1, string2)

Create locate(str1, str2) expression

Parameters

{Object} string1 - string to locate
{Object} string2 - string to search in

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.locate('amp').eq(query.functions.locate('Sample', 'amp')))
foundset.loadRecords(query);

locate

locate

(string1, string2, start)

Create locate(str1, str2, start) expression

Parameters

{Object} string1 - string to locate
{Object} string2 - string to search in
{Number} start - start pos

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.locate('amp', 1).eq(query.functions.locate('Sample', 'amp', 1)))
foundset.loadRecords(query);

lower

lower

(value)

Create lower(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.lower.eq(query.functions.lower('Sample')))
foundset.loadRecords(query);

minus

minus

(arg1, arg2)

Create minus(args, arg2) expression

Parameters

{Object} arg1
{Object} arg2

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.minus(2).eq(query.functions.minus(myvar, 2))
foundset.loadRecords(query);

minute

minute

(arg)

Create minute(date) expression

Parameters

{Object} arg - date object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mydatecol.minute.eq(query.functions.minute(mydatevar))
foundset.loadRecords(query);

mod

mod

(dividend, divisor)

Create mod(dividend, divisor) expression

Parameters

{Object} dividend
{Object} divisor

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.mod(2).eq(query.functions.mod(myvar, 2))
foundset.loadRecords(query);

month

month

(arg)

Create month(date) expression

Parameters

{Object} arg - date object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mydatecol.month.eq(query.functions.month(mydatevar))
foundset.loadRecords(query);

multiply

multiply

(arg1, arg2)

Create multiply(args, arg2) expression

Parameters

{Object} arg1
{Object} arg2

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.multiply(2).eq(query.functions.multiply(myvar, 2))
foundset.loadRecords(query);

nullif

nullif

(arg1)

Create nullif(arg1, arg2) expression

Parameters

{Object} arg1

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.nullif('none').eq(query.functions.nullif('Sample', 'none')))
foundset.loadRecords(query);

plus

plus

(arg1, arg2)

Create plus(args, arg2) expression

Parameters

{Object} arg1
{Object} arg2

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.plus(2).eq(query.functions.plus(myvar, 2))
foundset.loadRecords(query);

round

round

(arg)

Create round(column) expression

Parameters

{Object} arg - number object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynumcol.round.eq(query.functions.round(myvar))
foundset.loadRecords(query);

second

second

(arg)

Create second(date) expression

Parameters

{Object} arg - date object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mydatecol.second.eq(query.functions.second(mydatevar))
foundset.loadRecords(query);

sqrt

sqrt

(value)

Create sqrt(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mynum.sqrt.eq(query.functions.sqrt(myval)))
foundset.loadRecords(query);

substring

substring

(arg, pos)

Create substring(column, pos) expression

Parameters

{Object} arg - column name
{Number} pos - position

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.substring(3).eq(query.functions.substring('Sample', 3)))
foundset.loadRecords(query);

substring

substring

(arg, pos, len)

Create substring(column, pos, len) expression

Parameters

{Object} arg - column name
{Number} pos - position
{Number} len - length

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.substring(3, 2).eq(query.functions.substring('Sample', 3, 2)))
foundset.loadRecords(query);

trim

trim

(value)

Create trim(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.trim.eq(query.functions.trim('Sample')))
foundset.loadRecords(query);

upper

upper

(value)

Create upper(column) expression

Parameters

{Object} value

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.shipname.upper.eq(query.functions.upper('Sample')))
foundset.loadRecords(query);

year

year

(arg)

Create year(date) expression

Parameters

{Object} arg - date object

Returns

Sample

/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders') //$NON-NLS-1$
query.where.add(query.columns.mydatecol.year.eq(query.functions.year(mydatevar))
foundset.loadRecords(query);