Page History

Divcache

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)distinct

styleindex	display:none

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.

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

idclass

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryGet/set the distinct flag for the query. Table Row (tr)

Table Cell (td)
QBSelect

Table Cell (td)parent

Table Row (tr)

Table Cell (td)
QBSelect

Table Cell (td)root

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

Get query builder parent.

HTML Table

Colgroup Tag

Col

width	80px

Col

Table Head (thead) Table Row (tr)style

servoy sSummary

Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)add(aggregate)

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Method Summary

3

Methods Summary

Add an aggregate to the query result.

Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)add(aggregate, alias)
Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)add(column)

Add an aggregate with alias to the query result.

Add a column to the query result.

Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)add(column, alias)
Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)add(func)

Add a column with alias to the query result.

Add a function result to the query result.

Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)add(func, alias)

Add a function with alias result to the query result.

Add a case searched expression to the query result.

Add a case searched expression with alias to the query result.

Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)addPk()
Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)addValue(value)

Add the tables' primary pk columns in alphabetical order to the query result.

Add a query to the query result.

Add a query with alias to the query result.

Add a custom subquery to the query result.

Add a custom subquery with alias to the query result.

Add a value to the query result.

Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)addValue(value, alias)
Table Row (tr)

Table Cell (td)
QBResult

Table Cell (td)clear()

Add a value with an alias to the query result.

Clear the columns in the query result.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	distinct

Table Row (tr)

id	name

Table Cell (td)
distinct

Table Row (tr)

id	des

Table Cell (td) Divclass

returns an array with all the columns that will be in the select of this query.

idpropertyservoy sDetail2100%height:30px2Property Detailsdistinctname

distinct

des

sIndent

Get/set the distinct flag for the query.

Table Row (tr)td

ret

Returns

div

sIndent

clients

classid

Supported Clients

sIndent

Boolean Table Row (tr)

SmartClient,WebClient,NGClient

sam

Table Cell (td)

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	add-QBAggregate

Table Row (tr)

id	name

Table Cell (td)
add

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

add

Span
(aggregate)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add an aggregate to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{QBAggregate} aggregate - the aggregate to add to result

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.add(query.columns.label_text.max)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	add-QBAggregate_String

Table Row (tr)

id	name

Table Cell (td)
add

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

add

Span
(aggregate, alias)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add an aggregate with alias to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{QBAggregate} aggregate - the aggregate to add to result
{String} alias - aggregate alias

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.add(query.columns.item_count.max, 'maximum_items')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	add-QBColumn

Table Row (tr)

id	name

Table Cell (td)
add

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

add

Span
(column)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a column to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{QBColumn} column - column to add to result

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	add-QBColumn_String

Table Row (tr)

id	name

Table Cell (td)
add

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

add

Span
(column, alias)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a column with alias to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{QBColumn} column - column to add to result
{String} alias - column alias

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.add(query.columns.custname, 'customer_name')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	add-QBFunction

Table Row (tr)

id	name

Table Cell (td)
add

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

add

Span
(func)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a function result to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{QBFunction} func - the function to add to the result

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	add-QBFunction_String

Table Row (tr)

id	name

Table Cell (td)
add

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

add

Span
(func, alias)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a function with alias result to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{QBFunction} func - the function to add to the result
{String} alias - function alias

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.add(query.columns.custname.upper(), 'customer_name')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addPk

Table Row (tr)

id	name

Table Cell (td)
addPk

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

addPk

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add the tables' primary pk columns in alphabetical order to the query result.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.addPk()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addValue-Object

Table Row (tr)

id	name

Table Cell (td)
addValue

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

addValue

Span
(value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a value to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} value - value add to result

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.addValue(100)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addValue-Object_String

Table Row (tr)

id	name

Table Cell (td)
addValue

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

addValue

Span
(value, alias)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a value with an alias to the query result.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} value - value add to result
{String} alias - value alias

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.addValue(100, 'myvalue')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	clear

Table Row (tr)

id	name

Table Cell (td)
clear

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

QBResult

Span

style	font-weight: bold;

clear

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clear the columns in the query result.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBResult

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.clear()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

query.result.distinct = true

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	parent

Table Row (tr)

id	name

Table Cell (td)
parent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBSelect

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

/** @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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	root

Table Row (tr)

id	name

Table Cell (td)
root

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get query builder parent.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

QBSelect

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

/** @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)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

sIdent

javascript

lastDetailRow

parent

name

parent

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

root

name

root

des

sIndent

Get query builder parent.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods Detailsaddname

add(aggregate)

des

sIndent

Add an aggregate to the query result.

prs

Parameters

sIndent

aggregate

the aggregate to add to result

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(aggregate, alias)

des

sIndent

Add an aggregate with alias to the query result.

prs

Parameters

sIndent

aggregate

the aggregate to add to result

alias

aggregate alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(column)

des

sIndent

Add a column to the query result.

prs

Parameters

sIndent

column

column to add to result

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(column, alias)

des

sIndent

Add a column with alias to the query result.

prs

Parameters

sIndent

column

column to add to result

alias

column alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(func)

des

sIndent

Add a function result to the query result.

prs

Parameters

sIndent

func

the function to add to the result

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(func, alias)

des

sIndent

Add a function with alias result to the query result.

prs

Parameters

sIndent

func

the function to add to the result

alias

function alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(qcase)

des

sIndent

Add a case searched expression to the query result.

prs

Parameters

sIndent

qcase

The searched case expression.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

add

name

add(qcase, alias)

des

sIndent

Add a case searched expression with alias to the query result.

prs

Parameters

sIndent

qcase

The searched case expression.

alias

function alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addPk

name

addPk()

des

sIndent

Add the tables' primary pk columns in alphabetical order to the query result.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addSubSelect

name

addSubSelect(query)

des

sIndent

Add a query to the query result.

prs

Parameters

sIndent

query

query to add to result

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addSubSelect

name

addSubSelect(query, alias)

des

sIndent

Add a query with alias to the query result.

prs

Parameters

sIndent

query

query to add to result

alias

result alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addSubSelect

name

addSubSelect(customQuery, args)

des

sIndent

Add a custom subquery to the query result.

prs

Parameters

sIndent

customQuery

query to add to result

args

arguments to the query

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addSubSelect

name

addSubSelect(customQuery, args, alias)

des

sIndent

Add a custom subquery with alias to the query result.

prs

Parameters

sIndent

customQuery

query to add to result

args

arguments to the query

alias

result alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addValue

name

addValue(value)

des

sIndent

Add a value to the query result.

prs

Parameters

sIndent

value

value add to result

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addValue

name

addValue(value, alias)

des

sIndent

Add a value with an alias to the query result.

prs

Parameters

sIndent

value

value add to result

alias

value alias

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

clear

name

clear()

des

sIndent

Clear the columns in the query result.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getColumns

name

getColumns()

des

sIndent

returns an array with all the columns that will be in the select of this query.
can return empty array. Then the system will auto append the pk when this query is used.

ret

Returns

sIndent

An array of QBColumn thats in the select of this query.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 13

New Version Current

Key

distinct

distinct

add

add

add

add

add

add

addPk

addValue

addValue

clear

parent

root

parent

root

add(aggregate)

add(aggregate, alias)

add(column)

add(column, alias)

add(func)

add(func, alias)

add(qcase)

add(qcase, alias)

addPk()

addSubSelect(query)

addSubSelect(query, alias)

addSubSelect(customQuery, args)

addSubSelect(customQuery, args, alias)

addValue(value)

addValue(value, alias)

clear()

getColumns()