FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | FIELD | ACTION | DETAIL: IMPORT | CONSTANT | FIELD | ACTION |
Action summary | |
---|---|
void |
close(boolean doStopAll) Close the database. Setting doStopAll to true will cancel the current and all outstanding operations. |
void |
doSQLCmd(string cmdString) Execute a SQL command that does not return results. |
void |
doSQLCmdAck(string cmdString, integer ackNum, boolean onError) Execute an SQL command that does not return results and receive a DBAcknowledge event to indicate success or failure. |
void |
doSQLCmdOnError(string cmdString) Execute an SQL command that does not return results unless the previous operation (SQLCmd, SQLQuery, or SQLCommit) failed. |
void |
doSQLCommit() Commit changes to database. |
void |
doSQLCommitAck(integer ackNum) Commit changes to database and receive a DBAcknowledge event to indicate success or failure. |
void |
doSQLEventQuery(string queryString, string eventType) Execute an SQL query that returns events. |
void |
doSQLEventQueryAck(string queryString, string eventType, integer ackNum, boolean onError) Execute a SQL query that returns events and receive a DBAcknowledge event to indicate success or failure. |
void |
doSQLEventQueryOnError(string queryString, string eventType) Execute a SQL query that returns events but only if the previous operation (SQLCmd, SQLQuery, SQLEventQuery, or SQLCommit) failed. |
void |
doSQLEventQueryWithCallback(string queryString, string eventType, action<string, integer> handleDone) Execute a SQL query that returns events and runs the specified action when the query completes. The handleDone action parameters are : string error - Will be empty on success else the error message integer count - Number of rows returned by the query. |
void |
doSQLQuery(string queryString, action<dictionary<string, string>> handleResult) Execute a SQL query that returns results. |
void |
doSQLQueryAck(string queryString, action<dictionary<string, string>> handleResult, integer ackNum, boolean onError) Execute a SQL query that returns results and receive a DBAcknowledge event to indicate success or failure. |
void |
doSQLQueryOnError(string queryString, action<dictionary<string, string>> handleResult) Execute an SQL query that returns results but only if the previous operation (SQLCmd, SQLQuery, or SQLCommit) failed. |
void |
doSQLQueryWithCallback(string queryString, action<dictionary<string, string>> handleResult, action<string, integer> handleDone) Execute a SQL query that returns results and runs the specified action when the query completes. The handleDone action parameters are : string error - Will be empty on success else the error message integer count - Number of rows returned by the query. |
void |
doSQLRollback() Rollback uncommitted changes to database. |
void |
doSQLRollbackAck(integer ackNum, boolean onError) Rollback uncommitted changes to database and receive a DBAcknowledge event to indicate success or failure. |
void |
doSQLRollbackOnError() Rollback uncommitted changes to database but only if the previous operation (SQLCmd, SQLQuery, or SQLCommit) failed. |
sequence<string> |
getSchemaFieldOrder() Get the current schemas field order associated with the current result. |
dictionary<string, string> |
getSchemaFieldTypes() Get the current schemas field types associated with the current result. |
sequence<string> |
getSchemaIndexFields() Get the current schemas index field associated with the current result. |
void |
handleDoneDefault(string error, integer count) Callback action to handle the completion of a query. Called after entire ResultSet is returned. |
void |
handleResultsDefault(dictionary<string, string> r) Callback action to handle a ResultEvent from a query. Called for each ResultEvent (row) returned. |
boolean |
isOpen() Test if the connection is open (or in the process of opening). |
void |
onConcludeRecovery() OnConcludeRecovery is called after the recovery process has been completed, including all non persistent monitors having being re-loaded. |
void |
open(string type, string serviceId, string URL, string user, string password, string autoCommit, boolean readOnly, integer batchSize, float timeOut, action<string> errorHandler) Open that allows for specifying the serviceId, as well as autoCommit, batchSize, and the timeOut for waiting for adapter. |
void |
openQuickJDBC(string URL, string user, string password, action<string> handleError) Quick open operation for JDBC. Uses default batch size, auto commit, etc. |
void |
openQuickODBC(string URL, string user, string password, action<string> handleError) Quick open operation for ODBC. Uses default batch size, auto commit, etc. |
void |
openShared(string type, string serviceId, string URL, string user, string password, string autoCommit, boolean readOnly, integer batchSize, float timeOut, action<string> errorHandler) Open that uses an already open existing matching connection if available or will open a new one. Allows for specifying the serviceId, as well as autoCommit, batchSize, and the timeOut for waiting for adapter. |
void |
setAdapterInstanceName(string instanceName) Set the adapter instance name for use with the openQuick actions. setAdapterInstanceName should always be called to set the instance name. |
void |
setLogQueries(boolean logQueries) Enable (or disable) the logging of all operations (SQLQuery, SQLCmd and SQLCommit). The default setting is disabled (false). |
void |
setPrespawnContext(context ctx) Set context that is current prior to spawning. Optional: Only needed when using parallel processing. |
void |
setReconnectOverrideTimeout(float timeOut) Set the timout for the reconnection after a conection error. The default value is set by the open action to be twice as long as its timeOut parameter. |
void |
setReconnectPolicy(string reconnectPolicy) Set the policy for the dealing with adapter connection errors. |
void |
setReconnectTimeout(float timeOut) Set the timout for the reconnection after a conection error. The default value is set by the open action to be twice as long as its timeOut parameter. |
void |
shutdownConnectionOnError() Shutdown the connection when there is an error. |
void |
stopAll() Stop all operations. This also cancels all outstanding queries in the queue. |
void |
subscribeStatus() Subscribe to the status information from all ADBC adapters. |
Action detail |
---|
void close(boolean doStopAll)Close the database. Setting doStopAll to true will cancel the current and all outstanding operations.
void doSQLCmd(string cmdString)Execute a SQL command that does not return results.
void doSQLCmdAck(string cmdString, integer ackNum, boolean onError)Execute an SQL command that does not return results and receive a DBAcknowledge event to indicate success or failure.
void doSQLCmdOnError(string cmdString)Execute an SQL command that does not return results unless the previous operation (SQLCmd, SQLQuery, or SQLCommit) failed.
void doSQLCommit()Commit changes to database.
void doSQLCommitAck(integer ackNum)Commit changes to database and receive a DBAcknowledge event to indicate success or failure.
void doSQLEventQuery(string queryString, string eventType)Execute an SQL query that returns events.
void doSQLEventQueryAck(string queryString, string eventType, integer ackNum, boolean onError)Execute a SQL query that returns events and receive a DBAcknowledge event to indicate success or failure.
void doSQLEventQueryOnError(string queryString, string eventType)Execute a SQL query that returns events but only if the previous operation (SQLCmd, SQLQuery, SQLEventQuery, or SQLCommit) failed.
void doSQLEventQueryWithCallback(string queryString, string eventType, action<string, integer> handleDone)Execute a SQL query that returns events and runs the specified action when the query completes. The handleDone action parameters are : string error - Will be empty on success else the error message integer count - Number of rows returned by the query.
void doSQLQuery(string queryString, action<dictionary<string, string>> handleResult)Execute a SQL query that returns results.
void doSQLQueryAck(string queryString, action<dictionary<string, string>> handleResult, integer ackNum, boolean onError)Execute a SQL query that returns results and receive a DBAcknowledge event to indicate success or failure.
void doSQLQueryOnError(string queryString, action<dictionary<string, string>> handleResult)Execute an SQL query that returns results but only if the previous operation (SQLCmd, SQLQuery, or SQLCommit) failed.
void doSQLQueryWithCallback(string queryString, action<dictionary<string, string>> handleResult, action<string, integer> handleDone)Execute a SQL query that returns results and runs the specified action when the query completes. The handleDone action parameters are : string error - Will be empty on success else the error message integer count - Number of rows returned by the query.
void doSQLRollback()Rollback uncommitted changes to database.
void doSQLRollbackAck(integer ackNum, boolean onError)Rollback uncommitted changes to database and receive a DBAcknowledge event to indicate success or failure.
void doSQLRollbackOnError()Rollback uncommitted changes to database but only if the previous operation (SQLCmd, SQLQuery, or SQLCommit) failed.
sequence<string> getSchemaFieldOrder()Get the current schemas field order associated with the current result.
dictionary<string, string> getSchemaFieldTypes()Get the current schemas field types associated with the current result.
sequence<string> getSchemaIndexFields()Get the current schemas index field associated with the current result.
void handleDoneDefault(string error, integer count)Callback action to handle the completion of a query. Called after entire ResultSet is returned.
void handleResultsDefault(dictionary<string, string> r)Callback action to handle a ResultEvent from a query. Called for each ResultEvent (row) returned.
boolean isOpen()Test if the connection is open (or in the process of opening).
void onConcludeRecovery()OnConcludeRecovery is called after the recovery process has been completed, including all non persistent monitors having being re-loaded.
void open(string type, string serviceId, string URL, string user, string password, string autoCommit, boolean readOnly, integer batchSize, float timeOut, action<string> errorHandler)Open that allows for specifying the serviceId, as well as autoCommit, batchSize, and the timeOut for waiting for adapter.
default - Use setting from config file.
false - Disable auto-commit.
x.x - Value (seconds) for ADBC adapter timed auto-commit.
true - Enable data source specific auto-commit.
void openQuickJDBC(string URL, string user, string password, action<string> handleError)Quick open operation for JDBC. Uses default batch size, auto commit, etc.
void openQuickODBC(string URL, string user, string password, action<string> handleError)Quick open operation for ODBC. Uses default batch size, auto commit, etc.
void openShared(string type, string serviceId, string URL, string user, string password, string autoCommit, boolean readOnly, integer batchSize, float timeOut, action<string> errorHandler)Open that uses an already open existing matching connection if available or will open a new one. Allows for specifying the serviceId, as well as autoCommit, batchSize, and the timeOut for waiting for adapter.
default - Use setting from config file.
false - Disable auto-commit.
x.x - Value (seconds) for ADBC adapter timed auto-commit.
true - Enable data source specific auto-commit.
void setAdapterInstanceName(string instanceName)Set the adapter instance name for use with the openQuick actions. setAdapterInstanceName should always be called to set the instance name.
void setLogQueries(boolean logQueries)Enable (or disable) the logging of all operations (SQLQuery, SQLCmd and SQLCommit). The default setting is disabled (false).
void setPrespawnContext(context ctx)Set context that is current prior to spawning. Optional: Only needed when using parallel processing.
void setReconnectOverrideTimeout(float timeOut)Set the timout for the reconnection after a conection error. The default value is set by the open action to be twice as long as its timeOut parameter.
void setReconnectPolicy(string reconnectPolicy)Set the policy for the dealing with adapter connection errors.
void setReconnectTimeout(float timeOut)Set the timout for the reconnection after a conection error. The default value is set by the open action to be twice as long as its timeOut parameter.
void shutdownConnectionOnError()Shutdown the connection when there is an error.
void stopAll()Stop all operations. This also cancels all outstanding queries in the queue.
void subscribeStatus()Subscribe to the status information from all ADBC adapters.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | FIELD | ACTION | DETAIL: IMPORT | CONSTANT | FIELD | ACTION |