docs: clarify onConflictDoNothing batch behavior - #703
Open
raphaelbadia wants to merge 1 commit into
Open
Conversation
Reword the 'On conflict do nothing' section for pg, sqlite and cockroach.
The previous wording ('will cancel the insert if there's a conflict') was
misleading: on a multi-row insert only the conflicting rows are skipped,
the remaining rows are still inserted. Add a batch example.
Verified against PostgreSQL 16, CockroachDB and SQLite.
Closes #4065
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Clarifies the On conflict do nothing section of the insert docs for
pg,sqliteandcockroach.Why
Closes drizzle-team/drizzle-orm#4065.
The previous wording said
onConflictDoNothing"will cancel the insert if there's a conflict", which is misleading for multi-row inserts. In reality, only the conflicting rows are skipped, and the remaining rows are still inserted.Verification
Ran the same scenario (one existing row
id=1, then a batch insert of(1),(2),(3)withON CONFLICT DO NOTHING) against real databases:INSERT 0 2→ existingid=1kept,id=2andid=3insertedIn every case only the conflicting row was skipped and the rest were inserted.
Changes