Visitar URL original
feat: support MERGE ... WHEN NOT MATCHED BY TARGET / BY SOURCE (#2421) by fudianchn · Pull Request #2453 · JSQLParser/JSqlParser · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat: support MERGE ... WHEN NOT MATCHED BY TARGET / BY SOURCE
BigQuery and SQL Server allow the MERGE NOT MATCHED clause to be
qualified with BY TARGET (allows INSERT) or BY SOURCE (allows
UPDATE/DELETE), e.g.:

    MERGE INTO t USING s ON ...
    WHEN NOT MATCHED BY TARGET THEN INSERT (...)
    WHEN NOT MATCHED BY SOURCE THEN DELETE

Previously JSQLParser rejected the BY TARGET/BY SOURCE qualifier as an
UnsupportedStatement (#2421).

Add an optional [BY TARGET|SOURCE] to the WHEN NOT MATCHED production,
allow INSERT/update/delete on that branch, and store the side on the
MergeInsert/MergeUpdate/MergeDelete operations via a new MergeSide enum.
Standard WHEN [NOT] MATCHED (no BY) keeps working unchanged.

TARGET/SOURCE are matched as identifiers (not reserved keywords), so
existing SQL using them as column/table names is unaffected.

Fixes #2421

Signed-off-by: 付典 <fudianchn@gmail.com>
  • Loading branch information
fudianchn committed Aug 7, 2026
commit 56147f79925c905886ec9e5cb01fee6333336a40
17 changes: 16 additions & 1 deletion src/main/java/net/sf/jsqlparser/statement/merge/MergeDelete.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

public class MergeDelete implements Serializable, MergeOperation {
private Expression andPredicate;
private MergeSide side;

public Expression getAndPredicate() {
return andPredicate;
Expand All @@ -24,11 +25,25 @@ public void setAndPredicate(Expression andPredicate) {
this.andPredicate = andPredicate;
}

public MergeSide getSide() {
return side;
}

public MergeDelete setSide(MergeSide side) {
this.side = side;
return this;
}

public MergeDelete withAndPredicate(Expression andPredicate) {
this.setAndPredicate(andPredicate);
return this;
}

public MergeDelete withSide(MergeSide side) {
this.setSide(side);
return this;
}

@Override
public <S, T> T accept(MergeOperationVisitor<T> mergeOperationVisitor, S context) {
return mergeOperationVisitor.visit(this, context);
Expand All @@ -37,7 +52,7 @@ public <S, T> T accept(MergeOperationVisitor<T> mergeOperationVisitor, S context
@Override
public String toString() {
StringBuilder b = new StringBuilder();
b.append(" WHEN MATCHED");
b.append(side == MergeSide.SOURCE ? " WHEN NOT MATCHED BY SOURCE" : " WHEN MATCHED");
if (andPredicate != null) {
b.append(" AND ").append(andPredicate.toString());
}
Expand Down
17 changes: 17 additions & 0 deletions src/main/java/net/sf/jsqlparser/statement/merge/MergeInsert.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ public class MergeInsert implements Serializable, MergeOperation {
private ExpressionList<Column> columns;
private ExpressionList<Expression> values;
private Expression whereCondition;
private MergeSide side;

public MergeSide getSide() {
return side;
}

public void setSide(MergeSide side) {
this.side = side;
}

public Expression getAndPredicate() {
return andPredicate;
Expand Down Expand Up @@ -66,6 +75,9 @@ public <S, T> T accept(MergeOperationVisitor<T> mergeOperationVisitor, S context
public String toString() {
StringBuilder b = new StringBuilder();
b.append(" WHEN NOT MATCHED");
if (side == MergeSide.TARGET) {
b.append(" BY TARGET");
}
if (andPredicate != null) {
b.append(" AND ").append(andPredicate);
}
Expand Down Expand Up @@ -122,6 +134,11 @@ public MergeInsert withWhereCondition(Expression whereCondition) {
return this;
}

public MergeInsert withSide(MergeSide side) {
this.setSide(side);
return this;
}

public <E extends Expression> E getAndPredicate(Class<E> type) {
return type.cast(getAndPredicate());
}
Expand Down
38 changes: 38 additions & 0 deletions src/main/java/net/sf/jsqlparser/statement/merge/MergeSide.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/*-
* #%L
* JSQLParser library
* %%
* Copyright (C) 2004 - 2024 JSQLParser
* %%
* Dual licensed under GNU LGPL 2.1 or Apache License 2.0
* #L%
*/
package net.sf.jsqlparser.statement.merge;

/**
* Identifies the side of a {@code MERGE ... WHEN NOT MATCHED [BY TARGET|BY SOURCE]} clause.
*
* <p>Standard SQL only knows {@code WHEN [NOT] MATCHED}; SQL Server and BigQuery additionally
* allow the NOT MATCHED clause to be qualified with {@code BY TARGET} (the default, allows
* {@code INSERT}) or {@code BY SOURCE} (allows {@code UPDATE}/{@code DELETE}).</p>
*/
public enum MergeSide {
TARGET,
SOURCE;

/**
* Parses a {@code BY TARGET}/{@code BY SOURCE} qualifier, case-insensitively.
*
* @param image the raw identifier image following {@code BY}
* @return the matching {@link MergeSide}
* @throws IllegalArgumentException if {@code image} is neither {@code TARGET} nor {@code SOURCE}
*/
public static MergeSide fromImage(String image) {
for (MergeSide value : values()) {
if (value.name().equalsIgnoreCase(image)) {
return value;
}
}
throw new IllegalArgumentException("Expected TARGET or SOURCE after BY but found: " + image);
}
}
17 changes: 16 additions & 1 deletion src/main/java/net/sf/jsqlparser/statement/merge/MergeUpdate.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ public class MergeUpdate implements Serializable, MergeOperation {
private Expression andPredicate;
private Expression whereCondition;
private Expression deleteWhereCondition;
private MergeSide side;

public MergeUpdate() {}

Expand Down Expand Up @@ -61,6 +62,15 @@ public void setDeleteWhereCondition(Expression deleteWhereCondition) {
this.deleteWhereCondition = deleteWhereCondition;
}

public MergeSide getSide() {
return side;
}

public MergeUpdate setSide(MergeSide side) {
this.side = side;
return this;
}

@Override
public <S, T> T accept(MergeOperationVisitor<T> mergeOperationVisitor, S context) {
return mergeOperationVisitor.visit(this, context);
Expand All @@ -69,7 +79,7 @@ public <S, T> T accept(MergeOperationVisitor<T> mergeOperationVisitor, S context
@Override
public String toString() {
StringBuilder b = new StringBuilder();
b.append(" WHEN MATCHED");
b.append(side == MergeSide.SOURCE ? " WHEN NOT MATCHED BY SOURCE" : " WHEN MATCHED");
if (andPredicate != null) {
b.append(" AND ").append(andPredicate.toString());
}
Expand Down Expand Up @@ -100,6 +110,11 @@ public MergeUpdate withDeleteWhereCondition(Expression deleteWhereCondition) {
return this;
}

public MergeUpdate withSide(MergeSide side) {
this.setSide(side);
return this;
}

public <E extends Expression> E getAndPredicate(Class<E> type) {
return type.cast(getAndPredicate());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public void deParse(Merge merge) {

@Override
public <S> StringBuilder visit(MergeDelete mergeDelete, S context) {
builder.append(" WHEN MATCHED");
builder.append(mergeDelete.getSide() == MergeSide.SOURCE ? " WHEN NOT MATCHED BY SOURCE" : " WHEN MATCHED");
if (mergeDelete.getAndPredicate() != null) {
builder.append(" AND ");
mergeDelete.getAndPredicate().accept(expressionDeParser, context);
Expand All @@ -82,7 +82,7 @@ public void visit(MergeDelete mergeDelete) {

@Override
public <S> StringBuilder visit(MergeUpdate mergeUpdate, S context) {
builder.append(" WHEN MATCHED");
builder.append(mergeUpdate.getSide() == MergeSide.SOURCE ? " WHEN NOT MATCHED BY SOURCE" : " WHEN MATCHED");
if (mergeUpdate.getAndPredicate() != null) {
builder.append(" AND ");
mergeUpdate.getAndPredicate().accept(expressionDeParser, context);
Expand Down Expand Up @@ -110,6 +110,9 @@ public void visit(MergeUpdate mergeUpdate) {
@Override
public <S> StringBuilder visit(MergeInsert mergeInsert, S context) {
builder.append(" WHEN NOT MATCHED");
if (mergeInsert.getSide() == MergeSide.TARGET) {
builder.append(" BY TARGET");
}
if (mergeInsert.getAndPredicate() != null) {
builder.append(" AND ");
mergeInsert.getAndPredicate().accept(expressionDeParser, context);
Expand Down
52 changes: 37 additions & 15 deletions src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt
Original file line number Diff line number Diff line change
Expand Up @@ -4225,31 +4225,53 @@ MergeOperation MergeUpdateClause(Expression predicate) : {
{ return mu; }
}

MergeOperation MergeWhenNotMatched() : {
MergeInsert MergeInsertClause(Expression predicate) : {
MergeInsert mi = new MergeInsert();
Expression predicate;
ExpressionList<Column> columns;
ExpressionList expList;
Expression condition;
}
{
<K_WHEN> <K_NOT> <K_MATCHED>
[ <K_AND> predicate = Expression() { mi.setAndPredicate(predicate); } ]
<K_THEN>
<K_INSERT>
[ "(" columns = ColumnList() ")"
{
mi.setColumns( new ParenthesedExpressionList<Column>(columns) );
}
]
<K_VALUES> "(" expList = SimpleExpressionList() ")"
<K_INSERT>
[ "(" columns = ColumnList() ")"
{
mi.setValues( new ParenthesedExpressionList(expList) );
mi.setColumns( new ParenthesedExpressionList<Column>(columns) );
}
]
<K_VALUES> "(" expList = SimpleExpressionList() ")"
{
mi.setValues( new ParenthesedExpressionList(expList) );
}

[ <K_WHERE> condition = Expression() { mi.setWhereCondition(condition); } ]

[ <K_WHERE> condition = Expression() { mi.setWhereCondition(condition); }]
{
mi.setAndPredicate(predicate);
return mi;
}
}

{ return mi; }
MergeOperation MergeWhenNotMatched() : {
MergeOperation operation;
Expression predicate = null;
MergeSide side = null;
Token sideToken;
}
{
<K_WHEN> <K_NOT> <K_MATCHED>
[ <K_BY> sideToken = <S_IDENTIFIER> {
side = MergeSide.fromImage(sideToken.image);
} ]
[ <K_AND> predicate = Expression() ]
<K_THEN>
(
operation = MergeInsertClause(predicate) { ((MergeInsert) operation).setSide(side); }
|
operation = MergeUpdateClause(predicate) { ((MergeUpdate) operation).setSide(side); }
|
operation = MergeDeleteClause(predicate) { ((MergeDelete) operation).setSide(side); }
)
{ return operation; }
}

// table names seem to allow ":" delimiters, e.g. for Informix see #1134
Expand Down
33 changes: 33 additions & 0 deletions src/test/java/net/sf/jsqlparser/statement/merge/MergeTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,39 @@ void testSnowflakeMergeStatementWithManyWhensAndDelete() throws JSQLParserExcept
assertSqlCanBeParsedAndDeparsed(sql, true);
}

@Test
void testBigQueryMergeNotMatchedByTargetAndSource() throws JSQLParserException {
// BigQuery/SQL Server allow "WHEN NOT MATCHED [BY TARGET|BY SOURCE]" (issue #2421)
String sql = "MERGE INTO target_table AS tt USING (SELECT key, field FROM source_table) AS st"
+ " ON tt.key = st.key"
+ " WHEN NOT MATCHED BY TARGET THEN INSERT (key, field) VALUES (st.key, st.field)"
+ " WHEN NOT MATCHED BY SOURCE THEN DELETE";

assertSqlCanBeParsedAndDeparsed(sql, true);

Merge merge = (Merge) CCJSqlParserUtil.parse(sql);
assertThat(merge.getOperations()).hasSize(2);
assertThat(merge.getOperations().get(0)).isInstanceOf(MergeInsert.class);
assertThat(((MergeInsert) merge.getOperations().get(0)).getSide()).isEqualTo(MergeSide.TARGET);
assertThat(merge.getOperations().get(1)).isInstanceOf(MergeDelete.class);
assertThat(((MergeDelete) merge.getOperations().get(1)).getSide()).isEqualTo(MergeSide.SOURCE);
}

@Test
void testBigQueryMergeNotMatchedBySourceUpdate() throws JSQLParserException {
// BY SOURCE allows UPDATE/DELETE with an AND search condition
String sql = "MERGE INTO t USING s ON t.id = s.id"
+ " WHEN NOT MATCHED BY SOURCE AND s.id IS NULL THEN UPDATE SET t.v = 0";

assertSqlCanBeParsedAndDeparsed(sql, true);

Merge merge = (Merge) CCJSqlParserUtil.parse(sql);
assertThat(merge.getOperations()).hasSize(1);
assertThat(merge.getOperations().get(0)).isInstanceOf(MergeUpdate.class);
assertThat(((MergeUpdate) merge.getOperations().get(0)).getSide()).isEqualTo(MergeSide.SOURCE);
assertThat(((MergeUpdate) merge.getOperations().get(0)).getAndPredicate()).isNotNull();
}

@ParameterizedTest
@MethodSource("deriveOperationsFromStandardClausesCases")
void testDeriveOperationsFromStandardClauses(List<MergeOperation> expectedOperations,
Expand Down
Loading