Package org.apache.spark.sql.connector.catalog.procedures

Interface BoundProcedure

All Superinterfaces:
Procedure
@Evolving public interface BoundProcedure extends Procedure
A procedure that is bound to input types.
Since:
4.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterator<Scan>
    call(org.apache.spark.sql.catalyst.InternalRow input)
    Executes this procedure with the given input.
    boolean
    isDeterministic()
    Indicates whether this procedure is deterministic.
    ProcedureParameter[]
    parameters()
    Returns parameters of this procedure.

    Methods inherited from interface org.apache.spark.sql.connector.catalog.procedures.Procedure

    description, name

  • Method Details

    • parameters

      ProcedureParameter[] parameters()
      Returns parameters of this procedure.

    • isDeterministic

      boolean isDeterministic()
      Indicates whether this procedure is deterministic.

    • call

      Iterator<Scan> call(org.apache.spark.sql.catalyst.InternalRow input)
      Executes this procedure with the given input.

      Spark validates and rearranges arguments provided in the CALL statement to ensure that the order and data types of the fields in input matches the expected order and types defined by parameters.

      Each procedure can return any number of result sets. Each result set is represented by a scan that reports the type of records it produces and can be used to collect the output, if needed. If a result set is local and does not a distributed job, implementations should use LocalScan.