org.apache.paimon.flink.procedure

Class RemoveUnexistingFilesProcedure

java.lang.Object

org.apache.paimon.flink.procedure.ProcedureBase

org.apache.paimon.flink.procedure.RemoveUnexistingFilesProcedure

All Implemented Interfaces:

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

public class RemoveUnexistingFilesProcedure
extends ProcedureBase

Procedure to remove unexisting data files from manifest entries. See RemoveUnexistingFilesAction for detailed use cases.

  -- remove unexisting data files in table `mydb.myt`
  CALL sys.remove_unexisting_files(`table` => 'mydb.myt')

  -- only check what files will be removed, but not really remove them (dry run)
  CALL sys.remove_unexisting_files(`table` => 'mydb.myt', `dry_run` = true)
 

Note that user is on his own risk using this procedure, which may cause data loss when used outside from the use cases above.

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
RemoveUnexistingFilesProcedure()

Method Summary

Modifier and Type	Method and Description
String[]	call(org.apache.flink.table.procedure.ProcedureContext procedureContext, String tableId, Boolean dryRun, Integer parallelism)
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

RemoveUnexistingFilesProcedure

public RemoveUnexistingFilesProcedure()

Method Detail

call

public String[] call(org.apache.flink.table.procedure.ProcedureContext procedureContext,
                     String tableId,
                     @Nullable
                     Boolean dryRun,
                     @Nullable
                     Integer parallelism)
              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).