Support using _id as alias for primary key field when filtering

Author: frmdstryr

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Rework Relation & RelatedList so the return value is still a list instance
 - Flatten builtin enum.Enum types to their value
 - Add first, last, earliest, latest to QuerySet and support Meta get_latest_by
+- Support using `_id` as alias to the primary key when doing filtering
 
 # 0.8.0
 

atomdb/sql.py

@@ -454,7 +454,10 @@ def resolve_member_column(
         model = rel_model
 
     # Lookup the member
-    m = model.members().get(field)
+    members = model.members()
+    if field not in members and field == "_id":
+        field = model.__pk__  # Support lookup using _id for pk
+    m = members.get(field)
     if m is not None:
         if m.metadata:
             # If the field has a different name assigned use that

tests/test_sql.py

@@ -534,6 +534,11 @@ async def test_query(db):
     await User.objects.delete(name=user.name)
     assert len(await User.objects.all()) == 9
 
+    # Test mapping _id to pk
+    u = await User.objects.first()
+    assert u.id
+    await User.objects.filter(_id=u.id).count() == 1
+
     # Delete them all
     await User.objects.delete(active=True)
     assert len(await User.objects.all()) == 0