org.apache.paimon.flink.procedure

Class PurgeFilesProcedure

java.lang.Object

org.apache.paimon.flink.procedure.ProcedureBase

org.apache.paimon.flink.procedure.PurgeFilesProcedure

All Implemented Interfaces:

org.apache.flink.table.procedures.Procedure, Factory

public class PurgeFilesProcedure
extends ProcedureBase

A procedure to purge files for a table. Usage:

  -- rollback to the snapshot which earlier or equal than watermark.
  CALL sys.purge_files(`table` => 'tableId')
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDENTIFIER

Fields inherited from class org.apache.paimon.flink.procedure.ProcedureBase

catalog

Constructor Summary

Constructors

Constructor and Description
PurgeFilesProcedure()

Method Summary

Modifier and Type	Method and Description
org.apache.flink.types.Row[]	call(org.apache.flink.table.procedure.ProcedureContext procedureContext, String tableId)
String	identifier() Returns a unique identifier among same factory interfaces.

Methods inherited from class org.apache.paimon.flink.procedure.ProcedureBase

execute, execute, execute, notnull, nullable, optionalConfigMap, table, withCatalog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDENTIFIER

public static final String IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

PurgeFilesProcedure

public PurgeFilesProcedure()

Method Detail

call

public org.apache.flink.types.Row[] call(org.apache.flink.table.procedure.ProcedureContext procedureContext,
                                         String tableId)
                                  throws Exception

Throws:

Exception

identifier

public String identifier()

Description copied from interface: Factory

Returns a unique identifier among same factory interfaces.

For consistency, an identifier should be declared as one lower case word (e.g. kafka). If multiple factories exist for different versions, a version should be appended using "-" (e.g. elasticsearch-7).