Return Types
SQL_ACTION_TYPES
JSColumn
JSDataSet
JSFoundSetUpdater
JSRecord
JSFoundSet
JSTable
QBSelect
QBAggregate
QBColumn
QBColumns
QBCondition
QBFunction
QBGroupBy
QBJoin
QBJoins
QBLogicalCondition
QBLogicalCondition
QBResult
QBSort
QBSorts
QBTableClause
QBPart
QBParameter
QBParameters
QBFunctions
QUERY_COLUMN_TYPES
JSFoundSet

Supported Clients
SmartClient
WebClient
NGClient
MobileClient

Property Summary
Boolean
nullColumnValidatorEnabled
Enable/disable the default null validator for non null columns, makes it possible todo the checks later on when saving, when for example autosave is disabled.

Methods Summary
Boolean
acquireLock(foundset, recordIndex)
Request lock(s) for a foundset, can be a normal or related foundset.
Boolean
acquireLock(foundset, recordIndex, lockName)
Request lock(s) for a foundset, can be a normal or related foundset.
Boolean
addTableFilterParam(query)
Adds a filter based on a query to all the foundsets based on a table.
Boolean
addTableFilterParam(query, filterName)
Adds a filter based on a query to all the foundsets based on a table.
Boolean
addTableFilterParam(datasource, dataprovider, operator, value)
Adds a filter to all the foundsets based on a table.
Boolean
addTableFilterParam(datasource, dataprovider, operator, value, filterName)
Adds a filter to all the foundsets based on a table.
Boolean
addTableFilterParam(serverName, tableName, dataprovider, operator, value)
Adds a filter to all the foundsets based on a table.
Boolean
addTableFilterParam(serverName, tableName, dataprovider, operator, value, filterName)
Adds a filter to all the foundsets based on a table.
void
addTrackingInfo(columnName, value)
Add tracking info used in the log table.
Boolean
commitTransaction()
Returns true if a transaction is committed; rollback if commit fails.
Boolean
commitTransaction(saveFirst)
Returns true if a transaction is committed; rollback if commit fails.
Boolean
commitTransaction(saveFirst, revertSavedRecords)
Returns true if a transaction is committed; rollback if commit fails.
JSFoundSet
convertFoundSet(foundset, related)
Creates a foundset that combines all the records of the specified one-to-many relation seen from the given parent/primary foundset.
JSFoundSet
convertFoundSet(foundset, related)
Creates a foundset that combines all the records of the specified one-to-many relation seen from the given parent/primary foundset.
JSDataSet
convertToDataSet(foundset)
Converts the argument to a JSDataSet, possible use in controller.
JSDataSet
convertToDataSet(foundset, dataproviderNames)
Converts the argument to a JSDataSet, possible use in controller.
JSDataSet
convertToDataSet(values)
Converts the argument to a JSDataSet, possible use in controller.
JSDataSet
convertToDataSet(values, dataproviderNames)
Converts the argument to a JSDataSet, possible use in controller.
JSDataSet
convertToDataSet(ids)
Converts the argument to a JSDataSet, possible use in controller.
Boolean
copyMatchingFields(source, destination)
Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
Boolean
copyMatchingFields(source, destination, overwrite)
Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
Boolean
copyMatchingFields(source, destination, names)
Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
String
createDataSourceByQuery(name, query, useTableFilters, max_returned_rows, types, pkNames)
Performs a query and saves the result in a datasource.
String
createDataSourceByQuery(name, query, max_returned_rows)
Performs a query and saves the result in a datasource.
String
createDataSourceByQuery(name, query, max_returned_rows, types)
Performs a query and saves the result in a datasource.
String
createDataSourceByQuery(name, query, max_returned_rows, types, pkNames)
Performs a query and saves the result in a datasource.
String
createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows)
Performs a sql query on the specified server, saves the the result in a datasource.
String
createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows, types)
Performs a sql query on the specified server, saves the the result in a datasource.
String
createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows, columnTypes, pkNames)
Performs a sql query on the specified server, saves the the result in a datasource.
JSDataSet
createEmptyDataSet()
Returns an empty dataset object.
JSDataSet
createEmptyDataSet(rowCount, columnCount)
Returns an empty dataset object.
JSDataSet
createEmptyDataSet(rowCount, columnNames)
Returns an empty dataset object.
QBSelect
createSelect(dataSource)
Create a QueryBuilder object for a datasource.
QBSelect
createSelect(dataSource, tableAlias)
Create a QueryBuilder object for a datasource with given table alias.
Boolean
dataSourceExists(dataSource)
Check wether a data source exists.
Boolean
getAutoSave()
Returns true or false if autosave is enabled or disabled.
Array
getDataModelClonesFrom(serverName)
Retrieves a list with names of all database servers that have property DataModelCloneFrom equal to the server name parameter.
JSDataSet
getDataSetByQuery(query, useTableFilters, max_returned_rows)
Performs a sql query with a query builder object.
JSDataSet
getDataSetByQuery(query, max_returned_rows)
Performs a sql query with a query builder object.
JSDataSet
getDataSetByQuery(server_name, sql_query, arguments, max_returned_rows)
Performs a sql query on the specified server, returns the result in a dataset.
String
getDataSource(serverName, tableName)
Returns the datasource corresponding to the given server/table.
String
getDataSourceServerName(dataSource)
Returns the server name from the datasource, or null if not a database datasource.
String
getDataSourceTableName(dataSource)
Returns the table name from the datasource, or null if not a database datasource.
String
getDatabaseProductName(serverName)
Returns the database product name as supplied by the driver for a server.
Array
getEditedRecords()
Returns an array of edited records with outstanding (unsaved) data.
Array
getEditedRecords(foundset)
Returns an array of edited records with outstanding (unsaved) data.
Array
getFailedRecords()
Returns an array of records that fail after a save.
Array
getFailedRecords(foundset)
Returns an array of records that fail after a save.
JSFoundSet
getFoundSet(query)
Returns a foundset object for a specified pk query.
JSFoundSet
getFoundSet(dataSource)
Returns a foundset object for a specified datasource or server and tablename.
JSFoundSet
getFoundSet(serverName, tableName)
Returns a foundset object for a specified datasource or server and tablename.
Number
getFoundSetCount(foundset)
Returns the total number of records in a foundset.
JSFoundSetUpdater
getFoundSetUpdater(foundset)
Returns a JSFoundsetUpdater object that can be used to update all or a specific number of rows in the specified foundset.
JSFoundSet
getNamedFoundSet(name)
Returns a named foundset object created under a specific name.
Object
getNextSequence(dataSource, columnName)
Gets the next sequence for a column which has a sequence defined in its column dataprovider properties.
String
getSQL(foundsetOrQBSelect)
Returns the internal SQL which defines the specified (related)foundset.
String
getSQL(foundsetOrQBSelect, includeFilters)
Returns the internal SQL which defines the specified (related)foundset.
Array
getSQLParameters(foundsetOrQBSelect)
Returns the internal SQL parameters, as an array, that are used to define the specified (related)foundset.
Array
getSQLParameters(foundsetOrQBSelect, includeFilters)
Returns the internal SQL parameters, as an array, that are used to define the specified (related)foundset.
Array
getServerNames()
Returns an array with all the server names used in the solution.
JSTable
getTable(foundset)
Returns the JSTable object from which more info can be obtained (like columns).
JSTable
getTable(record)
Returns the JSTable object from which more info can be obtained (like columns).
JSTable
getTable(dataSource)
Returns the JSTable object from which more info can be obtained (like columns).
JSTable
getTable(serverName, tableName)
Returns the JSTable object from which more info can be obtained (like columns).
Number
getTableCount(dataSource)
Returns the total number of records(rows) in a table.
Array
getTableFilterParams(serverName)
Returns a two dimensional array object containing the table filter information currently applied to the servers tables.
Array
getTableFilterParams(serverName, filterName)
Returns a two dimensional array object containing the table filter information currently applied to the servers tables.
Array
getTableNames(serverName)
Returns an array of all table names for a specified server.
JSFoundSet
getViewFoundSet(name, query)
Returns a foundset object for a specified query.
Array
getViewNames(serverName)
Returns an array of all view names for a specified server.
Boolean
hasLocks()
Returns true if the current client has any or the specified lock(s) acquired.
Boolean
hasLocks(lockName)
Returns true if the current client has any or the specified lock(s) acquired.
Boolean
hasNewRecords(foundset)
Returns true if the argument (foundSet / record) has at least one row that was not yet saved in the database.
Boolean
hasNewRecords(foundset, index)
Returns true if the argument (foundSet / record) has at least one row that was not yet saved in the database.
Boolean
hasRecordChanges(foundset)
Returns true if the specified foundset, on a specific index or in any of its records, or the specified record has changes.
Boolean
hasRecordChanges(foundset, index)
Returns true if the specified foundset, on a specific index or in any of its records, or the specified record has changes.
Boolean
hasRecords(foundset)
Returns true if the (related)foundset exists and has records.
Boolean
hasRecords(record, relationString)
Returns true if the (related)foundset exists and has records.
Boolean
hasTransaction()
Returns true if there is an transaction active for this client.
Boolean
mergeRecords(sourceRecord, combinedDestinationRecord)
Merge records from the same foundset, updates entire datamodel (via foreign type on columns) with destination record pk, deletes source record.
Boolean
mergeRecords(sourceRecord, combinedDestinationRecord, columnNames)
Merge records from the same foundset, updates entire datamodel (via foreign type on columns) with destination record pk, deletes source record.
void
recalculate(foundsetOrRecord)
Can be used to recalculate a specified record or all rows in the specified foundset.
Boolean
refreshRecordFromDatabase(foundset, index)
Flushes the client data cache and requeries the data for a record (based on the record index) in a foundset or all records in the foundset.
Boolean
registerViewFoundSet(foundset)
Registers the given ViewFoundSet to the system so it is picked up by forms that have this datasource assigned.
Boolean
releaseAllLocks()
Release all current locks the client has (optionally limited to named locks).
Boolean
releaseAllLocks(lockName)
Release all current locks the client has (optionally limited to named locks).
Boolean
removeTableFilterParam(serverName, filterName)
Removes a previously defined table filter.
void
revertEditedRecords()
Reverts outstanding (not saved) in memory changes from edited records.
void
revertEditedRecords(foundset)
Reverts outstanding (not saved) in memory changes from edited records.
void
rollbackTransaction()
Rollback a transaction started by databaseManager.
void
rollbackTransaction(rollbackEdited)
Rollback a transaction started by databaseManager.
void
rollbackTransaction(rollbackEdited, revertSavedRecords)
Rollback a transaction started by databaseManager.
Boolean
saveData()
Saves all outstanding (unsaved) data and exits the current record.
Boolean
saveData(foundset)
Saves all outstanding (unsaved) data and exits the current record.
Boolean
saveData(record)
Saves all outstanding (unsaved) data and exits the current record.
Boolean
setAutoSave(autoSave)
Set autosave, if false then no saves will happen by the ui (not including deletes!).
void
setCreateEmptyFormFoundsets()
Turnoff the initial form foundset record loading, set this in the solution open method.
void
startTransaction()
Start a database transaction.
Boolean
switchServer(sourceName, destinationName)
Switches a named server to another named server with the same datamodel (recommended to be used in an onOpen method for a solution).
Boolean
unegisterViewFoundSet(datasource)
Unregisters a ViewFoundSet based on the datasource.

Property Details

nullColumnValidatorEnabled

Enable/disable the default null validator for non null columns, makes it possible todo the checks later on when saving, when for example autosave is disabled.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

databaseManager.nullColumnValidatorEnabled = false;//disable

//test if enabled
if(databaseManager.nullColumnValidatorEnabled) application.output('null validation enabled')

Methods Details

acquireLock(foundset, recordIndex)

Request lock(s) for a foundset, can be a normal or related foundset.
The record_index can be -1 to lock all rows, 0 to lock the current row, or a specific row of > 0
Optionally name the lock(s) so that it can be referenced it in releaseAllLocks()

returns true if the lock could be acquired.

Parameters

JSFoundSet
foundset
The JSFoundset to get the lock for
Number
recordIndex
The record index which should be locked.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

//locks the complete foundset
databaseManager.acquireLock(foundset,-1);

//locks the current row
databaseManager.acquireLock(foundset,0);

//locks all related orders for the current Customer
var success = databaseManager.acquireLock(Cust_to_Orders,-1);
if(!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to get a lock','OK');
}

acquireLock(foundset, recordIndex, lockName)

Request lock(s) for a foundset, can be a normal or related foundset.
The record_index can be -1 to lock all rows, 0 to lock the current row, or a specific row of > 0
Optionally name the lock(s) so that it can be referenced it in releaseAllLocks()

returns true if the lock could be acquired.

Parameters

JSFoundSet
foundset
The JSFoundset to get the lock for
Number
recordIndex
The record index which should be locked.
String
lockName
The name of the lock.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

//locks the complete foundset
databaseManager.acquireLock(foundset,-1);

//locks the current row
databaseManager.acquireLock(foundset,0);

//locks all related orders for the current Customer
var success = databaseManager.acquireLock(Cust_to_Orders,-1);
if(!success)
{
	plugins.dialogs.showWarningDialog('Alert','Failed to get a lock','OK');
}

addTableFilterParam(query)

Adds a filter based on a query to all the foundsets based on a table.

Filters on tables touched in the query will not be applied to the query filter.
For example, when a table filter exists on the order_details table,
a query filter with a join from orders to order_details will be applied to queries on the orders table,
but the filter condition on the orders_details table will not be included.

returns true if the tablefilter could be applied.

Parameters

QBSelect
query
condition to filter on.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Best way to call this in a global solution startup method, but filters may be added/removed at any time.
// Note that

var query = datasources.db.example_data.orders.createSelect();
query.where.add(
   query.or.add(
            query.columns.shipcity.eq('Amersfoort'))
   .add(    query.columns.shipcity.eq('Amsterdam')));

var success = databaseManager.addTableFilterParam(query, 'cityFilter')

addTableFilterParam(query, filterName)

Adds a filter based on a query to all the foundsets based on a table.

Filters on tables touched in the query will not be applied to the query filter.
For example, when a table filter exists on the order_details table,
a query filter with a join from orders to order_details will be applied to queries on the orders table,
but the filter condition on the orders_details table will not be included.

returns true if the tablefilter could be applied.

Parameters

QBSelect
query
condition to filter on.
String
filterName
The specified name of the database table filter.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Best way to call this in a global solution startup method, but filters may be added/removed at any time.
// Note that

var query = datasources.db.example_data.orders.createSelect();
query.where.add(
   query.or.add(
            query.columns.shipcity.eq('Amersfoort'))
   .add(    query.columns.shipcity.eq('Amsterdam')));

var success = databaseManager.addTableFilterParam(query, 'cityFilter')

addTableFilterParam(datasource, dataprovider, operator, value)

Adds a filter to all the foundsets based on a table.
Note: if null is provided as the tablename the filter will be applied on all tables with the dataprovider name.
A dataprovider can have multiple filters defined, they will all be applied.
returns true if the tablefilter could be applied.

Parameters

String
datasource
The datasource
String
dataprovider
A specified dataprovider column name.
String
operator
One of "=, <, >, >=, <=, !=, LIKE, or IN" optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null).
Object
value
The specified filter value.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Best way to call this in a global solution startup method, but filters may be added/removed at any time.
// Note that multiple filters can be added to the same dataprovider, they will all be applied.

// filter on messages table where messagesid>10, the filter has a name so it can be removed using databaseManager.removeTableFilterParam()
var success = databaseManager.addTableFilterParam('admin', 'messages', 'messagesid', '>', 10, 'higNumberedMessagesRule')

// all tables that have the companyid column should be filtered
var success = databaseManager.addTableFilterParam('crm', null, 'companyidid', '=', currentcompanyid)

// some filters with in-conditions
var success = databaseManager.addTableFilterParam('crm', 'products', 'productcode', 'in', [120, 144, 200])
var success = databaseManager.addTableFilterParam('crm', 'orders', 'countrycode', 'in', 'select country code from countries where region = "Europe"')

// you can use modifiers in the operator as well, filter on companies where companyname is null or equals-ignore-case 'servoy'
var success = databaseManager.addTableFilterParam('crm', 'companies', 'companyname', '#^||=', 'servoy')

// the value may be null, this will result in 'column is null' sql condition.
var success = databaseManager.addTableFilterParam('crm', 'companies', 'verified', '=', null)

//if you want to add a filter for a column (created by you) in the i18n table
databaseManager.addTableFilterParam('database', 'your_i18n_table', 'message_variant', 'in', [1, 2])

addTableFilterParam(datasource, dataprovider, operator, value, filterName)

Adds a filter to all the foundsets based on a table.
Note: if null is provided as the tablename the filter will be applied on all tables with the dataprovider name.
A dataprovider can have multiple filters defined, they will all be applied.
returns true if the tablefilter could be applied.

Parameters

String
datasource
The datasource
String
dataprovider
A specified dataprovider column name.
String
operator
One of "=, <, >, >=, <=, !=, LIKE, or IN" optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null).
Object
value
The specified filter value.
String
filterName
The specified name of the database table filter.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Best way to call this in a global solution startup method, but filters may be added/removed at any time.
// Note that multiple filters can be added to the same dataprovider, they will all be applied.

// filter on messages table where messagesid>10, the filter has a name so it can be removed using databaseManager.removeTableFilterParam()
var success = databaseManager.addTableFilterParam('admin', 'messages', 'messagesid', '>', 10, 'higNumberedMessagesRule')

// all tables that have the companyid column should be filtered
var success = databaseManager.addTableFilterParam('crm', null, 'companyidid', '=', currentcompanyid)

// some filters with in-conditions
var success = databaseManager.addTableFilterParam('crm', 'products', 'productcode', 'in', [120, 144, 200])
var success = databaseManager.addTableFilterParam('crm', 'orders', 'countrycode', 'in', 'select country code from countries where region = "Europe"')

// you can use modifiers in the operator as well, filter on companies where companyname is null or equals-ignore-case 'servoy'
var success = databaseManager.addTableFilterParam('crm', 'companies', 'companyname', '#^||=', 'servoy')

// the value may be null, this will result in 'column is null' sql condition.
var success = databaseManager.addTableFilterParam('crm', 'companies', 'verified', '=', null)

//if you want to add a filter for a column (created by you) in the i18n table
databaseManager.addTableFilterParam('database', 'your_i18n_table', 'message_variant', 'in', [1, 2])

addTableFilterParam(serverName, tableName, dataprovider, operator, value)

Adds a filter to all the foundsets based on a table.
Note: if null is provided as the tablename the filter will be applied on all tables with the dataprovider name.
A dataprovider can have multiple filters defined, they will all be applied.
returns true if the tablefilter could be applied.

Parameters

String
serverName
The name of the database server connection for the specified table name.
String
tableName
The name of the specified table.
String
dataprovider
A specified dataprovider column name.
String
operator
One of "=, <, >, >=, <=, !=, LIKE, or IN" optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null).
Object
value
The specified filter value.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Best way to call this in a global solution startup method, but filters may be added/removed at any time.
// Note that multiple filters can be added to the same dataprovider, they will all be applied.

// filter on messages table where messagesid>10, the filter has a name so it can be removed using databaseManager.removeTableFilterParam()
var success = databaseManager.addTableFilterParam('admin', 'messages', 'messagesid', '>', 10, 'higNumberedMessagesRule')

// all tables that have the companyid column should be filtered
var success = databaseManager.addTableFilterParam('crm', null, 'companyidid', '=', currentcompanyid)

// some filters with in-conditions
var success = databaseManager.addTableFilterParam('crm', 'products', 'productcode', 'in', [120, 144, 200])
var success = databaseManager.addTableFilterParam('crm', 'orders', 'countrycode', 'in', 'select country code from countries where region = "Europe"')

// you can use modifiers in the operator as well, filter on companies where companyname is null or equals-ignore-case 'servoy'
var success = databaseManager.addTableFilterParam('crm', 'companies', 'companyname', '#^||=', 'servoy')

// the value may be null, this will result in 'column is null' sql condition.
var success = databaseManager.addTableFilterParam('crm', 'companies', 'verified', '=', null)

//if you want to add a filter for a column (created by you) in the i18n table
databaseManager.addTableFilterParam('database', 'your_i18n_table', 'message_variant', 'in', [1, 2])

addTableFilterParam(serverName, tableName, dataprovider, operator, value, filterName)

Adds a filter to all the foundsets based on a table.
Note: if null is provided as the tablename the filter will be applied on all tables with the dataprovider name.
A dataprovider can have multiple filters defined, they will all be applied.
returns true if the tablefilter could be applied.

Parameters

String
serverName
The name of the database server connection for the specified table name.
String
tableName
The name of the specified table.
String
dataprovider
A specified dataprovider column name.
String
operator
One of "=, <, >, >=, <=, !=, LIKE, or IN" optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null).
Object
value
The specified filter value.
String
filterName
The specified name of the database table filter.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Best way to call this in a global solution startup method, but filters may be added/removed at any time.
// Note that multiple filters can be added to the same dataprovider, they will all be applied.

// filter on messages table where messagesid>10, the filter has a name so it can be removed using databaseManager.removeTableFilterParam()
var success = databaseManager.addTableFilterParam('admin', 'messages', 'messagesid', '>', 10, 'higNumberedMessagesRule')

// all tables that have the companyid column should be filtered
var success = databaseManager.addTableFilterParam('crm', null, 'companyidid', '=', currentcompanyid)

// some filters with in-conditions
var success = databaseManager.addTableFilterParam('crm', 'products', 'productcode', 'in', [120, 144, 200])
var success = databaseManager.addTableFilterParam('crm', 'orders', 'countrycode', 'in', 'select country code from countries where region = "Europe"')

// you can use modifiers in the operator as well, filter on companies where companyname is null or equals-ignore-case 'servoy'
var success = databaseManager.addTableFilterParam('crm', 'companies', 'companyname', '#^||=', 'servoy')

// the value may be null, this will result in 'column is null' sql condition.
var success = databaseManager.addTableFilterParam('crm', 'companies', 'verified', '=', null)

//if you want to add a filter for a column (created by you) in the i18n table
databaseManager.addTableFilterParam('database', 'your_i18n_table', 'message_variant', 'in', [1, 2])

addTrackingInfo(columnName, value)

Add tracking info used in the log table.
When tracking is enabled and a new row is inserted in the log table,
if it has a column named 'columnName', its value will be set with 'value'

Parameters

String
columnName
The name of the column in the log table, used for tracking info
Object
value
The value to be set when inserting a new row in the log table, for the 'columnName' column

Supported Clients

SmartClient,WebClient,NGClient

Sample

databaseManager.addTrackingInfo('log_column_name', 'trackingInfo')

commitTransaction()

Returns true if a transaction is committed; rollback if commit fails.
Saves all edited records and commits the data.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// starts a database transaction
databaseManager.startTransaction()
//Now let users input data

//when data has been entered do a commit or rollback if the data entry is canceld or the the commit did fail.
if (cancel || !databaseManager.commitTransaction())
{
	databaseManager.rollbackTransaction();
}

commitTransaction(saveFirst)

Returns true if a transaction is committed; rollback if commit fails.

Parameters

Boolean
saveFirst
save edited records to the database first (default true)

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// starts a database transaction
databaseManager.startTransaction()
//Now let users input data

//when data has been entered do a commit or rollback if the data entry is canceld or the the commit did fail.
if (cancel || !databaseManager.commitTransaction())
{
	databaseManager.rollbackTransaction();
}

commitTransaction(saveFirst, revertSavedRecords)

Returns true if a transaction is committed; rollback if commit fails.

Parameters

Boolean
saveFirst
save edited records to the database first (default true)
Boolean
revertSavedRecords
if a commit fails and a rollback is done, the when given false the records are not reverted to the database state (and are in edited records again)

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

// starts a database transaction
databaseManager.startTransaction()
//Now let users input data

//when data has been entered do a commit or rollback if the data entry is canceld or the the commit did fail.
if (cancel || !databaseManager.commitTransaction())
{
	databaseManager.rollbackTransaction();
}

convertFoundSet(foundset, related)

Creates a foundset that combines all the records of the specified one-to-many relation seen from the given parent/primary foundset.
The created foundset will not contain records that have not been saved in the database, because the records in the foundset will be the
result of a select query to the database.

Parameters

JSFoundSet
foundset
The JSFoundset to convert.
JSFoundSet
related
can be a one-to-many relation object or the name of a one-to-many relation

Returns

JSFoundSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Convert in the order form a orders foundset into a orderdetails foundset,
// that has all the orderdetails from all the orders in the foundset.
var convertedFoundSet = databaseManager.convertFoundSet(foundset,order_to_orderdetails);
// or var convertedFoundSet = databaseManager.convertFoundSet(foundset,"order_to_orderdetails");
forms.orderdetails.controller.showRecords(convertedFoundSet);

convertFoundSet(foundset, related)

Creates a foundset that combines all the records of the specified one-to-many relation seen from the given parent/primary foundset.
The created foundset will not contain records that have not been saved in the database, because the records in the foundset will be the
result of a select query to the database.

Parameters

JSFoundSet
foundset
The JSFoundset to convert.
String
related
the name of a one-to-many relation

Returns

JSFoundSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// Convert in the order form a orders foundset into a orderdetails foundset,
// that has all the orderdetails from all the orders in the foundset.
var convertedFoundSet = databaseManager.convertFoundSet(foundset,order_to_orderdetails);
// or var convertedFoundSet = databaseManager.convertFoundSet(foundset,"order_to_orderdetails");
forms.orderdetails.controller.showRecords(convertedFoundSet);

convertToDataSet(foundset)

Converts the argument to a JSDataSet, possible use in controller.loadRecords(dataset).
The optional array of dataprovider names is used (only) to add the specified dataprovider names as columns to the dataset.

Parameters

JSFoundSet
foundset
The foundset to be converted.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// converts a foundset pks to a dataset
var dataset = databaseManager.convertToDataSet(foundset);
// converts a foundset to a dataset
//var dataset = databaseManager.convertToDataSet(foundset,['product_id','product_name']);
// converts an object array to a dataset
//var dataset = databaseManager.convertToDataSet(files,['name','path']);
// converts an array to a dataset
//var dataset = databaseManager.convertToDataSet(new Array(1,2,3,4,5,6));
// converts an string list to a dataset
//var dataset = databaseManager.convertToDataSet('4,5,6');

convertToDataSet(foundset, dataproviderNames)

Converts the argument to a JSDataSet, possible use in controller.loadRecords(dataset).
The optional array of dataprovider names is used (only) to add the specified dataprovider names as columns to the dataset.

Parameters

JSFoundSet
foundset
The foundset to be converted.
Array
dataproviderNames
Array with column names.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// converts a foundset pks to a dataset
var dataset = databaseManager.convertToDataSet(foundset);
// converts a foundset to a dataset
//var dataset = databaseManager.convertToDataSet(foundset,['product_id','product_name']);
// converts an object array to a dataset
//var dataset = databaseManager.convertToDataSet(files,['name','path']);
// converts an array to a dataset
//var dataset = databaseManager.convertToDataSet(new Array(1,2,3,4,5,6));
// converts an string list to a dataset
//var dataset = databaseManager.convertToDataSet('4,5,6');

convertToDataSet(values)

Converts the argument to a JSDataSet, possible use in controller.loadRecords(dataset).
The optional array of dataprovider names is used (only) to add the specified dataprovider names as columns to the dataset.

Parameters

Array
values
The values array.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// converts a foundset pks to a dataset
var dataset = databaseManager.convertToDataSet(foundset);
// converts a foundset to a dataset
//var dataset = databaseManager.convertToDataSet(foundset,['product_id','product_name']);
// converts an object array to a dataset
//var dataset = databaseManager.convertToDataSet(files,['name','path']);
// converts an array to a dataset
//var dataset = databaseManager.convertToDataSet(new Array(1,2,3,4,5,6));
// converts an string list to a dataset
//var dataset = databaseManager.convertToDataSet('4,5,6');

convertToDataSet(values, dataproviderNames)

Converts the argument to a JSDataSet, possible use in controller.loadRecords(dataset).
The optional array of dataprovider names is used (only) to add the specified dataprovider names as columns to the dataset.

Parameters

Array
values
The values array.
Array
dataproviderNames
The property names array.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// converts a foundset pks to a dataset
var dataset = databaseManager.convertToDataSet(foundset);
// converts a foundset to a dataset
//var dataset = databaseManager.convertToDataSet(foundset,['product_id','product_name']);
// converts an object array to a dataset
//var dataset = databaseManager.convertToDataSet(files,['name','path']);
// converts an array to a dataset
//var dataset = databaseManager.convertToDataSet(new Array(1,2,3,4,5,6));
// converts an string list to a dataset
//var dataset = databaseManager.convertToDataSet('4,5,6');

convertToDataSet(ids)

Converts the argument to a JSDataSet, possible use in controller.loadRecords(dataset).
The optional array of dataprovider names is used (only) to add the specified dataprovider names as columns to the dataset.

Parameters

String
ids
Concatenated values to be put into dataset.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// converts a foundset pks to a dataset
var dataset = databaseManager.convertToDataSet(foundset);
// converts a foundset to a dataset
//var dataset = databaseManager.convertToDataSet(foundset,['product_id','product_name']);
// converts an object array to a dataset
//var dataset = databaseManager.convertToDataSet(files,['name','path']);
// converts an array to a dataset
//var dataset = databaseManager.convertToDataSet(new Array(1,2,3,4,5,6));
// converts an string list to a dataset
//var dataset = databaseManager.convertToDataSet('4,5,6');

copyMatchingFields(source, destination)

Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
The matching requires the properties and getter functions of the source to match those of the destination; for the getter functions,
the 'get' will be removed and the remaining name will be converted to lowercase before attempting to match.
Returns true if no error occurred.

NOTE: This function could be used to store a copy of records in an archive table. Use the getRecord() function to get the record as an object.
Before trying this example, please make sure that the foundsets have some records loaded:

Parameters

Object
source
The source record or (java/javascript)object to be copied.
JSRecord
destination
The destination record to copy to.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

otherfoundset.loadAllRecords();
for( var i = 1 ; i <= foundset.getSize() ; i++ )
{
	var srcRecord = foundset.getRecord(i);
	var destRecord = otherfoundset.getRecord(i);
	if (srcRecord == null || destRecord == null) break;
	databaseManager.copyMatchingFields(srcRecord,destRecord,true)
}
//saves any outstanding changes to the dest foundset
databaseManager.saveData();

//copying from a MailMessage JavaScript object
//var _msg = plugins.mail.receiveMail(login, password, true, 0, null, properties);
//if (_msg != null)
//{
//	controller.newRecord();
//	var srcObject = _msg[0];
//	var destRecord = foundset.getSelectedRecord();
//	databaseManager.copyMatchingFields(srcObject, destRecord, true);
//	databaseManager.saveData();
//}

copyMatchingFields(source, destination, overwrite)

Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
The matching requires the properties and getter functions of the source to match those of the destination; for the getter functions,
the 'get' will be removed and the remaining name will be converted to lowercase before attempting to match.
Returns true if no error occurred.

NOTE: This function could be used to store a copy of records in an archive table. Use the getRecord() function to get the record as an object.
Before trying this example, please make sure that the foundsets have some records loaded:

Parameters

Object
source
The source record or (java/javascript)object to be copied.
JSRecord
destination
The destination record to copy to.
Boolean
overwrite
Boolean values to overwrite all values. If overwrite is false/not provided, then the non empty values are not overwritten in the destination record.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

otherfoundset.loadAllRecords();
for( var i = 1 ; i <= foundset.getSize() ; i++ )
{
	var srcRecord = foundset.getRecord(i);
	var destRecord = otherfoundset.getRecord(i);
	if (srcRecord == null || destRecord == null) break;
	databaseManager.copyMatchingFields(srcRecord,destRecord,true)
}
//saves any outstanding changes to the dest foundset
databaseManager.saveData();

//copying from a MailMessage JavaScript object
//var _msg = plugins.mail.receiveMail(login, password, true, 0, null, properties);
//if (_msg != null)
//{
//	controller.newRecord();
//	var srcObject = _msg[0];
//	var destRecord = foundset.getSelectedRecord();
//	databaseManager.copyMatchingFields(srcObject, destRecord, true);
//	databaseManager.saveData();
//}

copyMatchingFields(source, destination, names)

Copies all matching non empty columns (if overwrite boolean is given all columns except pk/ident, if array then all columns except pk and array names).
The matching requires the properties and getter functions of the source to match those of the destination; for the getter functions,
the 'get' will be removed and the remaining name will be converted to lowercase before attempting to match.
Returns true if no error occurred.

NOTE: This function could be used to store a copy of records in an archive table. Use the getRecord() function to get the record as an object.
Before trying this example, please make sure that the foundsets have some records loaded:

Parameters

Object
source
The source record or (java/javascript)object to be copied.
JSRecord
destination
The destination record to copy to.
Array
names
The property names that shouldn't be overriden.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

otherfoundset.loadAllRecords();
for( var i = 1 ; i <= foundset.getSize() ; i++ )
{
	var srcRecord = foundset.getRecord(i);
	var destRecord = otherfoundset.getRecord(i);
	if (srcRecord == null || destRecord == null) break;
	databaseManager.copyMatchingFields(srcRecord,destRecord,true)
}
//saves any outstanding changes to the dest foundset
databaseManager.saveData();

//copying from a MailMessage JavaScript object
//var _msg = plugins.mail.receiveMail(login, password, true, 0, null, properties);
//if (_msg != null)
//{
//	controller.newRecord();
//	var srcObject = _msg[0];
//	var destRecord = foundset.getSelectedRecord();
//	databaseManager.copyMatchingFields(srcObject, destRecord, true);
//	databaseManager.saveData();
//}

createDataSourceByQuery(name, query, useTableFilters, max_returned_rows, types, pkNames)

Performs a query and saves the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
Data source name
QBSelect
query
The query builder to be executed.
Boolean
useTableFilters
use table filters (default true).
Number
max_returned_rows
The maximum number of rows returned by the query.
Array
types
The column types, when null the types are inferred from the query.
Array
pkNames
array of pk names, when null a hidden pk-column will be added

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

// select customer data for order 1234
var q = datasources.db.example_data.customers.createSelect()
q.result.add(q.columns.customer_id).add(q.columns.city).add(q.columns.country);
q.where.add(q.joins.customers_to_orders.columns.orderid.eq(1234));
var uri = databaseManager.createDataSourceByQuery('mydata', q, true, 999, null, ['customer_id']);
//var uri = databaseManager.createDataSourceByQuery('mydata', q, true, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT], ['customer_id']);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600);
myForm.newTextField('city', 140, 20, 140,20);

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri);
fs.loadAllRecords();

createDataSourceByQuery(name, query, max_returned_rows)

Performs a query and saves the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
data source name
QBSelect
query
The query builder to be executed.
Number
max_returned_rows
The maximum number of rows returned by the query.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

// select customer data for order 1234
var q = datasources.db.example_data.customers.createSelect()
q.result.add(q.columns.customer_id).add(q.columns.city).add(q.columns.country);
q.where.add(q.joins.customers_to_orders.columns.orderid.eq(1234));
var uri = databaseManager.createDataSourceByQuery('mydata', q, true, 999, null, ['customer_id']);
//var uri = databaseManager.createDataSourceByQuery('mydata', q, true, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT], ['customer_id']);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600);
myForm.newTextField('city', 140, 20, 140,20);

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri);
fs.loadAllRecords();

createDataSourceByQuery(name, query, max_returned_rows, types)

Performs a query and saves the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

Using this variation of createDataSourceByQuery any Tablefilter on the involved tables will be taken into account.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
Data source name
QBSelect
query
The query builder to be executed.
Number
max_returned_rows
The maximum number of rows returned by the query.
Array
types
The column types

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

// select customer data for order 1234
var q = datasources.db.example_data.customers.createSelect();
q.result.add(q.columns.address).add(q.columns.city).add(q.columns.country);
q.where.add(q.joins.customers_to_orders.columns.orderid.eq(1234));
var uri = databaseManager.createDataSourceByQuery('mydata', q, 999);
//var uri = databaseManager.createDataSourceByQuery('mydata', q, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT]);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600);
myForm.newTextField('city', 140, 20, 140,20);

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri);
fs.loadAllRecords();

createDataSourceByQuery(name, query, max_returned_rows, types, pkNames)

Performs a query and saves the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

Using this variation of createDataSourceByQuery any Tablefilter on the involved tables will be taken into account.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
Data source name
QBSelect
query
The query builder to be executed.
Number
max_returned_rows
The maximum number of rows returned by the query.
Array
types
The column types
Array
pkNames
array of pk names, when null a hidden pk-column will be added

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

// select customer data for order 1234
var q = datasources.db.example_data.customers.createSelect();
q.result.add(q.columns.customer_id).add(q.columns.city).add(q.columns.country);
q.where.add(q.joins.customers_to_orders.columns.orderid.eq(1234));
var uri = databaseManager.createDataSourceByQuery('mydata', q, 999, null, ['customer_id']);
//var uri = databaseManager.createDataSourceByQuery('mydata', q, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT], ['customer_id']);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600);
myForm.newTextField('city', 140, 20, 140,20);

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri);
fs.loadAllRecords();

createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows)

Performs a sql query on the specified server, saves the the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

Using this variation of createDataSourceByQuery any Tablefilter on the involved tables will be disregarded.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
data source name
String
server_name
The name of the server where the query should be executed.
String
sql_query
The custom sql, must start with 'select', 'call', 'with' or 'declare'.
Array
arguments
Specified arguments or null if there are no arguments.
Number
max_returned_rows
The maximum number of rows returned by the query.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

var query = 'select address, city, country  from customers';
var uri = databaseManager.createDataSourceByQuery('mydata', 'example_data', query, null, 999);
//var uri = databaseManager.createDataSourceByQuery('mydata', 'example_data', query, null, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT]);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600)
myForm.newTextField('city', 140, 20, 140,20)

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri)
fs.loadAllRecords();

createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows, types)

Performs a sql query on the specified server, saves the the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

Using this variation of createDataSourceByQuery any Tablefilter on the involved tables will be disregarded.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
data source name
String
server_name
The name of the server where the query should be executed.
String
sql_query
The custom sql, must start with 'select', 'call', 'with' or 'declare'.
Array
arguments
Specified arguments or null if there are no arguments.
Number
max_returned_rows
The maximum number of rows returned by the query.
Array
types
The column types

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

var query = 'select address, city, country  from customers';
var uri = databaseManager.createDataSourceByQuery('mydata', 'example_data', query, null, 999);
//var uri = databaseManager.createDataSourceByQuery('mydata', 'example_data', query, null, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT]);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600)
myForm.newTextField('city', 140, 20, 140,20)

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri)
fs.loadAllRecords();

createDataSourceByQuery(name, server_name, sql_query, arguments, max_returned_rows, columnTypes, pkNames)

Performs a sql query on the specified server, saves the the result in a datasource.
Will throw an exception if anything went wrong when executing the query.
Column types in the datasource are inferred from the query result or can be explicitly specified.

Using this variation of createDataSourceByQuery any Tablefilter on the involved tables will be disregarded.

A datasource can be reused if the data has the same signature (column names and types).
A new createDataSourceByQuery() call will clear the datasource contents from a previous call and insert the current data.

Parameters

String
name
data source name
String
server_name
The name of the server where the query should be executed.
String
sql_query
The custom sql, must start with 'select', 'call', 'with' or 'declare'.
Array
arguments
Specified arguments or null if there are no arguments.
Number
max_returned_rows
The maximum number of rows returned by the query.
Object
columnTypes
The column types
Array
pkNames
array of pk names, when null a hidden pk-column will be added

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

var query = 'select customer_id, address, city, country  from customers';
var uri = databaseManager.createDataSourceByQuery('mydata', 'example_data', query, null, 999);
//var uri = databaseManager.createDataSourceByQuery('mydata', 'example_data', query, null, 999, [JSColumn.TEXT, JSColumn.TEXT, JSColumn.TEXT], ['customer_id']);

// the uri can be used to create a form using solution model
var myForm = solutionModel.newForm('newForm', uri, 'myStyleName', false, 800, 600)
myForm.newTextField('city', 140, 20, 140,20)

// the uri can be used to acces a foundset directly
var fs = databaseManager.getFoundSet(uri)
fs.loadAllRecords();

createEmptyDataSet()

Returns an empty dataset object.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// gets an empty dataset with a specifed row and column count
var dataset = databaseManager.createEmptyDataSet(10,10)
// gets an empty dataset with a specifed row count and column array
var dataset2 = databaseManager.createEmptyDataSet(10,new Array ('a','b','c','d'))

createEmptyDataSet(rowCount, columnCount)

Returns an empty dataset object.

Parameters

Number
rowCount
The number of rows in the DataSet object.
Number
columnCount
Number of columns.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// gets an empty dataset with a specifed row and column count
var dataset = databaseManager.createEmptyDataSet(10,10)
// gets an empty dataset with a specifed row count and column array
var dataset2 = databaseManager.createEmptyDataSet(10,new Array ('a','b','c','d'))

createEmptyDataSet(rowCount, columnNames)

Returns an empty dataset object.

Parameters

Number
rowCount
;
Array
columnNames
;

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// gets an empty dataset with a specifed row and column count
var dataset = databaseManager.createEmptyDataSet(10,10)
// gets an empty dataset with a specifed row count and column array
var dataset2 = databaseManager.createEmptyDataSet(10,new Array ('a','b','c','d'))

createSelect(dataSource)

Create a QueryBuilder object for a datasource.

Parameters

String
dataSource
The data source to build a query for.

Returns

QBSelect

Supported Clients

SmartClient,WebClient,NGClient

Sample

/** @type {QBSelect<db:/example_data/book_nodes>} */
var q = databaseManager.createSelect('db:/example_data/book_nodes');
q.result.addPk()
q.where.add(q.columns.label_text.not.isin(null))
datasources.db.example_data.book_nodes.getFoundSet().loadRecords(q)

createSelect(dataSource, tableAlias)

Create a QueryBuilder object for a datasource with given table alias.
The alias can be used inside custom queries to bind to the outer table.

Parameters

String
dataSource
The data source to build a query for.
String
tableAlias
The alias for the main table.

Returns

QBSelect

Supported Clients

SmartClient,WebClient,NGClient

Sample

/** @type {QBSelect<db:/example_data/book_nodes>} */
var q = databaseManager.createSelect('db:/example_data/book_nodes', 'b');
q.result.addPk()
q.where.add(q.columns.label_text.isin('select comment_text from book_text t where t.note_text = ? and t.node_id = b.node_id', ['test']))
datasources.db.example_data.book_nodes.getFoundSet().loadRecords(q)

dataSourceExists(dataSource)

Check wether a data source exists. This function can be used for any type of data source (db-based, in-memory).

Parameters

String
dataSource
the datasource string to check.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

if (!databaseManager.dataSourceExists(dataSource))
{
   // does not exist
}

getAutoSave()

Returns true or false if autosave is enabled or disabled.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

//Set autosave, if false then no saves will happen by the ui (not including deletes!). Until you call saveData or setAutoSave(true)
//Rollbacks in mem the records that were edited and not yet saved. Best used in combination with autosave false.
databaseManager.setAutoSave(false)
//Now let users input data

//On save or cancel, when data has been entered:
if (cancel) databaseManager.rollbackEditedRecords()
databaseManager.setAutoSave(true)

getDataModelClonesFrom(serverName)

Retrieves a list with names of all database servers that have property DataModelCloneFrom equal to the server name parameter.

Parameters

String
serverName
;

Returns

Array

Supported Clients

SmartClient,WebClient,NGClient

Sample

var serverNames = databaseManager.getDataModelClonesFrom('myServerName');

getDataSetByQuery(query, useTableFilters, max_returned_rows)

Performs a sql query with a query builder object.
Will throw an exception if anything did go wrong when executing the query.

Parameters

QBSelect
query
QBSelect query.
Boolean
useTableFilters
use table filters (default true).
Number
max_returned_rows
The maximum number of rows returned by the query.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// use the query froma foundset and add a condition
/** @type {QBSelect<db:/example_data/orders>} */
var q = foundset.getQuery()
q.where.add(q.joins.orders_to_order_details.columns.discount.eq(2))
var maxReturnedRows = 10;//useful to limit number of rows
var ds = databaseManager.getDataSetByQuery(q, true, maxReturnedRows);

// query: select PK from example.book_nodes where parent = 111 and(note_date is null or note_date > now)
var query = datasources.db.example_data.book_nodes.createSelect().result.addPk().root
query.where.add(query.columns.parent_id.eq(111))
	.add(query.or
	.add(query.columns.note_date.isNull)
	.add(query.columns.note_date.gt(new Date())))
databaseManager.getDataSetByQuery(q, true, max_returned_rows)

getDataSetByQuery(query, max_returned_rows)

Performs a sql query with a query builder object.
Will throw an exception if anything did go wrong when executing the query.

Using this variation of getDataSetByQuery any Tablefilter on the involved tables will be taken into account.

Parameters

QBSelect
query
QBSelect query.
Number
max_returned_rows
The maximum number of rows returned by the query.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// use the query froma foundset and add a condition
/** @type {QBSelect<db:/example_data/orders>} */
var q = foundset.getQuery()
q.where.add(q.joins.orders_to_order_details.columns.discount.eq(2))
var maxReturnedRows = 10;//useful to limit number of rows
var ds = databaseManager.getDataSetByQuery(q, maxReturnedRows);

// query: select PK from example.book_nodes where parent = 111 and(note_date is null or note_date > now)
var query = datasources.db.example_data.book_nodes.createSelect().result.addPk().root
query.where.add(query.columns.parent_id.eq(111))
	.add(query.or
	.add(query.columns.note_date.isNull)
	.add(query.columns.note_date.gt(new Date())))
databaseManager.getDataSetByQuery(q, max_returned_rows)

getDataSetByQuery(server_name, sql_query, arguments, max_returned_rows)

Performs a sql query on the specified server, returns the result in a dataset.
Will throw an exception if anything did go wrong when executing the query.

Using this variation of getDataSetByQuery any Tablefilter on the involved tables will be disregarded.

Parameters

String
server_name
The name of the server where the query should be executed.
String
sql_query
The custom sql, must start with 'select', 'call', 'with' or 'declare'.
Array
arguments
Specified arguments or null if there are no arguments.
Number
max_returned_rows
The maximum number of rows returned by the query.

Returns

JSDataSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

//finds duplicate records in a specified foundset
var vQuery =" SELECT companiesid from companies where company_name IN (SELECT company_name from companies group bycompany_name having count(company_name)>1 )";
var vDataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), vQuery, null, 1000);
controller.loadRecords(vDataset);

var maxReturnedRows = 10;//useful to limit number of rows
var query = 'select c1,c2,c3 from test_table where start_date = ?';//do not use '.' or special chars in names or aliases if you want to access data by name
var args = new Array();
args[0] = order_date //or  new Date()
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, args, maxReturnedRows);

// place in label:
// elements.myLabel.text = '<html>'+dataset.getAsHTML()+'</html>';

//example to calc a strange total
global_total = 0;
for( var i = 1 ; i <= dataset.getMaxRowIndex() ; i++ )
{
	dataset.rowIndex = i;
	global_total = global_total + dataset.c1 + dataset.getValue(i,3);
}
//example to assign to dataprovider
//employee_salary = dataset.getValue(row,column)

getDataSource(serverName, tableName)

Returns the datasource corresponding to the given server/table.

Parameters

String
serverName
The name of the table's server.
String
tableName
The table's name.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var datasource = databaseManager.getDataSource('example_data', 'categories');

getDataSourceServerName(dataSource)

Returns the server name from the datasource, or null if not a database datasource.

Parameters

String
dataSource
The datasource string to get the server name from.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var servername = databaseManager.getDataSourceServerName(datasource);

getDataSourceTableName(dataSource)

Returns the table name from the datasource, or null if not a database datasource.

Parameters

String
dataSource
The datasource string to get the tablename from.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

var tablename = databaseManager.getDataSourceTableName(datasource);

getDatabaseProductName(serverName)

Returns the database product name as supplied by the driver for a server.

NOTE: For more detail on named server connections, see the chapter on Database Connections, beginning with the Introduction to database connections in the Servoy Developer User's Guide.

Parameters

String
serverName
The specified name of the database server connection.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

var databaseProductName = databaseManager.getDatabaseProductName(servername)

getEditedRecords()

Returns an array of edited records with outstanding (unsaved) data.

This is different form JSRecord.isEditing() because this call actually checks if there are changes between the current
record data and the stored data in the database. If there are no changes then the record is removed from the edited records
list (so after this call JSRecord.isEditing() can return false when it returned true just before this call)

NOTE: To return a dataset of outstanding (unsaved) edited data for each record, see JSRecord.getChangedData();
NOTE2: The fields focus may be lost in user interface in order to determine the edits.

Returns

Array

Supported Clients

SmartClient,WebClient,NGClient

Sample

//This method can be used to loop through all outstanding changes,
//the application.output line contains all the changed data, their tablename and primary key
var editr = databaseManager.getEditedRecords()
for (x=0;x<editr.length;x++)
{
	var ds = editr[x].getChangedData();
	var jstable = databaseManager.getTable(editr[x]);
	var tableSQLName = jstable.getSQLName();
	var pkrec = jstable.getRowIdentifierColumnNames().join(',');
	var pkvals = new Array();
	for (var j = 0; j < jstable.getRowIdentifierColumnNames().length; j++)
	{
		pkvals[j] = editr[x][jstable.getRowIdentifierColumnNames()[j]];
	}
	application.output('Table: '+tableSQLName +', PKs: '+ pkvals.join(',') +' ('+pkrec +')');
	// Get a dataset with outstanding changes on a record
	for( var i = 1 ; i <= ds.getMaxRowIndex() ; i++ )
	{
		application.output('Column: '+ ds.getValue(i,1) +', oldValue: '+ ds.getValue(i,2) +', newValue: '+ ds.getValue(i,3));
	}
}
//in most cases you will want to set autoSave back on now
databaseManager.setAutoSave(true);

getEditedRecords(foundset)

Returns an array of edited records with outstanding (unsaved) data.

NOTE: To return a dataset of outstanding (unsaved) edited data for each record, see JSRecord.getChangedData();
NOTE2: The fields focus may be lost in user interface in order to determine the edits.

Parameters

JSFoundSet
foundset
return edited records in the foundset only.

Returns

Array

Supported Clients

SmartClient,WebClient,NGClient

Sample

//This method can be used to loop through all outstanding changes in a foundset,
//the application.output line contains all the changed data, their tablename and primary key
var editr = databaseManager.getEditedRecords(foundset)
for (x=0;x<editr.length;x++)
{
	var ds = editr[x].getChangedData();
	var jstable = databaseManager.getTable(editr[x]);
	var tableSQLName = jstable.getSQLName();
	var pkrec = jstable.getRowIdentifierColumnNames().join(',');
	var pkvals = new Array();
	for (var j = 0; j < jstable.getRowIdentifierColumnNames().length; j++)
	{
		pkvals[j] = editr[x][jstable.getRowIdentifierColumnNames()[j]];
	}
	application.output('Table: '+tableSQLName +', PKs: '+ pkvals.join(',') +' ('+pkrec +')');
	// Get a dataset with outstanding changes on a record
	for( var i = 1 ; i <= ds.getMaxRowIndex() ; i++ )
	{
		application.output('Column: '+ ds.getValue(i,1) +', oldValue: '+ ds.getValue(i,2) +', newValue: '+ ds.getValue(i,3));
	}
}
databaseManager.saveData(foundset);//save all records from foundset

getFailedRecords()

Returns an array of records that fail after a save.

Returns

Array

Supported Clients

SmartClient,WebClient,NGClient

Sample

var array = databaseManager.getFailedRecords()
for( var i = 0 ; i < array.length ; i++ )
{
	var record = array[i];
	application.output(record.exception);
	if (record.exception.getErrorCode() == ServoyException.RECORD_VALIDATION_FAILED)
	{
		// exception thrown in pre-insert/update/delete event method
		var thrown = record.exception.getValue()
		application.output("Record validation failed: "+thrown)
	}
	// find out the table of the record (similar to getEditedRecords)
	var jstable = databaseManager.getTable(record);
	var tableSQLName = jstable.getSQLName();
	application.output('Table:'+tableSQLName+' in server:'+jstable.getServerName()+' failed to save.')
}

getFailedRecords(foundset)

Returns an array of records that fail after a save.

Parameters

JSFoundSet
foundset
return failed records in the foundset only.

Returns

Array

Supported Clients

SmartClient,WebClient,NGClient

Sample

var array = databaseManager.getFailedRecords(foundset)
for( var i = 0 ; i < array.length ; i++ )
{
	var record = array[i];
	application.output(record.exception);
	if (record.exception.getErrorCode() == ServoyException.RECORD_VALIDATION_FAILED)
	{
		// exception thrown in pre-insert/update/delete event method
		var thrown = record.exception.getValue()
		application.output("Record validation failed: "+thrown)
	}
	// find out the table of the record (similar to getEditedRecords)
	var jstable = databaseManager.getTable(record);
	var tableSQLName = jstable.getSQLName();
	application.output('Table:'+tableSQLName+' in server:'+jstable.getServerName()+' failed to save.')
}

getFoundSet(query)

Returns a foundset object for a specified pk query.

Parameters

QBSelect
query
The query to get the JSFoundset for.

Returns

JSFoundSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// type the foundset returned from the call with JSDoc, fill in the right server/tablename
/** @type {JSFoundset<db:/servername/tablename>} */
var fs = databaseManager.getFoundSet(controller.getDataSource())
// same as datasources.db.example_data.orders.getFoundSet() or datasources.mem['myds'].getFoundSet()
var ridx = fs.newRecord()
var record = fs.getRecord(ridx)
record.emp_name = 'John'
databaseManager.saveData()

getFoundSet(dataSource)

Returns a foundset object for a specified datasource or server and tablename.
Alternative method: datasources.db.server_name.table_name.getFoundSet() or datasources.mem['ds'].getFoundSet()

Parameters

String
dataSource
The datasource to get a JSFoundset for.

Returns

JSFoundSet

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

// type the foundset returned from the call with JSDoc, fill in the right server/tablename
/** @type {JSFoundset<db:/servername/tablename>} */
var fs = databaseManager.getFoundSet(controller.getDataSource())
// same as datasources.db.example_data.orders.getFoundSet() or datasources.mem['myds'].getFoundSet()
var ridx = fs.newRecord()
var record = fs.getRecord(ridx)
record.emp_name = 'John'
databaseManager.saveData()

getFoundSet(serverName, tableName)

Returns a foundset object for a specified datasource or server and tablename.

Parameters

String
serverName
The servername to get a JSFoundset for.
String
tableName
The tablename for that server

Returns

JSFoundSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// type the foundset returned from the call with JSDoc, fill in the right server/tablename
/** @type {JSFoundset<db:/servername/tablename>} */
var fs = databaseManager.getFoundSet(controller.getDataSource())
// same as datasources.db.example_data.orders.getFoundSet() or datasources.mem['myds'].getFoundSet()
var ridx = fs.newRecord()
var record = fs.getRecord(ridx)
record.emp_name = 'John'
databaseManager.saveData()

getFoundSetCount(foundset)

Returns the total number of records in a foundset.

NOTE: This can be an expensive operation (time-wise) if your resultset is large.

Parameters

JSFoundSet
foundset
The JSFoundset to get the count for.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

//return the total number of records in a foundset.
databaseManager.getFoundSetCount(foundset);

getFoundSetUpdater(foundset)

Returns a JSFoundsetUpdater object that can be used to update all or a specific number of rows in the specified foundset.

Parameters

JSFoundSet
foundset
The foundset to update.

Returns

JSFoundSetUpdater

Supported Clients

SmartClient,WebClient,NGClient

Sample

//1) update entire foundset
var fsUpdater = databaseManager.getFoundSetUpdater(foundset)
fsUpdater.setColumn('customer_type',1)
fsUpdater.setColumn('my_flag',0)
fsUpdater.performUpdate()

//2) update part of foundset, for example the first 4 row (starts with selected row)
var fsUpdater = databaseManager.getFoundSetUpdater(foundset)
fsUpdater.setColumn('customer_type',new Array(1,2,3,4))
fsUpdater.setColumn('my_flag',new Array(1,0,1,0))
fsUpdater.performUpdate()

//3) safely loop through foundset (starts with selected row)
controller.setSelectedIndex(1)
var count = 0
var fsUpdater = databaseManager.getFoundSetUpdater(foundset)
while(fsUpdater.next())
{
	fsUpdater.setColumn('my_flag',count++)
}

getNamedFoundSet(name)

Returns a named foundset object created under a specific name. If foundset does not exist, null will be returned.
Alternative method: datasources.db.server_name.table_name.getFoundSet(name)

Parameters

String
name
The named foundset name

Returns

JSFoundSet

Supported Clients

SmartClient,WebClient,NGClient

Sample

// type the foundset returned from the call with JSDoc, fill in the right server/tablename
/** @type {JSFoundset<db:/servername/tablename>} */
var fs = databaseManager.getNamedFoundSet('myname')
// same as datasources.db.example_data.orders.getFoundSet('myname')
var ridx = fs.newRecord()
var record = fs.getRecord(ridx)
record.emp_name = 'John'
databaseManager.saveData()

getNextSequence(dataSource, columnName)

Gets the next sequence for a column which has a sequence defined in its column dataprovider properties.

NOTE: For more infomation on configuring the sequence for a column, see the section Auto enter options for a column from the Dataproviders chapter in the Servoy Developer User's Guide.

Parameters

String
dataSource
The datasource that points to the table which has the column with the sequence, or the name of the server where the table can be found. If the name of the server is specified, then a second optional parameter specifying the name of the table must be used. If the datasource is specified, then the name of the table is not needed as the second argument.
String
columnName
The name of the column that has a sequence defined in its properties.

Returns

Object

Supported Clients

SmartClient,WebClient,NGClient

Sample

var seqDataSource = forms.seq_table.controller.getDataSource();
var nextValue = databaseManager.getNextSequence(seqDataSource, 'seq_table_value');
application.output(nextValue);

nextValue = databaseManager.getNextSequence(databaseManager.getDataSourceServerName(seqDataSource), databaseManager.getDataSourceTableName(seqDataSource), 'seq_table_value')
application.output(nextValue);

getSQL(foundsetOrQBSelect)

Returns the internal SQL which defines the specified (related)foundset.
Table filters are on by default.
Make sure to set the applicable filters when the sql is used in a loadRecords() call.