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}
For more information see [Relations]
Unknown macro: {table}
{column:width=80px|padding=0px}{column}{column}{column}
Unknown macro: {tr}
Unknown macro: {th}
Constants Summary
Unknown macro: {tbody}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
INNER_JOIN
Constant for the joinType of a JSRelation.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
LEFT_OUTER_JOIN
Constant for the joinType of a JSRelation.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
RIGHT_OUTER_JOIN
Constant for the joinType of a Query Builder join.
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}
Unknown macro: {td}
allowCreationRelatedRecords
Flag that tells if related records can be created through this relation.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
allowParentDeleteWhenHavingRelatedRecords
Flag that tells if the parent record can be deleted while it has related records.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
deleteRelatedRecords
Flag that tells if related records should be deleted or not when a parent record is deleted.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
foreignDataSource
Qualified name of the foreign data source.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
initialSort
A String which specified a set of sort options for the initial sorting of data
retrieved through this relation.
Unknown macro: {tbody}
Unknown macro: {tbody}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
primaryDataSource
Qualified name of the primary data source.
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}
Unknown macro: {td}
getRelationItems()
Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.
Unknown macro: {tbody}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {td}
newRelationItem(dataprovider, operator, foreinColumnName)
Creates a new relation item for this relation.
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
void
Unknown macro: {td}
removeRelationItem(primaryDataProviderID, operator, foreignColumnName)
Removes the desired relation item from the specified relation.
Unknown macro: {table}
{column:width=100%|padding=0px}{column}
Unknown macro: {tr}
Unknown macro: {th}
Constants Details
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Constant for the joinType of a Query Builder join.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
/** @type {QBJoin<db:/example_data/order_details>} */
var join = query.joins.add('db:/example_data/order_details', JSRelation.RIGHT_OUTER_JOIN, 'odetail')
join.on.add(join.columns.orderid.eq(query.columns.orderid))
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Constant for the joinType of a JSRelation. It is also used in solutionModel.newRelation(...) and in the QueryBuilder.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
/** @type {QBJoin<db:/example_data/order_details>} */
var join = query.joins.add('db:/example_data/order_details', JSRelation.INNER_JOIN, 'odetail')
join.on.add(join.columns.orderid.eq(query.columns.orderid))
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Constant for the joinType of a JSRelation. It is also used in solutionModel.newRelation(...) and in the QueryBuilder.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
/** @type {QBJoin<db:/example_data/order_details>} */
var join = query.joins.add('db:/example_data/order_details', JSRelation.INNER_JOIN, 'odetail')
join.on.add(join.columns.orderid.eq(query.columns.orderid))
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Constant for the joinType of a Query Builder join.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
/** @type {QBJoin<db:/example_data/order_details>} */
var join = query.joins.add('db:/example_data/order_details', JSRelation.RIGHT_OUTER_JOIN, 'odetail')
join.on.add(join.columns.orderid.eq(query.columns.orderid))
Unknown macro: {tr}
Unknown macro: {td}
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}
Flag that tells if related records can be created through this relation.
The default value of this flag is "false".
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.allowCreationRelatedRecords = true;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Flag that tells if the parent record can be deleted while it has related records.
The default value of this flag is "true".
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.allowParentDeleteWhenHavingRelatedRecords = false;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Flag that tells if related records should be deleted or not when a parent record is deleted.
The default value of this flag is "false".
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.deleteRelatedRecords = true;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Qualified name of the foreign data source. Contains both the name of the foreign
server and the name of the foreign table.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.primaryDataSource = 'db:/user_data/another_parent_table';
relation.foreignDataSource = 'db:/user_data/another_child_table';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
A String which specified a set of sort options for the initial sorting of data
retrieved through this relation.
Has the form "column_name asc, another_column_name desc, ...".
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.initialSort = 'another_child_table_text asc';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
The join type that is performed between the primary table and the foreign table.
Can be "inner join" or "left outer join".
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.joinType = JSRelation.LEFT_OUTER_JOIN;
/** @type {QBSelect<db:/example_data/orders>} */
var query = databaseManager.createSelect('db:/example_data/orders')
/** @type {QBJoin<db:/example_data/order_details>} */
var join = query.joins.add('db:/example_data/order_details', JSRelation.INNER_JOIN, 'odetail')
join.on.add(join.columns.orderid.eq(query.columns.orderid))
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
The name of the relation.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.name = 'anotherName';
var firstTab = tabs.newTab('firstTab', 'Child Form', childForm, relation);
firstTab.relationName = relation.name;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Qualified name of the primary data source. Contains both the name of the primary server
and the name of the primary table.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.primaryDataSource = 'db:/user_data/another_parent_table';
relation.foreignDataSource = 'db:/user_data/another_child_table';
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}
Unknown macro: {span}
Unknown macro: {span}
getRelationItems
Unknown macro: {span}
()
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Returns an array of JSRelationItem objects representing the relation criteria defined for this relation.
Unknown macro: {tr}
Unknown macro: {td}
Returns
Unknown macro: {div}
JSRelationItem[] – An array of JSRelationItem instances representing the relation criteria of this relation.
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var criteria = relation.getRelationItems();
for (var i=0; i<criteria.length; i++)
{
var item = criteria[i];
application.output('relation item no. ' + i);
application.output('primary column: ' + item.primaryDataProviderID);
application.output('operator: ' + item.operator);
application.output('foreign column: ' + item.foreignColumnName);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Returns the UUID of the relation object
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
application.output(relation.getUUID().toString())
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}
Unknown macro: {span}
newRelationItem
Unknown macro: {span}
(dataprovider, operator, foreinColumnName)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Creates a new relation item for this relation. The primary dataprovider, the foreign data provider
and one relation operators (like '=' '!=' '>' '<') must be provided.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Returns
Unknown macro: {div}
JSRelationItem – A JSRelationItem instance representing the newly added relation item.
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('parentToChild', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id');
// for literals use a prefix
relation.newRelationItem(JSRelationItem.LITERAL_PREFIX + "'hello'",'=', 'mytextfield');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}
void
Unknown macro: {span}
removeRelationItem
Unknown macro: {span}
(primaryDataProviderID, operator, foreignColumnName)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}
Removes the desired relation item from the specified relation.
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Returns
Unknown macro: {div}
void
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
var relation = solutionModel.newRelation('myRelation', 'db:/myServer/parentTable', 'db:/myServer/childTable', JSRelation.INNER_JOIN);
relation.newRelationItem('someColumn1', '=', 'someColumn2');
relation.newRelationItem('anotherColumn', '=', 'someOtherColumn');
relation.removeRelationItem('someColumn1', '=', 'someColumn2');
var criteria = relation.getRelationItems();
for (var i = 0; i < criteria.length; i++) {
var item = criteria[i];
application.output('primary column: ' + item.primaryDataProviderID);
application.output('operator: ' + item.operator);
application.output('foreign column: ' + item.foreignColumnName);
}
Unknown macro: {tr}
Unknown macro: {td}
Overview
Content Tools
Activity