org.apache.paimon.flink.action

Class MergeIntoAction

java.lang.Object

org.apache.paimon.flink.action.ActionBase

org.apache.paimon.flink.action.TableActionBase

org.apache.paimon.flink.action.MergeIntoAction

All Implemented Interfaces:

Action

public class MergeIntoAction
extends TableActionBase

Flink action for 'MERGE INTO', which references the syntax as follows (we use 'upsert' semantics instead of 'update'):

  MERGE INTO target-table
  USING source-table | source-expr AS source-alias
  ON merge-condition
  WHEN MATCHED [AND matched-condition]
    THEN UPDATE SET xxx
  WHEN MATCHED [AND matched-condition]
    THEN DELETE
  WHEN NOT MATCHED [AND not-matched-condition]
    THEN INSERT VALUES (xxx)
  WHEN NOT MATCHED BY SOURCE [AND not-matched-by-source-condition]
    THEN UPDATE SET xxx
  WHEN NOT MATCHED BY SOURCE [AND not-matched-by-source-condition]
    THEN DELETE
 

It builds a query to find the rows to be changed. INNER JOIN with merge-condition is used to find MATCHED rows, and NOT EXISTS with merge-condition is used to find NOT MATCHED rows, then the condition of each action is used to filter the rows.

Field Summary

Fields inherited from class org.apache.paimon.flink.action.TableActionBase

identifier, table

Fields inherited from class org.apache.paimon.flink.action.ActionBase

batchTEnv, catalog, catalogName, catalogOptions, env, flinkCatalog

Constructor Summary

Constructors

Constructor and Description
MergeIntoAction(String warehouse, String database, String tableName)
MergeIntoAction(String warehouse, String database, String tableName, Map<String,String> catalogConfig)

Method Summary

Modifier and Type	Method and Description
org.apache.flink.streaming.api.datastream.DataStream<org.apache.flink.table.data.RowData>	buildDataStream()
void	run() The execution method of the action.
void	validate()
MergeIntoAction	withMatchedDelete(String matchedDeleteCondition)
MergeIntoAction	withMatchedUpsert(String matchedUpsertCondition, String matchedUpsertSet)
MergeIntoAction	withMergeCondition(String mergeCondition)
MergeIntoAction	withNotMatchedBySourceDelete(String notMatchedBySourceDeleteCondition)
MergeIntoAction	withNotMatchedBySourceUpsert(String notMatchedBySourceUpsertCondition, String notMatchedBySourceUpsertSet)
MergeIntoAction	withNotMatchedInsert(String notMatchedInsertCondition, String notMatchedInsertValues)
MergeIntoAction	withSourceSqls(String... sourceSqls)
MergeIntoAction	withSourceTable(String sourceTable)
MergeIntoAction	withTargetAlias(String targetAlias)

Methods inherited from class org.apache.paimon.flink.action.TableActionBase

batchSink

Methods inherited from class org.apache.paimon.flink.action.ActionBase

catalogConfig, catalogLoader, compatibleCheck, execute, initFlinkCatalog, initFlinkEnv, initPaimonCatalog, toPaimonTypes, withStreamExecutionEnvironment

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.flink.action.Action

build

Constructor Detail

MergeIntoAction

public MergeIntoAction(String warehouse,
                       String database,
                       String tableName)

MergeIntoAction

public MergeIntoAction(String warehouse,
                       String database,
                       String tableName,
                       Map<String,String> catalogConfig)

Method Detail

withTargetAlias

public MergeIntoAction withTargetAlias(String targetAlias)

withSourceTable

public MergeIntoAction withSourceTable(String sourceTable)

withSourceSqls

public MergeIntoAction withSourceSqls(String... sourceSqls)

withMergeCondition

public MergeIntoAction withMergeCondition(String mergeCondition)

withMatchedUpsert

public MergeIntoAction withMatchedUpsert(@Nullable
                                         String matchedUpsertCondition,
                                         String matchedUpsertSet)

withNotMatchedBySourceUpsert

public MergeIntoAction withNotMatchedBySourceUpsert(@Nullable
                                                    String notMatchedBySourceUpsertCondition,
                                                    String notMatchedBySourceUpsertSet)

withMatchedDelete

public MergeIntoAction withMatchedDelete(@Nullable
                                         String matchedDeleteCondition)

withNotMatchedBySourceDelete

public MergeIntoAction withNotMatchedBySourceDelete(@Nullable
                                                    String notMatchedBySourceDeleteCondition)

withNotMatchedInsert

public MergeIntoAction withNotMatchedInsert(@Nullable
                                            String notMatchedInsertCondition,
                                            String notMatchedInsertValues)

validate

public void validate()

run

public void run()
         throws Exception

Description copied from interface: Action

The execution method of the action.

Throws:

Exception

buildDataStream

public org.apache.flink.streaming.api.datastream.DataStream<org.apache.flink.table.data.RowData> buildDataStream()