#json #deserialize-json #postgresql #sqlx #queries #wrapper #decode

sqlx-transparent-json-decode

Decode JSON from Postgres sqlx queries, without the Json<> wrapper type

7 stable releases

2.2.2 Apr 24, 2024
2.2.1 Mar 27, 2024
2.1.0 Nov 27, 2023
1.0.0 May 27, 2023

#641 in Parser implementations

Download history 115/week @ 2024-02-25 14/week @ 2024-03-03 10/week @ 2024-03-10 2/week @ 2024-03-17 158/week @ 2024-03-24 44/week @ 2024-03-31 1/week @ 2024-04-07 150/week @ 2024-04-21 31/week @ 2024-04-28 10/week @ 2024-05-05 16/week @ 2024-05-12 28/week @ 2024-05-19 21/week @ 2024-05-26 15/week @ 2024-06-02

80 downloads per month
Used in 3 crates

MIT/Apache

18KB
299 lines

sqlx-transparent-json-decode

docs.rs docs Download

This crate is meant for use with sqlx and allows you to query JSON or JSONB fields from PostgreSQL without needing to wrap the types in a sqlx::types::Json<> wrapper type.

use serde::{Deserialize, Serialize};
use sqlx_transparent_json_decode::sqlx_json_decode;

#[derive(Serialize, Deserialize)]
pub struct SomeJsonField {
    // Whatever fields match the JSON structure
    pub name: String,
    pub some_param: Option<String>,
    pub count: i32,
}

sqlx_json_decode!(SomeJsonField);

#[derive(sqlx::FromRow)]
pub struct QueryResult {
    pub id: i32,
    pub name: String,
    pub params: SomeJsonField,
}

Normally, you would need to use Json<SomeJsonField> as the type for params in the above example. This crate allows you to use SomeJsonField directly.

let result = sqlx::query_as!(
    QueryResult,
    r##"SELECT id,
        name,
        params as "params: SomeJsonField"
      FROM some_table"##,
).fetch_one(&pool).await?;

This crate also provides BoxedRawValue, a wrapper around Box<serde_json::value::RawValue> which can be decoded directly. This is otherwise difficult to do using sqlx's query macros.

let result = sqlx::query!(
    r##"SELECT id, data as "data: BoxedRawValue" FROM table##"
).fetch_one(&pool).await?;

Dependencies

~14–28MB
~410K SLoC