diesel_json

Crates.iodiesel_json
lib.rsdiesel_json
version0.2.1
sourcesrc
created_at2021-01-17 21:15:28.557312
updated_at2023-07-05 08:58:43.958614
descriptionJson wrapper type for JsonB data handling in diesel
homepagehttps://github.com/PPakalns/diesel_json
repositoryhttps://github.com/PPakalns/diesel_json
max_upload_size
id343278
size13,617
PÄ“teris Pakalns (PPakalns)

documentation

README

diesel_json

Provides a wrapper diesel_json::Json type that can be directly used to wrap serde serializable, deserializable structures and recognize them as queryable, insertable JsonB fields.

Getting started

Add diesel_json dependency to Cargo.toml.

  • Diesel 2.0 supported: diesel_json = "0.2"
  • Diesel 1.4 supported: diesel_json = "0.1"

Wrap data structures into diesel_json::Json type.

#[derive(Serialize, Deserialize, Debug)]
struct ComplexStruct {
  // ...
}

use diesel_json::Json;

#[derive(Serialize, Deserialize, Queryable, Insertable, AsChangeset, Identifiable)]
struct ExampleTable {
    // ...
    // Field that will be stored in Jsonb format
    jsonb_field: diesel_json::Json<ComplexStruct>,
    // Or simply as 
    jsonb_field2: Json<ComplexStruct>,
    // ...
}

Json type provides new function for object initialization, implements Deref, DerefMut, AsRef, AsMut and other traits that maps data access directly to underlying data.

See tests/postgresql.rs for example use.

Why should I use this library?

Without wrapper type for each unique type you store as JsonB field you would need to use serde_json::Value directly or implement your own implementation for following traits:

impl<T> FromSql<sql_types::JsonB, Pg> for Json<T> {}
impl<T> ToSql<sql_types::JsonB, Pg> for Json<T> {}

TODO:

  • Support not only JsonB, but also Json postgres type
  • Support more database drivers
    • PostgreSQL
    • MySql
    • SQLite
  • Improve testing of the library
    • Test insertion and retrieval of nullable/non-nullable JsonB postgresql fields.
    • Add support and test Json field insertion and retrieval
    • TODO(Expand): Add support for other database driver Json fields
Commit count: 9

cargo fmt