Package com.denodo.vdb.engine.storedprocedure

Interface StoredProcedureExecutor

All Known Subinterfaces:
StoredProcedure
All Known Implementing Classes:
AbstractStoredProcedure
public interface StoredProcedureExecutor
This interface defines the methods used to invoke a stored procedure and obtain its results.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LOG_DEBUG
    'Debug' log level
    static final int
    LOG_ERROR
    'Error' log level
    static final int
    LOG_FATAL
    'Fatal' log level
    static final int
    LOG_INFO
    'Info' log level
    static final int
    LOG_TRACE
    'Trace' log level
    static final int
    LOG_WARN
    'Warn' log level

  • Method Summary

    Modifier and Type
    Method
    Description
    StoredProcedureResultSet
    call(String accessName, Object[] inputValues, com.denodo.vdb.misc.IContext context)
    Method which executes the stored procedure.
    void
    close()
    Deprecated.
    This method will be removed in future versions because it is not used.
    int
    getNumOfAffectedRows()
    Obtains the number of rows in the database which have been written, deleted or modified.
    StoredProcedureParameter[]
    getParameters()
    Obtains the stored procedure parameter description.
    StoredProcedureResultSet
    getProcedureResultSet()
    Obtains the execution result of the stored procedure.

  • Field Details

  • Method Details

    • close

      @Deprecated void close()
      Deprecated.
      This method will be removed in future versions because it is not used.
      Releases the stored procedure resources.

    • getNumOfAffectedRows

      int getNumOfAffectedRows()
      Obtains the number of rows in the database which have been written, deleted or modified.
      Returns:
      the number of rows in the database which have been written, deleted or modified.

    • getProcedureResultSet

      StoredProcedureResultSet getProcedureResultSet()
      Obtains the execution result of the stored procedure. This method is used to add results to the stored procedure.
      Returns:
      the execution result of the stored procedure.

    • getParameters

      StoredProcedureParameter[] getParameters()
      Obtains the stored procedure parameter description. This method is invoked once every time the procedure is invoked.
      It has to return an array with the input and output parameters of the stored procedure. Each parameter is represented with a StoredProcedureParameter object. A StoredProcedureParameter object specifies the name, type, direction (input and/or output) and “nullability” of a parameter (if the parameter accepts a null as value or not).
      If a parameter is a compound type, an array of StoredProcedureParameter objects must be specified to describe its fields.
      Returns:
      array with the stored procedure parameters. This method cannot return null. If the procedure does not have input nor output parameters, it has to return an empty array.

    • call

      StoredProcedureResultSet call(String accessName, Object[] inputValues, com.denodo.vdb.misc.IContext context) throws StoredProcedureException
      Method which executes the stored procedure.
      Parameters:
      accessName - the name of the procedure access.
      inputValues - the input parameters of the procedure.
      context - the execution context.
      Returns:
      the result of the stored procedure execution.
      Throws:
      StoredProcedureException - if there is some error executing the procedure.