org.apache.paimon.flink.procedure

Class ClearConsumersProcedure

java.lang.Object

org.apache.paimon.flink.procedure.ProcedureBase

org.apache.paimon.flink.procedure.ClearConsumersProcedure

All Implemented Interfaces:

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

public class ClearConsumersProcedure
extends ProcedureBase

Clear consumers procedure. Usage:

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

  -- clear all consumers in the table
  CALL sys.clear_consumers('tableId')

 -- clear some consumers in the table (accept regular expression)
  CALL sys.clear_consumers('tableId', 'includingConsumers')

 -- exclude some consumers (accept regular expression)
  CALL sys.clear_consumers('tableId', 'includingConsumers', 'excludingConsumers')
 

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

Method Summary

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

ClearConsumersProcedure

public ClearConsumersProcedure()

Method Detail

call

public String[] call(org.apache.flink.table.procedure.ProcedureContext procedureContext,
                     String tableId,
                     String includingConsumers,
                     String excludingConsumers)
              throws Catalog.TableNotExistException

Throws:

Catalog.TableNotExistException

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).