Interface Prepare.PreparedResult

All Known Implementing Classes:
Prepare.PreparedExplain, Prepare.PreparedResultImpl
Enclosing class:
Prepare

public static interface Prepare.PreparedResult
  • Method Summary

    Modifier and Type
    Method
    Description
    getBindable(org.apache.calcite.avatica.Meta.CursorFactory cursorFactory)
    Executes the prepared result.
    Returns the code generated by preparation.
    List<? extends @Nullable List<String>>
    Returns a list describing, for each result field, the origin of the field as a 4-element list of (database, schema, table, column).
    Returns a record type whose fields are the parameters of this statement.
    Returns the table modification operation corresponding to this statement if it is a table modification statement; otherwise null.
    boolean
    Returns whether this result is for a DML statement, in which case the result set is one row with one column containing the number of rows affected.
  • Method Details

    • getCode

      String getCode()
      Returns the code generated by preparation.
    • isDml

      boolean isDml()
      Returns whether this result is for a DML statement, in which case the result set is one row with one column containing the number of rows affected.
    • getTableModOp

      @Nullable TableModify.Operation getTableModOp()
      Returns the table modification operation corresponding to this statement if it is a table modification statement; otherwise null.
    • getFieldOrigins

      List<? extends @Nullable List<String>> getFieldOrigins()
      Returns a list describing, for each result field, the origin of the field as a 4-element list of (database, schema, table, column).
    • getParameterRowType

      RelDataType getParameterRowType()
      Returns a record type whose fields are the parameters of this statement.
    • getBindable

      Bindable getBindable(org.apache.calcite.avatica.Meta.CursorFactory cursorFactory)
      Executes the prepared result.
      Parameters:
      cursorFactory - How to map values into a cursor
      Returns:
      producer of rows resulting from execution