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

Interface ProcedureParameter

public interface ProcedureParameter
An input parameter of a stored procedure.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.spark.sql.types.DataType
    dataType()
    Returns the type of this parameter.
    String
    name()
    Returns the name of this parameter.
    static ProcedureParameter
    optional(String name, org.apache.spark.sql.types.DataType dataType)
    Creates an optional input parameter.
    boolean
    required()
    Returns true if this parameter is required.
    static ProcedureParameter
    required(String name, org.apache.spark.sql.types.DataType dataType)
    Creates a required input parameter.

  • Method Details

    • required

      static ProcedureParameter required(String name, org.apache.spark.sql.types.DataType dataType)
      Creates a required input parameter.
      Parameters:
      name - the name of the parameter
      dataType - the type of the parameter
      Returns:
      the constructed stored procedure parameter

    • optional

      static ProcedureParameter optional(String name, org.apache.spark.sql.types.DataType dataType)
      Creates an optional input parameter.
      Parameters:
      name - the name of the parameter.
      dataType - the type of the parameter.
      Returns:
      the constructed optional stored procedure parameter

    • name

      String name()
      Returns the name of this parameter.

    • dataType

      org.apache.spark.sql.types.DataType dataType()
      Returns the type of this parameter.

    • required

      boolean required()
      Returns true if this parameter is required.