sqlalchemy.dialects.postgresql.json.JSONB

Represent the PostgreSQL JSONB type.

The _postgresql.JSONB type stores arbitrary JSONB format data, e.g.:

data_table = Table('data_table', metadata,
    Column('id', Integer, primary_key=True),
    Column('data', JSONB)
)

with engine.connect() as conn:
    conn.execute(
        data_table.insert(),
        data = {"key1": "value1", "key2": "value2"}
    )

The _postgresql.JSONB type includes all operations provided by _types.JSON, including the same behaviors for indexing operations. It also adds additional operators specific to JSONB, including .JSONB.Comparator.has_key, .JSONB.Comparator.has_all, .JSONB.Comparator.has_any, .JSONB.Comparator.contains, and .JSONB.Comparator.contained_by.

Like the _types.JSON type, the _postgresql.JSONB type does not detect in-place changes when used with the ORM, unless the sqlalchemy.ext.mutable extension is used.

Custom serializers and deserializers are shared with the _types.JSON class, using the json_serializer and json_deserializer keyword arguments. These must be specified at the dialect level using _sa.create_engine. When using psycopg2, the serializers are associated with the jsonb type using psycopg2.extras.register_default_jsonb on a per-connection basis, in the same way that psycopg2.extras.register_default_json is used to register these handlers with the json type.