Package com.denodo.vdb.engine.storedprocedure

Interface StoredProcedurePlan

public interface StoredProcedurePlan
This interface defines the methods used to obtain information about the execution of a stored procedure.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ERROR
    The stored procedure execution threw an error
    static final int
    INIT
    The stored procedure execution has not started yet
    static final int
    OK
    The stored procedure execution has finished successfully
    static final int
    PROCESSING
    The stored procedure execution is being executed at this time
    static final int
    STOPPED
    The stored procedure execution has been stopped

  • Method Summary

    Modifier and Type
    Method
    Description
    Date
    getEndTime()
    Obtains the time when the procedure finished its execution.
    Throwable
    getException()
    Obtains the exception associated with the error occurred in the execution.
    int
    getNumOfTuples()
    Obtains the number of tuples returned by the procedure.
    Date
    getResponseTime()
    Obtains the time when the procedure generated its first row of results.
    Date
    getStartTime()
    Obtains the time when the procedure started its execution.
    int
    getState()
    Obtains the state of the procedure execution.
    boolean
    isComplete()
    Returns whether the procedure finished successfully its execution or not.

  • Field Details

    • OK

      static final int OK
      The stored procedure execution has finished successfully
      See Also:

    • ERROR

      static final int ERROR
      The stored procedure execution threw an error
      See Also:

    • INIT

      static final int INIT
      The stored procedure execution has not started yet
      See Also:

    • PROCESSING

      static final int PROCESSING
      The stored procedure execution is being executed at this time
      See Also:

    • STOPPED

      static final int STOPPED
      The stored procedure execution has been stopped
      See Also:

  • Method Details

    • getEndTime

      Date getEndTime()
      Obtains the time when the procedure finished its execution.
      Returns:
      the time when the procedure finished its execution.

    • getNumOfTuples

      int getNumOfTuples()
      Obtains the number of tuples returned by the procedure.
      Returns:
      the number of tuples returned by the procedure.

    • getResponseTime

      Date getResponseTime()
      Obtains the time when the procedure generated its first row of results.
      Returns:
      the time when the procedure generated its first row of results.

    • getStartTime

      Date getStartTime()
      Obtains the time when the procedure started its execution.
      Returns:
      the time when the procedure started its execution.

    • getState

      int getState()
      Obtains the state of the procedure execution.
      Returns:
      an integer representing the procedure state.

    • getException

      Throwable getException()
      Obtains the exception associated with the error occurred in the execution.
      Returns:
      the exception associated with the error occurred in the execution.

    • isComplete

      boolean isComplete()
      Returns whether the procedure finished successfully its execution or not.
      Returns:
      true if the procedure finished successfully, false otherwise.