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'
{column:width=80px|padding=0px}{column}{column}{column}
Server Property Summary
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
executeSQL(serverName, tableName, sql)
Execute any SQL, returns true if successful.
executeSQL(serverName, tableName, sql, sql_args)
Execute any SQL, returns true if successful.
executeStoredProcedure(serverName, procedureDeclaration, arguments, inOutDirectionality, maxNumberOfRowsToRetrieve)
Execute a stored procedure.
flushAllClientsCache(serverName, tableName)
Flush cached database data.
getException()
If the result from a function was false, it will return the exception object.
notifyDataChange(serverName, tableName, pksDataset, action)
Notify clients about changes in records, based on pk(s).
{column:width=100%|padding=0px}{column}
Server Property Details
{column:width=100%|padding=0px}{column}
Method Details
executeSQL
(serverName, tableName, sql)
Execute any SQL, returns true if successful.
Sample
/**************************************************************************** WARNING! You can cause data loss or serious data integrity compromises! You should have a THOROUGH understanding of both SQL and your backend database (and other interfaces that may use that backend) BEFORE YOU USE ANY OF THESE COMMANDS. You should also READ THE DOCUMENTATION BEFORE USING ANY OF THESE COMMANDS Note that when server names have been switched (databasemanager.switchServer),the real server names must be used here, plugins.rawSQL is not transparent to switched servers. ****************************************************************************/ var country = 'NL' var done = plugins.rawSQL.executeSQL("example_data","employees","update employees set country = ?", [country]) if (done) { //flush is required when changes are made in db plugins.rawSQL.flushAllClientsCache("example_data","employees") } else { var msg = plugins.rawSQL.getException().getMessage(); //see exception node for more info about the exception obj plugins.dialogs.showErrorDialog('Error', 'SQL exception: '+msg, 'Ok') } // Note that when this function is used to create a new table in the database, this table will only be seen by // the Servoy Application Server when the table name starts with 'temp_', otherwise a server restart is needed.
executeSQL
(serverName, tableName, sql, sql_args)
Execute any SQL, returns true if successful.
Sample
/**************************************************************************** WARNING! You can cause data loss or serious data integrity compromises! You should have a THOROUGH understanding of both SQL and your backend database (and other interfaces that may use that backend) BEFORE YOU USE ANY OF THESE COMMANDS. You should also READ THE DOCUMENTATION BEFORE USING ANY OF THESE COMMANDS Note that when server names have been switched (databasemanager.switchServer),the real server names must be used here, plugins.rawSQL is not transparent to switched servers. ****************************************************************************/ var country = 'NL' var done = plugins.rawSQL.executeSQL("example_data","employees","update employees set country = ?", [country]) if (done) { //flush is required when changes are made in db plugins.rawSQL.flushAllClientsCache("example_data","employees") } else { var msg = plugins.rawSQL.getException().getMessage(); //see exception node for more info about the exception obj plugins.dialogs.showErrorDialog('Error', 'SQL exception: '+msg, 'Ok') } // Note that when this function is used to create a new table in the database, this table will only be seen by // the Servoy Application Server when the table name starts with 'temp_', otherwise a server restart is needed.
executeStoredProcedure
(serverName, procedureDeclaration, arguments, inOutDirectionality, maxNumberOfRowsToRetrieve)
Execute a stored procedure.
Sample
/**************************************************************************** WARNING! You can cause data loss or serious data integrity compromises! You should have a THOROUGH understanding of both SQL and your backend database (and other interfaces that may use that backend) BEFORE YOU USE ANY OF THESE COMMANDS. You should also READ THE DOCUMENTATION BEFORE USING ANY OF THESE COMMANDS Note that when server names have been switched (databasemanager.switchServer),the real server names must be used here, plugins.rawSQL is not transparent to switched servers. ****************************************************************************/ var maxReturnedRows = 10; //useful to limit number of rows var procedure_declaration = '{?=calculate_interest_rate(?)}' // define the direction, a 0 for input data, a 1 for output data var typesArray = [1, 0]; // define the types and values, a value for input data, a sql-type for output data var args = [java.sql.Types.NUMERIC, 3000] // A dataset is returned, when no output-parameters defined, the last select-result in the procedure will be returned. // When one or more output-parameters are defined, the dataset will contain 1 row with the output data. var dataset = plugins.rawSQL.executeStoredProcedure(databaseManager.getDataSourceServerName(controller.getDataSource()), procedure_declaration, args, typesArray, maxReturnedRows); var interest_rate = dataset.getValue(1, 1);
flushAllClientsCache
(serverName, tableName)
Flush cached database data. Use with extreme care, its affecting the performance of clients!
Sample
/**************************************************************************** WARNING! You can cause data loss or serious data integrity compromises! You should have a THOROUGH understanding of both SQL and your backend database (and other interfaces that may use that backend) BEFORE YOU USE ANY OF THESE COMMANDS. You should also READ THE DOCUMENTATION BEFORE USING ANY OF THESE COMMANDS Note that when server names have been switched (databasemanager.switchServer),the real server names must be used here, plugins.rawSQL is not transparent to switched servers. ****************************************************************************/ var country = 'NL' var done = plugins.rawSQL.executeSQL("example_data","employees","update employees set country = ?", [country]) if (done) { //flush is required when changes are made in db plugins.rawSQL.flushAllClientsCache("example_data","employees") } else { var msg = plugins.rawSQL.getException().getMessage(); //see exception node for more info about the exception obj plugins.dialogs.showErrorDialog('Error', 'SQL exception: '+msg, 'Ok') } // Note that when this function is used to create a new table in the database, this table will only be seen by // the Servoy Application Server when the table name starts with 'temp_', otherwise a server restart is needed.
getException
()
If the result from a function was false, it will return the exception object.
Sample
/**************************************************************************** WARNING! You can cause data loss or serious data integrity compromises! You should have a THOROUGH understanding of both SQL and your backend database (and other interfaces that may use that backend) BEFORE YOU USE ANY OF THESE COMMANDS. You should also READ THE DOCUMENTATION BEFORE USING ANY OF THESE COMMANDS Note that when server names have been switched (databasemanager.switchServer),the real server names must be used here, plugins.rawSQL is not transparent to switched servers. ****************************************************************************/ var country = 'NL' var done = plugins.rawSQL.executeSQL("example_data","employees","update employees set country = ?", [country]) if (done) { //flush is required when changes are made in db plugins.rawSQL.flushAllClientsCache("example_data","employees") } else { var msg = plugins.rawSQL.getException().getMessage(); //see exception node for more info about the exception obj plugins.dialogs.showErrorDialog('Error', 'SQL exception: '+msg, 'Ok') } // Note that when this function is used to create a new table in the database, this table will only be seen by // the Servoy Application Server when the table name starts with 'temp_', otherwise a server restart is needed.
notifyDataChange
(serverName, tableName, pksDataset, action)
Notify clients about changes in records, based on pk(s). Use with extreme care, its affecting the performance of clients!
Sample
/**************************************************************************** WARNING! You can cause data loss or serious data integrity compromises! You should have a THOROUGH understanding of both SQL and your backend database (and other interfaces that may use that backend) BEFORE YOU USE ANY OF THESE COMMANDS. You should also READ THE DOCUMENTATION BEFORE USING ANY OF THESE COMMANDS Note that when server names have been switched (databasemanager.switchServer),the real server names must be used here, plugins.rawSQL is not transparent to switched servers. ****************************************************************************/ var action = SQL_ACTION_TYPES.DELETE_ACTION //pks deleted //var action = SQL_ACTION_TYPES.INSERT_ACTION //pks inserted //var action = SQL_ACTION_TYPES.UPDATE_ACTION //pks updates var pksdataset = databaseManager.convertToDataSet(new Array(12,15,16,21)) var ok = plugins.rawSQL.notifyDataChange(databaseManager.getDataSourceServerName(controller.getDataSource()), 'employees', pksdataset,action)