Child pages
  • QBResult

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
distinct
Get/set the distinct flag for the query.
Table Row (tr)
Table Cell (td)
QBSelect
Table Cell (td)
parent
Get query builder parent table clause, this may be a query or a join clause.
Table Row (tr)
Table Cell (td)
QBSelect
Table Cell (td)
root
Get query builder parent.



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
add(aggregate)
Add an aggregate to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
add(aggregate, alias)
Add an aggregate with alias to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
add(column)
Add a column to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
add(column, alias)
Add a column with alias to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
add(func)
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.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
addPk()
Add the tables' primary pk columns in alphabetical order to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
addValue(value)
Add a value to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
addValue(value, alias)
Add a value with an alias to the query result.
Table Row (tr)
Table Cell (td)
QBResult
Table Cell (td)
clear()
Clear the columns in the query result.



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
iddistinct
Table Row (tr)
idname
Table Cell (td)

distinct

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get/set the distinct flag for the query.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.distinct = true
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idparent
Table Row (tr)
idname
Table Cell (td)

parent

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get query builder parent table clause, this may be a query or a join clause.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBSelect
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
/** @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)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idroot
Table Row (tr)
idname
Table Cell (td)

root

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get query builder parent.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBSelect
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
/** @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)
classlastDetailRow
Table Cell (td)
 



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idadd-QBAggregate
Table Row (tr)
idname
Table Cell (td)

add

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
add
Span
(aggregate)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add an aggregate to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBAggregate} aggregate - the aggregate to add to result
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.add(query.columns.label_text.max)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idadd-QBAggregate_String
Table Row (tr)
idname
Table Cell (td)

add

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
add
Span
(aggregate, alias)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add an aggregate with alias to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBAggregate} aggregate - the aggregate to add to result
{String} alias - aggregate alias
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.add(query.columns.item_count.max, 'maximum_items')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idadd-QBColumn
Table Row (tr)
idname
Table Cell (td)

add

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
add
Span
(column)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a column to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBColumn} column - column to add to result
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.add(query.columns.custname)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idadd-QBColumn_String
Table Row (tr)
idname
Table Cell (td)

add

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
add
Span
(column, alias)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a column with alias to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBColumn} column - column to add to result
{String} alias - column alias
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.add(query.columns.custname, 'customer_name')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idadd-QBFunction
Table Row (tr)
idname
Table Cell (td)

add

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
add
Span
(func)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a function result to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBFunction} func - the function to add to the result
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.add(query.columns.custname.upper())
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idadd-QBFunction_String
Table Row (tr)
idname
Table Cell (td)

add

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
add
Span
(func, alias)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a function with alias result to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBFunction} func - the function to add to the result
{String} alias - function alias
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.add(query.columns.custname.upper(), 'customer_name')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddPk
Table Row (tr)
idname
Table Cell (td)

addPk

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
addPk
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add the tables' primary pk columns in alphabetical order to the query result.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.addPk()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddValue-Object
Table Row (tr)
idname
Table Cell (td)

addValue

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
addValue
Span
(value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a value to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} value - value add to result
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.addValue(100)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idaddValue-Object_String
Table Row (tr)
idname
Table Cell (td)

addValue

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
addValue
Span
(value, alias)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Add a value with an alias to the query result.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} value - value add to result
{String} alias - value alias
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.addValue(100, 'myvalue')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idclear
Table Row (tr)
idname
Table Cell (td)

clear

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
QBResult
Span
stylefont-weight: bold;
clear
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Clear the columns in the query result.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
QBResult
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
query.result.clear()
Table Row (tr)
classlastDetailRow
Table Cell (td)