Interface Procedure

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.apache.spark.sql.catalyst.InternalRow[] call​(org.apache.spark.sql.catalyst.InternalRow args)
      Executes this procedure.
      default java.lang.String description()
      Returns the description of this procedure.
      org.apache.spark.sql.types.StructType outputType()
      Returns the type of rows produced by this procedure.
      ProcedureParameter[] parameters()
      Returns the input parameters of this procedure.
    • Method Detail

      • parameters

        ProcedureParameter[] parameters()
        Returns the input parameters of this procedure.
      • outputType

        org.apache.spark.sql.types.StructType outputType()
        Returns the type of rows produced by this procedure.
      • call

        org.apache.spark.sql.catalyst.InternalRow[] call​(org.apache.spark.sql.catalyst.InternalRow args)
        Executes this procedure.

        Spark will align the provided arguments according to the input parameters defined in parameters() either by position or by name before execution.

        Implementations may provide a summary of execution by returning one or many rows as a result. The schema of output rows must match the defined output type in outputType().

        Parameters:
        args - input arguments
        Returns:
        the result of executing this procedure with the given arguments
      • description

        default java.lang.String description()
        Returns the description of this procedure.