org.apache.paimon.flink.procedure

Class CompactDatabaseProcedure

java.lang.Object

org.apache.paimon.flink.procedure.ProcedureBase

org.apache.paimon.flink.procedure.CompactDatabaseProcedure

All Implemented Interfaces:

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

public class CompactDatabaseProcedure
extends ProcedureBase

Compact database procedure. Usage:

  -- NOTE: use '' as placeholder for optional arguments

  -- compact all databases
  CALL sys.compact_database()

  -- compact some databases (accept regular expression)
  CALL sys.compact_database('includingDatabases')

  -- set compact mode
  CALL sys.compact_database('includingDatabases', 'mode')

  -- compact some tables (accept regular expression)
  CALL sys.compact_database('includingDatabases', 'mode', 'includingTables')

  -- exclude some tables (accept regular expression)
  CALL sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables')

  -- set table options ('k=v,...')
  CALL sys.compact_database('includingDatabases', 'mode', 'includingTables', 'excludingTables', 'tableOptions')
 

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

Method Summary

Modifier and Type	Method and Description
String[]	call(org.apache.flink.table.procedure.ProcedureContext procedureContext, String includingDatabases, String mode, String includingTables, String excludingTables, String tableOptions, String partitionIdleTime, String compactStrategy)
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

CompactDatabaseProcedure

public CompactDatabaseProcedure()

Method Detail

call

public String[] call(org.apache.flink.table.procedure.ProcedureContext procedureContext,
                     String includingDatabases,
                     String mode,
                     String includingTables,
                     String excludingTables,
                     String tableOptions,
                     String partitionIdleTime,
                     String compactStrategy)
              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).