feat: add offset param to SQLizer.select_custom_fields

Author: NightMarcher

README.md

@@ -68,6 +68,7 @@ await AccountMgr.select_custom_fields(
     groups=["locale", "gender"],
     having="cnt > 0",
     orders=["locale", "-gender"],
+    offset=0,
     limit=10,
 )
 ```
@@ -80,7 +81,7 @@ Generate sql and execute
     GROUP BY locale, gender
     HAVING cnt > 0
     ORDER BY locale ASC, gender DESC
-    LIMIT 10
+    LIMIT 0, 10
 ```
 
 ### **update_json_field**

examples/service/routers/account.py

@@ -60,6 +60,7 @@ async def query_group_by_locale_view(
         groups=["locale", "gender"],
         having="cnt > 0",
         orders=["locale", "-gender"],
+        offset=0,
         limit=10,
     )
     return {"dicts": dicts}

fastapi_esql/orm/base_manager.py

@@ -66,6 +66,7 @@ async def select_custom_fields(
         groups: Optional[List[str]] = None,
         having: Optional[str] = None,
         orders: Optional[List[str]] = None,
+        offset: Optional[int] = None,
         limit: int = 0,
         conn: Optional[BaseDBAsyncClient] = None,
     ):
@@ -76,6 +77,7 @@ async def select_custom_fields(
             groups,
             having,
             orders,
+            offset,
             limit,
             cls.model,
         )

fastapi_esql/utils/sqlizer.py

@@ -117,6 +117,7 @@ def select_custom_fields(
         groups: Optional[List[str]] = None,
         having: Optional[str] = None,
         orders: Optional[List[str]] = None,
+        offset: Optional[int] = None,
         limit: int = 0,
         model: Optional[Model] = None,
     ) -> Optional[str]:
@@ -128,8 +129,8 @@ def select_custom_fields(
         group_by = f"    GROUP BY {', '.join(groups)}" if groups else ""
         having_ = f"    HAVING {having}" if having else ""
         order_by = f"    ORDER BY {cls.resolve_orders(orders)}" if orders else ""
-        limit_ = f"    LIMIT {limit}" if limit else ""
-        # NOTE Doesn't support `offset` parameter due to it's bad performance
+        offset_ = "" if offset is None else f"{offset}, "
+        limit_ = f"    LIMIT {offset_}{limit}" if limit else ""
         extras = [group_by, having_, order_by, limit_]
 
         sql = """

tests/__init__.py

@@ -32,3 +32,6 @@ def init_test_orm():
         }
     }
     asyncio.run(Tortoise.init(config=config))
+
+
+init_test_orm()

tests/test_metaclass.py

@@ -15,12 +15,10 @@ class TestSingleton(TestCase):
 
     def test_inheritance(self):
         c0, c1 = Child(), Child()
-        print(id(c0), id(c1))
         assert c0 is c1
 
     def test_parent_and_child(self):
         p0, p1 = Parent(), Parent()
         c = Child()
-        print(id(p0), id(p0), id(c))
         assert p0 is p1
         assert p0 is not c

tests/test_sqlizer.py

@@ -6,7 +6,6 @@
     Q, QsParsingError, WrongParamsError,
 )
 
-from . import init_test_orm
 from examples.service.models.demo import Account
 
 
@@ -33,6 +32,9 @@ def test_no_default(self):
 
 class TestSQLizer(TestCase):
 
+    model = Account
+    table = Account.Meta.table
+
     def test_resolve_wheres(self):
         with self.assertRaises(WrongParamsError):
             SQLizer.resolve_wheres(object())
@@ -41,22 +43,21 @@ def test_resolve_wheres(self):
         assert SQLizer.resolve_wheres(
             f"id IN ({','.join(map(str, aids))}) AND gender=1"
         ) == "id IN (1,2,3) AND gender=1"
-        init_test_orm()
         assert SQLizer.resolve_wheres(
-            Q(Q(id__in=aids), Q(gender=1), join_type="AND"), Account
+            Q(Q(id__in=aids), Q(gender=1), join_type="AND"), self.model
         ) == "`id` IN (1,2,3) AND `gender`=1"
         assert SQLizer.resolve_wheres(
-            {"id__in": aids, "gender": 1}, Account
+            {"id__in": aids, "gender": 1}, self.model
         ) == "`id` IN (1,2,3) AND `gender`=1"
         assert SQLizer.resolve_wheres(
-            [Q(id__in=aids), Q(gender=1)], Account
+            [Q(id__in=aids), Q(gender=1)], self.model
         ) == "`id` IN (1,2,3) AND `gender`=1"
 
         with self.assertRaises(WrongParamsError):
             SQLizer.resolve_wheres(set())
 
         with self.assertRaises(QsParsingError):
-            SQLizer.resolve_wheres({}, Account)
+            SQLizer.resolve_wheres({}, self.model)
 
     def test_resolve_orders(self):
         orders = SQLizer.resolve_orders(["-created_at", "name"])
@@ -82,3 +83,61 @@ def test_sqlize_value(self):
         assert SQLizer.sqlize_value(("a", "b", "c")) == """'["a", "b", "c"]'"""
 
         assert SQLizer.sqlize_value(datetime(2023, 1, 1, 12, 30)) == "'2023-01-01 12:30:00'"
+
+    def test_select_custom_fields(self):
+        aids = [1, 2, 3]
+        basic_sql = SQLizer.select_custom_fields(
+            self.table,
+            fields=[
+                "id", "extend ->> '$.last_login.ipv4' ipv4",
+                "extend ->> '$.last_login.start_datetime' start_datetime",
+                "CAST(extend ->> '$.last_login.online_sec' AS SIGNED) online_sec"
+            ],
+            wheres=f"id IN ({','.join(map(str, aids))}) AND gender=1",
+            model=self.model,
+        )
+        assert basic_sql == """
+    SELECT
+      id, extend ->> '$.last_login.ipv4' ipv4, extend ->> '$.last_login.start_datetime' start_datetime, CAST(extend ->> '$.last_login.online_sec' AS SIGNED) online_sec
+    FROM account
+    WHERE id IN (1,2,3) AND gender=1
+"""
+
+        complex_sql = SQLizer.select_custom_fields(
+            self.table,
+            fields=[
+                "locale", "gender", "COUNT(1) cnt"
+            ],
+            wheres=Q(id__range=[1, 12]),
+            groups=["locale", "gender"],
+            having="cnt > 0",
+            orders=["locale", "-gender"],
+            limit=10,
+            model=self.model,
+        )
+        assert complex_sql == """
+    SELECT
+      locale, gender, COUNT(1) cnt
+    FROM account
+    WHERE `id` BETWEEN 1 AND 12
+    GROUP BY locale, gender
+    HAVING cnt > 0
+    ORDER BY locale ASC, gender DESC
+    LIMIT 10"""
+
+        paging_sql = SQLizer.select_custom_fields(
+            self.table,
+            fields=[
+                "locale", "gender"
+            ],
+            wheres=Q(id__range=[1, 12]),
+            offset=100,
+            limit=5,
+            model=self.model,
+        )
+        assert paging_sql == """
+    SELECT
+      locale, gender
+    FROM account
+    WHERE `id` BETWEEN 1 AND 12
+    LIMIT 100, 5"""