Struct Jsonb

pub struct Jsonb;

The jsonb SQL type. This type can only be used with feature = "serde_json"

In SQLite, jsonb brings mainly performance improvements over regular JSON:

The advantage of JSONB in SQLite is that it is smaller and faster than text JSON - potentially several times faster. There is space in the on-disk JSONB format to add enhancements and future versions of SQLite might include options to provide O(1) lookup of elements in JSONB, but no such capability is currently available.

In SQLite, JSONB is intended for internal use by SQLite only. Thus, future SQLite updates might break our JSONB implementation. And one might have to wait and then upgrade diesel for those changes to be accounted for. If you do not want this, prefer the regular Json type.

In PostgreSQL, jsonb offers several advantages over regular JSON:

There are two JSON data types: json and jsonb. They accept almost identical sets of values as input. The major practical difference is one of efficiency. The json data type stores an exact copy of the input text, which processing functions must reparse on each execution; while jsonb data is stored in a decomposed binary format that makes it slightly slower to input due to added conversion overhead, but significantly faster to process, since no reparsing is needed. jsonb also supports indexing, which can be a significant advantage.

…In general, most applications should prefer to store JSON data as jsonb, unless there are quite specialized needs, such as legacy assumptions about ordering of object keys.

ToSql impls

• serde_json::Value

FromSql impls

• serde_json::Value

Examples

table! {
    contacts {
        id -> Integer,
        name -> Text,
        address -> Jsonb,
    }
}

let santas_address: serde_json::Value = serde_json::from_str(r#"{
    "street": "Article Circle Expressway 1",
    "city": "North Pole",
    "postcode": "99705",
    "state": "Alaska"
}"#)?;
let inserted_address = insert_into(contacts)
    .values((name.eq("Claus"), address.eq(&santas_address)))
    .returning(address)
    .get_result::<serde_json::Value>(connection)?;
assert_eq!(santas_address, inserted_address);

Trait Implementations

impl<'__expr, '__expr2> AsExpression<Jsonb> for &'__expr2 &'__expr Value

Available on crate feature serde_json and (crate features postgres_backend or mysql_backend or sqlite) only.

type Expression = Bound<Jsonb, &'__expr2 &'__expr Value>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl<'__expr> AsExpression<Jsonb> for &'__expr Value

Available on crate feature serde_json and (crate features postgres_backend or mysql_backend or sqlite) only.

type Expression = Bound<Jsonb, &'__expr Value>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl AsExpression<Jsonb> for Value

Available on crate feature serde_json and (crate features postgres_backend or mysql_backend or sqlite) only.

type Expression = Bound<Jsonb, Value>

The expression being returned

fn as_expression(self) -> Self::Expression

Perform the conversion

impl Clone for Jsonb

fn clone(&self) -> Jsonb

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Jsonb

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Jsonb

fn default() -> Jsonb

Returns the “default value” for a type.

impl FromSql<Jsonb, Pg> for Value

Available on crate features serde_json and postgres_backend only.

fn from_sql(value: PgValue<'_>) -> Result<Self>

See the trait documentation.

fn from_nullable_sql(bytes: Option<DB::RawValue<'_>>) -> Result<Self>

A specialized variant of from_sql for handling null values.

impl FromSql<Jsonb, Sqlite> for Value

Available on crate features sqlite and serde_json only.

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

See the trait documentation.

fn from_nullable_sql(bytes: Option<DB::RawValue<'_>>) -> Result<Self>

A specialized variant of from_sql for handling null values.

impl HasSqlType<Jsonb> for Pg

fn metadata(_: &mut Self::MetadataLookup) -> PgTypeMetadata

Fetch the metadata for the given type

impl HasSqlType<Jsonb> for Sqlite

fn metadata(_: &mut ()) -> SqliteType

Fetch the metadata for the given type

impl QueryId for Jsonb

const HAS_STATIC_QUERY_ID: bool = true

Can the SQL generated by Self be uniquely identified by its type?

type QueryId = Jsonb

A type which uniquely represents Self in a SQL query.

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl SqlType for Jsonb

type IsNull = NotNull

Is this type nullable?

impl ToSql<Jsonb, Pg> for Value

Available on crate features serde_json and postgres_backend only.

fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, Pg>) -> Result

See the trait documentation.

impl ToSql<Jsonb, Sqlite> for Value

Available on crate features sqlite and serde_json only.

fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, Sqlite>) -> Result

See the trait documentation.

impl Copy for Jsonb

impl SingleValue for Jsonb