Skip to content

docs(db): add info about populating Auto fields - #675

Merged
m4tx merged 3 commits into
masterfrom
db-auto
Sep 22, 2026
Merged

m4tx merged 3 commits into
masterfrom
db-auto

Conversation

@m4tx

@m4tx m4tx commented Sep 19, 2026

Copy link
Copy Markdown
Member

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Refactor / cleanup
  • Performance improvement
  • Other (describe above)

@m4tx
m4tx requested review from a team and a lite review from Copilot September 19, 2026 11:18
@github-actions github-actions Bot added the C-lib Crate: cot (main library crate) label Sep 19, 2026

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

Clarify that the documented requirement applies only to Auto-typed fields.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Low severity

Open (1)
What changed in this PR

This documentation PR explains how Auto fields are populated and handled during database operations.

Changes:

  • Added Auto population documentation and examples.
  • Documented update behavior and panic conditions.
  • Added backend trait documentation.
File Summary
cot/​src/​db.rs Expanded database API documentation and examples.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread cot/src/db.rs
@github-actions

github-actions Bot commented Sep 19, 2026

Copy link
Copy Markdown

🐰 Bencher Report

Projectcot
Branchdb-auto
Testbedgithub-ubuntu-latest
Click to view all benchmark results
BenchmarkLatencyBenchmark Result
milliseconds (ms)
(Result Δ%)
Upper Boundary
milliseconds (ms)
(Limit %)
empty_router/empty_router📈 view plot
🚷 view threshold
14.25 ms
(+40.00%)Baseline: 10.18 ms
18.68 ms
(76.28%)
json_api/json_api📈 view plot
🚷 view threshold
1.16 ms
(+12.73%)Baseline: 1.03 ms
1.37 ms
(84.76%)
nested_routers/nested_routers📈 view plot
🚷 view threshold
1.06 ms
(+9.98%)Baseline: 0.96 ms
1.26 ms
(83.99%)
single_root_route/single_root_route📈 view plot
🚷 view threshold
1.03 ms
(+11.29%)Baseline: 0.93 ms
1.22 ms
(84.33%)
single_root_route_burst/single_root_route_burst📈 view plot
🚷 view threshold
19.68 ms
(+16.99%)Baseline: 16.82 ms
21.97 ms
(89.56%)
🐰 View full continuous benchmarking report in Bencher

@codecov

codecov Bot commented Sep 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
rust 90.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
cot/src/db.rs 84.06% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@seqre seqre left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Overall I think it's good, I just wonder if we need to copy&paste it everywhere 🤔

@m4tx

m4tx commented Sep 22, 2026

Copy link
Copy Markdown
Member Author

Overall I think it's good, I just wonder if we need to copy&paste it everywhere 🤔

Yeah; my thoughts, too, but sadly there isn't much we can do about this cleanly considering these are doctests.

Maybe it's worth extracting this into some internal common place, but this isn't easy, as doctests are only allowed to test public API, so either doc(hidden) or putting this in cot-test could make sense.

In any case, I think we have more stuff like this, so I'd argue this is out of scope for this PR anyway. I've created #678 to track this.

@m4tx
m4tx merged commit c617e1b into master Sep 22, 2026
44 checks passed
@m4tx
m4tx deleted the db-auto branch September 22, 2026 16:25
@cotbot cotbot Bot mentioned this pull request Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-lib Crate: cot (main library crate)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants