org.apache.paimon.spark.procedure

Interface Procedure

All Known Implementing Classes:

CompactManifestProcedure, CompactProcedure, CreateBranchProcedure, CreateOrReplaceTagBaseProcedure, CreateTagFromTimestampProcedure, CreateTagProcedure, DeleteBranchProcedure, DeleteTagProcedure, ExpirePartitionsProcedure, ExpireSnapshotsProcedure, ExpireTagsProcedure, FastForwardProcedure, MarkPartitionDoneProcedure, MigrateDatabaseProcedure, MigrateFileProcedure, MigrateTableProcedure, RefreshObjectTableProcedure, RemoveOrphanFilesProcedure, RenameTagProcedure, RepairProcedure, ReplaceTagProcedure, ResetConsumerProcedure, RollbackProcedure, RollbackToTimestampProcedure

public interface Procedure

An interface that defines an executable stored procedure.

Method Summary

Modifier and Type	Method and Description
org.apache.spark.sql.catalyst.InternalRow[]	call(org.apache.spark.sql.catalyst.InternalRow args) Executes the given stored procedure.
default String	description() Returns the description of stored procedure.
org.apache.spark.sql.types.StructType	outputType() Returns the type of rows produced by stored procedure.
ProcedureParameter[]	parameters() Returns the input parameters of stored procedure.

Method Detail

parameters

ProcedureParameter[] parameters()

Returns the input parameters of stored procedure.

outputType

org.apache.spark.sql.types.StructType outputType()

Returns the type of rows produced by stored procedure.

call

org.apache.spark.sql.catalyst.InternalRow[] call(org.apache.spark.sql.catalyst.InternalRow args)

Executes the given stored procedure.

Parameters:

args - Input arguments.

Returns:

The result of executing stored procedure with the given arguments.

description

default String description()

Returns the description of stored procedure.