Skip to content

Add experimental ExecuteMerge / upsert support - #39100

Open
omri-klein-semperis wants to merge 2 commits into
dotnet:mainfrom
omri-klein-semperis:feature/execute-merge-4526
Open

omri-klein-semperis wants to merge 2 commits into
dotnet:mainfrom
omri-klein-semperis:feature/execute-merge-4526

Conversation

@omri-klein-semperis

Copy link
Copy Markdown

Adds experimental (EF9107) ExecuteMerge, ExecuteMergeAsync,
ExecuteMergeReturning and ExecuteMergeReturningAsync bulk operators that
insert source rows into a target table and update rows that conflict on a
declared set of columns (an "upsert"), without going through the change
tracker or SaveChanges.

  • Core: MergeBuilder / MergeUpdateSettersBuilder / MergeInsertSettersBuilder
    for Match / WhenMatched / WhenNotMatched, plus the TranslateExecuteMerge
    hook and ExecuteMergeMatch.
  • Relational: MergeExpression / MergeColumnReferenceExpression nodes, plumbed
    through QuerySqlGenerator (VisitMerge), SqlNullabilityProcessor and the
    shaped-query compiler (including a RETURNING shaper). Base VisitMerge throws;
    providers opt in.
  • SQLite: lowers to INSERT ... ON CONFLICT ... DO UPDATE/DO NOTHING with
    optional RETURNING.

Functional tests are included for SQLite (DO NOTHING / DO UPDATE, explicit and
default inserts, RETURNING sync + async, source-key matching, computed-column
exclusion).

Part of #4526


  • I've read the guidelines for contributing
  • I've posted a comment on an issue with a detailed description of how I am planning to contribute and got approval from a member of the team
  • The code builds and tests pass locally
  • Commit messages follow the required format
  • Tests for the changes have been added
  • Code follows the same patterns and style as existing code in this repo

Introduces ExecuteMerge, ExecuteMergeAsync, ExecuteMergeReturning and
ExecuteMergeReturningAsync as experimental (EF9107) bulk operators that
insert source rows into a target table and update rows that conflict on a
declared set of columns (an "upsert"), without going through the change
tracker or SaveChanges.

Core:
- MergeBuilder / MergeUpdateSettersBuilder / MergeInsertSettersBuilder for
  configuring Match, WhenMatched and WhenNotMatched clauses.
- TranslateExecuteMerge hook and ExecuteMergeMatch on
  QueryableMethodTranslatingExpressionVisitor.

Relational:
- MergeExpression / MergeColumnReferenceExpression SQL nodes, plumbed
  through QuerySqlGenerator (VisitMerge), SqlNullabilityProcessor and the
  shaped-query compiler (including a RETURNING shaper).
- Base VisitMerge throws; providers opt in by overriding it.

SQLite:
- VisitMerge lowers to INSERT ... ON CONFLICT ... DO UPDATE/DO NOTHING,
  with optional RETURNING.

Behavior:
- Match honors the source-side key selector, so matching on a differently
  named source member produces the correct conflict/insert values.
- The default (no WhenNotMatched) insert excludes computed columns.

Part of dotnet#4526
Copilot AI lite review requested due to automatic review settings September 26, 2026 15:04
@omri-klein-semperis
omri-klein-semperis requested a review from a team as a code owner September 26, 2026 15:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Unresolved critical and moderate correctness, SQL generation, precompilation, trimming, and cancellation issues remain.

Review effort: Lite
Findings: 1 High severity · 2 Medium severity

Open (3)
What changed in this PR

Adds experimental EF Core ExecuteMerge/upsert APIs with relational translation, SQLite ON CONFLICT support, RETURNING, and functional tests.

Changes:

  • Adds merge configuration builders and public sync/async APIs.
  • Introduces relational merge expressions, translation, shaping, and provider hooks.
  • Implements SQLite upsert SQL generation and test coverage.
File Reviewed changes
test/​EFCore.Sqlite.FunctionalTests/​ExecuteMergeSqliteTest.cs SQLite merge functional tests
src/​Shared/​EFDiagnostics.cs Experimental diagnostic identifier
src/​EFCore/​Query/​QueryableMethodTranslatingExpressionVisitor.cs Merge method translation
src/​EFCore/​Query/​MergeUpdateSettersBuilder.cs Matched-row setters
src/​EFCore/​Query/​MergeSettersBuilder.cs Shared setter capture
src/​EFCore/​Query/​MergeInsertSettersBuilder.cs Insert setters
src/​EFCore/​Query/​MergeBuilder.cs Match and action configuration
src/​EFCore/​Query/​Internal/​NavigationExpandingExpressionVisitor.cs Merge pipeline handling
src/​EFCore/​Extensions/​EntityFrameworkQueryableExtensions.cs Public merge APIs
src/​EFCore/​EFCore.baseline.json Core API baseline
src/​EFCore.Sqlite.Core/​Query/​Internal/​SqliteQuerySqlGenerator.cs SQLite upsert SQL generation
src/​EFCore.Relational/​Query/​SqlNullabilityProcessor.cs Merge nullability handling
src/​EFCore.Relational/​Query/​SqlExpressions/​MergeExpression.cs Relational merge expression
src/​EFCore.Relational/​Query/​SqlExpressions/​MergeColumnReferenceExpression.cs Merge column references
src/​EFCore.Relational/​Query/​RelationalShapedQueryCompilingExpressionVisitor.cs Merge result shaping
src/​EFCore.Relational/​Query/​RelationalQueryableMethodTranslatingExpressionVisitor.ExecuteMerge.cs Relational merge translation
src/​EFCore.Relational/​Query/​QuerySqlGenerator.cs Provider merge-generation hook
src/​EFCore.Relational/​Properties/​RelationalStrings.resx Relational error resources
src/​EFCore.Relational/​Properties/​RelationalStrings.Designer.cs Generated resource accessors
src/​EFCore.Relational/​EFCore.Relational.baseline.json Relational API baseline
Files not reviewed (1)
  • src/EFCore.Relational/Properties/RelationalStrings.Designer.cs: Generated file

Comment on lines +25 to +30
if (source.QueryExpression is not SelectExpression { Tables: [TableExpression targetTable], Predicate: null })
{
throw new InvalidOperationException(RelationalStrings.ExecuteMergeOnComplexQuery);
}

if (source.ShaperExpression is not StructuralTypeShaperExpression { StructuralType: IEntityType entityType })
/// </para>
/// </summary>
[DebuggerDisplay("{Microsoft.EntityFrameworkCore.Query.ExpressionPrinter.Print(this), nq}")]
public sealed class MergeExpression : Expression, IPrintableExpression
/// <param name="buildMerge">A callback configuring the match columns and the matched/not-matched actions.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
/// <returns>The total number of rows inserted or updated in the database.</returns>
[Experimental(EFDiagnostics.ExecuteMergeExperimental)]
Copilot AI review requested due to automatic review settings September 27, 2026 07:02
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

@omri-klein-semperis please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

A critical source-materialization defect and multiple unresolved correctness, validation, parameterization, and integration issues remain.

Review effort: Lite
Findings: 2 High severity · 2 Medium severity

Open (4)
Files not reviewed (1)
  • src/EFCore.Relational/Properties/RelationalStrings.Designer.cs: Generated file
Previously missed (1)

In code that hasn't changed since last review

Medium severity Empty WhenNotMatched generates invalid empty insert values

src/​EFCore.Relational/​Query/​RelationalQueryableMethodTranslatingExpressionVisitor.ExecuteMerge.cs:289

An empty WhenNotMatched callback leaves insertProperties empty. For a non-empty source, constructing RowValueExpression(values) then fails because row values must be non-empty; for an empty source the SQLite generator would also produce an invalid empty column list. This clause needs the same explicit empty-setter validation or a defined default-values insert semantics.

Comment on lines +100 to +102
case null:
var getter = property.GetGetter();
valueGetters[i] = row => getter.GetClrValue(row!);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants