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

Interface ProcedureParameter

@Evolving public interface ProcedureParameter
A procedure parameter.
Since:
4.0.0

  • Field Details

    • BY_NAME_METADATA_KEY

      static final String BY_NAME_METADATA_KEY
      A field metadata key that indicates whether an argument is passed by name.
      See Also:

  • Method Details

    • in

      static ProcedureParameter.Builder in(String name, DataType dataType)
      Creates a builder for an IN procedure parameter.
      Parameters:
      name - the name of the parameter
      dataType - the type of the parameter
      Returns:
      the constructed stored procedure parameter

    • mode

      ProcedureParameter.Mode mode()
      Returns the mode of this parameter.

    • name

      String name()
      Returns the name of this parameter.

    • dataType

      DataType dataType()
      Returns the data type of this parameter.

    • defaultValue

      @Nullable DefaultValue defaultValue()
      Returns the SQL string (Spark SQL dialect) of the default value expression of this parameter or null if not provided.

    • comment

      @Nullable String comment()
      Returns the comment of this parameter or null if not provided.