feat: JSONB column

src/ormar_postgres_extensions/__init__.py

@@ -1 +1,4 @@
-from .fields import PostgresUUID  # noqa: F401
+from .fields import (  # noqa: F401
+    PostgresJSONB,
+    PostgresUUID,
+)

src/ormar_postgres_extensions/fields/__init__.py

@@ -1 +1,2 @@
+from .jsonb import PostgresJSONB  # noqa: F401
 from .uuid import PostgresUUID  # noqa: F401

src/ormar_postgres_extensions/fields/jsonb.py

@@ -0,0 +1,19 @@
+from typing import Any
+
+import ormar
+from sqlalchemy.dialects import postgresql
+from sqlalchemy.types import TypeDecorator
+
+
+class PostgresJSONBTypeDecorator(TypeDecorator):
+    impl = postgresql.JSONB
+
+
+class PostgresJSONB(ormar.JSON):
+    """
+    Custom JSON field uses a native PG JSONB type
+    """
+
+    @classmethod
+    def get_column_type(cls, **kwargs: Any) -> PostgresJSONBTypeDecorator:
+        return PostgresJSONBTypeDecorator()

tests/fields/test_jsonb.py

@@ -0,0 +1,48 @@
+import json
+from typing import Optional
+
+import ormar
+import pytest
+
+from ormar_postgres_extensions.fields import PostgresJSONB
+from tests.database import (
+    database,
+    metadata,
+)
+
+
+class JSONBTestModel(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
+
+    id: int = ormar.Integer(primary_key=True)
+    data: dict = PostgresJSONB()
+
+
+class NullableJSONBTestModel(ormar.Model):
+    class Meta:
+        database = database
+        metadata = metadata
+
+    id: int = ormar.Integer(primary_key=True)
+    data: Optional[dict] = PostgresJSONB(nullable=True)
+
+
+@pytest.mark.asyncio
+async def test_create_model_with_jsonb(db):
+    created = await JSONBTestModel(data=json.dumps(dict(foo="bar"))).save()
+    assert created.data == {"foo": "bar"}
+
+    # Confirm the model got saved to the DB by querying it back
+    found = await JSONBTestModel.objects.get()
+    assert found.data == {"foo": "bar"}
+
+
+@pytest.mark.asyncio
+async def test_create_model_with_nullable_jsonb(db):
+    created = await NullableJSONBTestModel().save()
+    assert created.data is None
+
+    found = await NullableJSONBTestModel.objects.get()
+    assert found.data is None