-
Notifications
You must be signed in to change notification settings - Fork 1
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
[CDRIVER-5662] Tutorials for simple CRUD, and some more convience APIs #6
Merged
Conversation
This file contains 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
This replaces the allocating `strup_message` mechanism with an API that is guaranteed to never allocate memory. This is based on the new Boost.System APIs that accept a scratch buffer in order to do dynamic message generation.
kevinAlbs
approved these changes
Jan 29, 2025
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.
LGTM with minor comments. I found the read/write tutorials easy to follow with the annotated examples. I like the new amongoc_if_error
macro.
Co-authored-by: Kevin Albertson <kevin.albertson@mongodb.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Refer: CDRIVER-5662
Reviewing this changeset per-commit is recommended.
This changeset adds two tutorials for the basics of reading and writing data from a database. More complex CRUD operation tutorials could be written, or may be better as how-tos, but those are not included or scheduled here.
These changes also introduce a few convenience APIs and tweak the way status message are obtained.
Changes (chronological)
amongoc_status
are now non-allocating. This is based on the newer Boost.System design which allows the caller to provide a scratch space in which the API may write a C string.amongoc_tie
, allowing the caller to tie only the status, only the result, or omit the allocator.amongoc_insert_one
.nodiscard
amongoc_status
amongoc_status
" page.char
output, leading into: