org.apache.paimon.flink.procedure

Class MergeIntoProcedure

java.lang.Object

org.apache.paimon.flink.procedure.ProcedureBase

org.apache.paimon.flink.procedure.MergeIntoProcedure

All Implemented Interfaces:

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

public class MergeIntoProcedure
extends ProcedureBase

Merge Into procedure. Usage:

  -- NOTE: use '' as placeholder for optional arguments
  -- IMPORTANT: Use 'TRUE' if you want to delete data without filter condition.
  -- If matchedDeleteCondition='', it will ignore matched-delete action!
  CALL sys.merge_into(
      'targetTableId',
      'targetAlias',
      'sourceSqls',
      'sourceTable',
      'mergeCondition',
      'matchedUpsertCondition',
      'matchedUpsertSetting',
      'notMatchedInsertCondition',
      'notMatchedInsertValues',
      'matchedDeleteCondition'
  )
 

This procedure will be forced to use batch environments. Compared to MergeIntoAction, this procedure doesn't provide arguments to control not-matched-by-source behavior because they are not commonly used and will make the methods too complex to use.

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

Method Summary

Modifier and Type	Method and Description
String[]	call(org.apache.flink.table.procedure.ProcedureContext procedureContext, String targetTableId, String targetAlias, String sourceSqls, String sourceTable, String mergeCondition, String matchedUpsertCondition, String matchedUpsertSetting, String notMatchedInsertCondition, String notMatchedInsertValues, String matchedDeleteCondition, String notMatchedBySourceUpsertCondition, String notMatchedBySourceUpsertSetting, String notMatchedBySourceDeleteCondition)
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

MergeIntoProcedure

public MergeIntoProcedure()

Method Detail

call

public String[] call(org.apache.flink.table.procedure.ProcedureContext procedureContext,
                     String targetTableId,
                     String targetAlias,
                     String sourceSqls,
                     String sourceTable,
                     String mergeCondition,
                     String matchedUpsertCondition,
                     String matchedUpsertSetting,
                     String notMatchedInsertCondition,
                     String notMatchedInsertValues,
                     String matchedDeleteCondition,
                     String notMatchedBySourceUpsertCondition,
                     String notMatchedBySourceUpsertSetting,
                     String notMatchedBySourceDeleteCondition)

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