Upsert primary key
Summary by CodeRabbit
- Bug Fixes
- Corrects record ID handling during updates to preserve existing histories and references.
- Ensures tenant association is reliably retained during upserts in shared tables, preventing cross-tenant data mix-ups.
- Refactor
- Standardizes database write ordering for more deterministic, reliable upserts.
- Improves consistency of bulk updates/imports by aligning column mapping and value binding.
Walkthrough
Updates SQL adapter upsert path: deterministically orders columns, constructs a new $columns list, assigns _id from the old document’s sequence (default null), preserves tenant propagation via _tenant, rebuilds batch keys and bind values accordingly, and invokes upsert with the updated parameters. No public API changes.
Changes
| Cohort / File(s) | Summary of changes |
|---|---|
SQL upsert path refactorsrc/Database/Adapter/SQL.php |
- Introduce local $columns for insert list used by upsert - Assign _id from old document sequence; remove reliance on new sequence - Deterministic column ordering via ksort on attributes - Rebuild column projection, batch placeholders, $batchKeys, and $bindValues - Maintain sharedTables _tenant propagation - Upsert call updated to use new ordering and values |
Sequence Diagram(s)
sequenceDiagram
participant Caller as Database Adapter Caller
participant SQL as SQL Adapter
participant DB as SQL Database
Caller->>SQL: upsert(changes)
SQL->>SQL: sort attributes (ksort)
SQL->>SQL: build $columns, $batchKeys, $bindValues
SQL->>SQL: set _id from old sequence (or null)
SQL->>SQL: include _tenant when sharedTables
SQL->>DB: EXECUTE UPSERT ($columns, $batchKeys, $bindValues)
DB-->>SQL: result
SQL-->>Caller: upsert result
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
- utopia-php/database#613 — Also modifies SQL adapter upsert/createOrUpdateDocuments logic, including column/ID handling.
Suggested reviewers
- abnegate
Poem
I sorted the fields with a hop and a grin,
Old IDs in paw, I tucked them back in.
Columns in order, placeholders neat—
Upserts now march with a predictable beat.
Tenant tracks clear on the burrowed trail—
Carrots compiled, no queries fail. 🥕✨
[!TIP]
🔌 Remote MCP (Model Context Protocol) integration is now available!
Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
- [ ] Commit unit tests in branch
upsert-primary-key
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.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>, please review it. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. - PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
CodeRabbit Commands (Invoked using PR/Issue comments)
Type @coderabbitai help to get the list of available commands.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
Status, Documentation and Community
- Visit our Status Page to check the current availability of CodeRabbit.
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.