-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Add json(nullable) macro attribute #3677
Merged
abonander
merged 6 commits into
launchbadge:main
from
seanaye:seanaye/feat/json-optional
Jan 28, 2025
Merged
Add json(nullable) macro attribute #3677
abonander
merged 6 commits into
launchbadge:main
from
seanaye:seanaye/feat/json-optional
Jan 28, 2025
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
seanaye
changed the title
Add json(optional) macro attribute
Add json(nullable) macro attribute
Jan 10, 2025
seanaye
force-pushed
the
seanaye/feat/json-optional
branch
from
January 24, 2025 03:51
0a74698
to
9c7cbab
Compare
abonander
requested changes
Jan 26, 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.
An explanation of this feature should be added to the docs here:
sqlx/sqlx-core/src/from_row.rs
Lines 232 to 273 in 6fa0458
/// #### `json` | |
/// | |
/// If your database supports a JSON type, you can leverage `#[sqlx(json)]` | |
/// to automatically integrate JSON deserialization in your [`FromRow`] implementation using [`serde`](https://docs.rs/serde/latest/serde/). | |
/// | |
/// ```rust,ignore | |
/// #[derive(serde::Deserialize)] | |
/// struct Data { | |
/// field1: String, | |
/// field2: u64 | |
/// } | |
/// | |
/// #[derive(sqlx::FromRow)] | |
/// struct User { | |
/// id: i32, | |
/// name: String, | |
/// #[sqlx(json)] | |
/// metadata: Data | |
/// } | |
/// ``` | |
/// | |
/// Given a query like the following: | |
/// | |
/// ```sql | |
/// SELECT | |
/// 1 AS id, | |
/// 'Name' AS name, | |
/// JSON_OBJECT('field1', 'value1', 'field2', 42) AS metadata | |
/// ``` | |
/// | |
/// The `metadata` field will be deserialized used its `serde::Deserialize` implementation: | |
/// | |
/// ```rust,ignore | |
/// User { | |
/// id: 1, | |
/// name: "Name", | |
/// metadata: Data { | |
/// field1: "value1", | |
/// field2: 42 | |
/// } | |
/// } | |
/// ``` |
seanaye
force-pushed
the
seanaye/feat/json-optional
branch
from
January 27, 2025 01:31
4905697
to
a068506
Compare
@frederikhors sorry didn't see your comment, I had already written some docs of my own |
frederikhors
approved these changes
Jan 27, 2025
seanaye
force-pushed
the
seanaye/feat/json-optional
branch
from
January 27, 2025 02:20
a068506
to
db09397
Compare
abonander
approved these changes
Jan 28, 2025
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.
Does your PR solve an issue?
fixes #2849
This MR introduces a
#[sqlx(json(nullable))]
attribute which allows for the correct behaviour onby allowing the underlying row value to be null