[artile]

A sync upsert usually copies the new row over the old one. Today each column must be written twice in onConflictDoUpdate's set callback (name: excluded.name, rent: excluded.rent, ...).

Closes #81.
Part of #52.

Changes

• New excluded(columns): a set value that writes SET col = EXCLUDED.col for each named column.
• New excludedAll(except?): a set value that copies every column the insert writes (the rows' keys, or the SELECT's aliases), except the named columns and the conflict target's columns. A column the rows leave out keeps its old value, because its EXCLUDED value is the default.
• Both are typed against the table's writable columns. An unknown or computed column does not type-check. At runtime an unknown name is a QueryBuilderError InvalidArguments; an excludedAll that leaves no column fails with "sets no columns", as an empty set does.
• Tenant scope: col = excluded.col on the tenant column now keeps the rows' tenant scope. Before, it made the insert cross-tenant, so excludedAll on a tenant table would fail under requireTenantScope. This also holds for the callback form (($, excluded) => ({ org: excluded.org })).
• The compiler expands both helpers through one proposed-row accessor (proposedRowAccessor in src/ch/compile.ts), the same one the callback gets.
• Docs: docs/inserts.md ("Set from the proposed row"), docs/reference.md, design/writes.md §6, design/gap-review.md (P1 item marked built). One minor changeset.

How SQLite and MySQL plug in later

• SQLite / D1: the same excluded."col" text and the same ON CONFLICT (target) clause. The helpers work as they are once the dialect sets clauses.onConflict: true.
• MySQL: the dialect changes only proposedRowAccessor, to write VALUES(col) (or new.col with a row alias on 8.0.19+), and renders ON DUPLICATE KEY UPDATE. It refuses an explicit target, because MySQL uses all unique keys. Then excludedAll cannot skip the target's columns from target, so it would skip the primary key instead. The helpers' public shape does not change.

Left out

• SQLite, D1 and MySQL upsert SQL. Upstream main has no SQLite or MySQL dialect (SQLite is PR feat: add SQLite and Cloudflare D1 query dialects #49, MySQL is MySQL / MariaDB dialect #53).
• Mixing copied columns with other values in one value (for example excludedAll plus updatedAt: now()). The callback form does this today; the docs show it. A later option can add it if you want it.
• A dialect hook in Dialect for the proposed-row SQL. It has no second user yet, so I kept it a private function.

Validation

• bun run build: pass.
• bun run typecheck: pass (includes the new insert.test-d.ts cases).
• bunx vitest run --testTimeout=60000 --hookTimeout=60000 with live ClickHouse 26.8.2.7: 60 files passed, 1039 tests passed, 0 skipped. New tests: 5 compile tests in src/ch/insert.test.ts, 1 PGlite run test in src/database/database.test.ts.
• node scripts/check-doc-citations.mjs, node scripts/check-exports-documented.mjs, node scripts/check-doc-examples.mjs: pass.
• bun scripts/check-package.ts: pass.
• Upstream CI for a fork PR waits for a maintainer to approve the run.

---

^{Need help on this PR? Tag @codesmith-bot with what you need.}

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 23 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 97850c66-e8ce-40f1-b15b-80fb427e4c39

Commits

Reviewing files that changed from the base of the PR and between c5fa679 and 90e2065.

Files selected for processing: 11

• .changeset/upsert-excluded.md
• design/gap-review.md
• design/writes.md
• docs/inserts.md
• docs/reference.md
• src/ch/compile.ts
• src/ch/insert.test-d.ts
• src/ch/insert.test.ts
• src/ch/insert.ts
• src/core.ts
• src/database/database.test.ts

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}