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

Interface ProcedureParameter

@Evolving
public interface ProcedureParameter

A procedure parameter.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcedureParameter.Builder
static enum	ProcedureParameter.Mode	An enum representing procedure parameter modes.

Method Summary

Modifier and Type	Method	Description
String	comment()	Returns the comment of this parameter or null if not provided.
DataType	dataType()	Returns the data type of this parameter.
String	defaultValueExpression()	Returns the SQL string (Spark SQL dialect) of the default value expression of this parameter or null if not provided.
static ProcedureParameter.Builder	in(String name, DataType dataType)	Creates a builder for an IN procedure parameter.
ProcedureParameter.Mode	mode()	Returns the mode of this parameter.
String	name()	Returns the name of this parameter.

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.

defaultValueExpression

@Nullable
String defaultValueExpression()

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.