public interface StoredProcedure extends StoredProcedureExecutor
StoredProcedureExecutor
and provides methods to
initialize the procedure and to carry out the appropriate actions when the procedure is involved in a transaction.Modifier and Type | Method and Description |
---|---|
boolean |
caseSensitiveParameters()
Returns
true if the field names defined by the stored procedure are case sensitive. |
void |
commit()
The Execution Engine invokes this method to confirm the current transaction.
|
String |
getDescription()
Returns the description of the procedure.
It cannot return null . |
String |
getName()
Returns the name of the stored procedure.
It cannot return null . |
void |
initialize(DatabaseEnvironment environment)
Initializes the stored procedure.
|
void |
prepare()
The Execution Engine invokes this method when it is about to begin a transaction involving this procedure.
|
void |
rollback()
The Execution Engine invokes this method to undo the current transaction.
|
void |
setEnvironment(DatabaseEnvironment environment) |
boolean |
stop()
The Execution Engine invokes this method when a query involving the stored procedure is cancelled.
|
call, close, getNumOfAffectedRows, getParameters, getProcedureResultSet
String getName()
null
.String getDescription()
null
.void setEnvironment(DatabaseEnvironment environment)
environment
- An object which allows to the procedure to communicate with the Virtual DataPort server.void initialize(DatabaseEnvironment environment)
environment
- An object which allows to the procedure to communicate with the VDP server.void prepare()
void commit()
void rollback()
boolean stop()
AbstractStoredProcedure
provides a default implementation of this method that does not do anything and
only returns false
.true
, the procedure must guarantee that it will finish after this method is
invoked. If the procedure will not finish after invoking this procedure, return false
. true
if the execution of the procedure has finished. false
otherwise.boolean caseSensitiveParameters()
true
if the field names defined by the stored procedure are case sensitive. If not, they are converted to lower
case.true
if the field names defined by the stored procedure are case sensitive.
false
otherwiseCopyright © 2022 Denodo Technologies. All rights reserved.