-
Notifications
You must be signed in to change notification settings - Fork 22
docs: add missing documentation for decimal datatype and protocol version 3 #127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughDocumentation updates adding protocol version 3 and detailed Decimal Datatype guidance for QuestDB ingress, including Buffer::column_dec usage, supported decimal types, and server/protocol requirements for HTTP and TCP ingestion. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
questdb-rs/src/ingress/mod.md (1)
273-357: Remove duplicate "Decimal Datatype" section to avoid maintenance burden.The "Decimal Datatype" documentation appears twice in this file (lines 273–286 and lines 344–357) with nearly identical content. This violates the DRY principle and creates a maintenance hazard: any future updates to decimal support requirements must be applied in two places, increasing the risk of inconsistency.
The first section (lines 273–286) is better positioned because it logically follows the "Array Datatype" section (lines 257–271), establishing a consistent pattern for documenting special datatypes. The second occurrence (lines 344–357) interrupts the flow of optimization tips.
Remove the second occurrence (lines 344–357) and keep only the first section with the grammar fix applied.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)questdb-rs/src/ingress/mod.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
questdb-rs/src/ingress/mod.md
[grammar] ~277-~277: Use a hyphen to join words.
Context: ...ng several convenient types: - floating point representation with &str - decim...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (1)
README.md (1)
58-63: Protocol version table update looks good.The new row for protocol version 3 is properly formatted, consistent with existing entries, and the date aligns with the server version requirements documented in the complementary Rust ingress documentation.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This pull request adds documentation for decimal datatype support in QuestDB, specifically for protocol version 3. The changes clarify how to ingest decimals using the Rust client and update the compatibility matrix in the main README.
Summary by CodeRabbit
New Features
Documentation