Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Unknown macro: {div}
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'
Unknown macro: {div}
Unknown macro: {table}
{column:width=80px|padding=0px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Property Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} and
Create an AND-condition to add conditions to.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} columns
Get columns from query
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} functions
Get the functions clause from a query, used for functions that are not tied to a column.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} groupBy
Get the group by clause from a query
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} having
Get the having-part of the query, used to add conditions.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} joins
Get the joins clause of this table based clause.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} or
Create an OR-condition to add conditions to.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} params
Get the named parameters from a query.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} parent
Get query builder parent table clause, this may be a query or a join clause.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} result
Get the result part of the query, used to add result columns or values.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} root
Get query builder parent.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sort
Get the sorting part of the query.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} where
Get the where-part of the query, used to add conditions.
Unknown macro: {table}
{column:width=80px|padding=0px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} clearHaving()
Clear the having-part of the query.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} exists()
Get an exists-condition from a subquery
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getColumn(name)
Get a column from the table.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getColumn(columnTableAlias, name)
Get a column from the table with given alias.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getParameter()
Get or create a parameter for the query, this used to parameterize queries.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} not(cond)
Create an negated condition.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} not(cond)
Create an negated condition.
Unknown macro: {table}
{column:width=100%|padding=0px}{column}
Unknown macro: {tr} Unknown macro: {th} Property Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Create an AND-condition to add conditions to.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
query.where.add(
query.or
.add(
query.and
.add(query.columns.flag.eq(1))
.add(query.columns.order_date.isNull)
)
.add(
query.and
.add(query.columns.flag.eq(2))
.add(query.column.order_date.gt(new Date()))
)
);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} columns
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get columns from query
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.getQuery().columns
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} functions
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the functions clause from a query, used for functions that are not tied to a column.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @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('servoy'))) //$NON-NLS-1$
foundset.loadRecords(query)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} groupBy
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the group by clause from a query
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @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)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} having
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the having-part of the query, used to add conditions.
The conditions added here are AND-ed.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @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)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} joins
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the joins clause of this table based clause.
Joins added to this clause will be based on this table clauses table.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.getQuery().joins
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Create an OR-condition to add conditions to.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
query.where.add(
query.or
.add(
query.and
.add(query.columns.flag.eq(1))
.add(query.columns.order_date.isNull)
)
.add(
query.and
.add(query.columns.flag.eq(2))
.add(query.column.order_date.gt(new Date()))
)
);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} params
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the named parameters from a query.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
query.where.add(query.columns.contact_id.eq(query.getParameter('mycontactid')))
// load orders where contact_id = 100
query.params['mycontactid'] = 100
foundset.loadRecords(query)
// load orders where contact_id = 200
query.params['mycontactid'] = 200
foundset.loadRecords(query)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} parent
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get query builder parent table clause, this may be a query or a join clause.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @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)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} result
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the result part of the query, used to add result columns or values.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
query.result.add(query.columns.company_id).add(query.columns.customerid)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get query builder parent.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @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)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the sorting part of the query.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @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)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} where
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get the where-part of the query, used to add conditions.
The conditions added here are AND-ed.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var query = foundset.getQuery()
query.where.add(query.columns.flag.eq(1))
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {table}
{column:width=100%|padding=0px}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} clearHaving
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} clearHaving
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Clear the having-part of the query.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var q = foundset.getQuery()
q.where.add(q.columns.x.eq(100))
query.groupBy.clear.root.clearHaving()
foundset.loadRecords(q);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} exists
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} exists
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get an exists-condition from a subquery
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.query.where.add(query.exists(query2))
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getColumn
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getColumn
Unknown macro: {span} (name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get a column from the table.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} name – the name of column to get
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.getQuery().getColumn('orderid')
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getColumn
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getColumn
Unknown macro: {span} (columnTableAlias, name)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get a column from the table with given alias.
The alias may be of the main table or any level deep joined table.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {String} columnTableAlias – the alias for the table
{String} name – the name of column to get
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.getQuery().getColumn('orderid', 'opk')
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getParameter
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getParameter
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Get or create a parameter for the query, this used to parameterize queries.
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
query.where.add(query.columns.contact_id.eq(query.getParameter('mycontactid')))
// load orders where contact_id = 100
query.params['mycontactid'] = 100
foundset.loadRecords(query)
// load orders where contact_id = 200
query.params['mycontactid'] = 200
foundset.loadRecords(query)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} not
Unknown macro: {span} (cond)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Create an negated condition.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {div} {QBCondition} cond – the condition to negate
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.query.where.add(query.not(query.columns.flag.eq(1)))
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} not
Unknown macro: {span} (cond)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {div} Create an negated condition.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
foundset.query.where.add(query.not(query.columns.flag.eq(1)))
Unknown macro: {tr} Unknown macro: {td}