org.apache.paimon.spark.procedure

Interface ProcedureParameter

All Known Implementing Classes:

ProcedureParameterImpl

public interface ProcedureParameter

An input parameter of a stored procedure.

Method Summary

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

Method Detail

required

static ProcedureParameter required(String name,
                                   org.apache.spark.sql.types.DataType dataType)

Creates a required input parameter.

Parameters:

name - The name of input parameter.

dataType - The data type of input 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 input parameter.

dataType - The data type of input parameter.

Returns:

The constructed optional stored procedure parameter.

name

String name()

Returns the name of input parameter.

dataType

org.apache.spark.sql.types.DataType dataType()

Returns the type of input parameter.

required

boolean required()

Returns whether input parameter is required.