feat: JSONB Contained by

README.md

@@ -50,6 +50,14 @@ class JSONBTestModel(ormar.Model):
     data: dict = ormar_pg_ext.JSONB()
 ```
 
+##### jsonb_contained_by
+
+The maps to the [`contains`](https://docs.sqlalchemy.org/en/14/dialects/postgresql.html#sqlalchemy.dialects.postgresql.JSONB.Comparator.contained_by) operator in Postgres.
+
+```python
+await JSONBTestModel.objects.filter(data__jsonb_contained_by=dict(key="value")).all()
+```
+
 ##### jsonb_contains
 
 The maps to the [`contains`](https://docs.sqlalchemy.org/en/14/dialects/postgresql.html#sqlalchemy.dialects.postgresql.JSONB.Comparator.contains) operator in Postgres.

src/ormar_postgres_extensions/fields/jsonb.py

@@ -4,6 +4,17 @@
 from sqlalchemy.dialects import postgresql
 
 
+def jsonb_contained_by(self, other: Any) -> ormar.queryset.clause.FilterGroup:
+    """
+    works as postgresql `column <@ VALUE::jsonb`
+    :param other: value to check against operator
+    :type other: Any
+    :return: FilterGroup for operator
+    :rtype: ormar.queryset.clause.FilterGroup
+    """
+    return self._select_operator(op="jsonb_contained_by", other=other)
+
+
 def jsonb_contains(self, other: Any) -> ormar.queryset.clause.FilterGroup:
     """
     works as postgresql `column @> VALUE::jsonb`
@@ -17,6 +28,7 @@ def jsonb_contains(self, other: Any) -> ormar.queryset.clause.FilterGroup:
 
 # Need to patch the filter objects to support JSONB specifc actions
 FIELD_ACCESSOR_MAP = [
+    ("jsonb_contained_by", jsonb_contained_by),
     ("jsonb_contains", jsonb_contains),
 ]
 
@@ -28,6 +40,7 @@ def jsonb_contains(self, other: Any) -> ormar.queryset.clause.FilterGroup:
 # These lines allow Ormar to lookup the new filter methods and map
 # it to the correct PGSQL functions
 ACCESSOR_MAP = [
+    ("jsonb_contained_by", "contained_by"),
     ("jsonb_contains", "contains"),
 ]
 

tests/fields/test_jsonb.py

@@ -100,3 +100,24 @@ async def test_contains_array_text(db):
 
     found = await JSONBTestModel.objects.filter(data__jsonb_contains="4").all()
     assert len(found) == 0
+
+
+@pytest.mark.asyncio
+async def test_contained_by(db):
+    await JSONBTestModel(data=json.dumps(dict(key1="foo"))).save()
+    await JSONBTestModel(data=json.dumps(dict(key2="bar"))).save()
+
+    found = await JSONBTestModel.objects.filter(
+        data__jsonb_contained_by=dict(key1="foo")
+    ).all()
+    assert len(found) == 1
+
+    found = await JSONBTestModel.objects.filter(
+        data__jsonb_contained_by=dict(key1="foo", key2="bar")
+    ).all()
+    assert len(found) == 2
+
+    found = await JSONBTestModel.objects.filter(
+        data__jsonb_contains=dict(key1="bar")
+    ).all()
+    assert len(found) == 0