style: sql and readme

Author: NightMarcher

README.md

@@ -38,7 +38,7 @@ await AccountMgr.select_custom_fields(
         "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",  # These 4 ways of `wheres` can work equally
+    wheres=f"id IN ({','.join(map(str, aids))}) AND gender=1",  # These 4 types of `wheres` are equal
     # wheres=Q(Q(id__in=aids), Q(gender=1), join_type="AND"),
     # wheres={"id__in": aids, "gender": 1},
     # wheres=[Q(id__in=aids), Q(gender=1)],
@@ -49,7 +49,7 @@ Generate sql and execute
     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
+    WHERE id IN (1,2,3) AND gender=1
 ```
 
 **complex example**
@@ -58,7 +58,7 @@ await AccountMgr.select_custom_fields(
     fields=[
         "locale", "gender", "COUNT(1) cnt"
     ],
-    wheres="id BETWEEN 1 AND 12",
+    wheres=Q(id__range=[1, 12]),
     groups=["locale", "gender"],
     having="cnt > 0",
     orders=["locale", "-gender"],
@@ -70,7 +70,7 @@ Generate sql and execute
     SELECT
         locale, gender, COUNT(1) cnt
     FROM account
-    WHERE id BETWEEN 1 AND 12
+    WHERE `id` BETWEEN 1 AND 12
     GROUP BY locale, gender
     HAVING cnt > 0
     ORDER BY locale ASC, gender DESC
@@ -89,14 +89,14 @@ await AccountMgr.upsert_json_field(
         },
         "$.uuid": "fd04f7f2-24fc-4a73-a1d7-b6e99a464c5f",
     },
-    wheres=f"id = 8",
+    wheres=Q(id=8),
 )
 ```
 Generate sql and execute
 ```sql
     UPDATE account
     SET extend = JSON_SET(COALESCE(extend, '{}'), '$.last_login', CAST('{"ipv4": "209.182.101.161", "start_datetime": "2022-10-16 11:11:05", "online_sec": 4209}' AS JSON), '$.uuid', 'fd04f7f2-24fc-4a73-a1d7-b6e99a464c5f')
-    WHERE id = 8
+    WHERE `id`=8
 ```
 
 ### **upsert_on_duplicated**
@@ -124,7 +124,7 @@ Generate sql and execute
 ### **insert_into_select**
 ```python
 await AccountMgr.insert_into_select(
-    wheres=f"id IN (4, 5, 6)",
+    wheres=Q(id__in=[4, 5, 6]),
     remain_fields=["gender", "locale"],
     assign_field_dict={
         "active": False,
@@ -139,7 +139,7 @@ Generate sql and execute
         (gender, locale, active, name, extend)
     SELECT gender, locale, False active, CONCAT(LEFT(name, 26), ' [NEW]') name, '{}' extend
     FROM account
-    WHERE id IN (4, 5, 6)
+    WHERE `id` IN (4,5,6)
 ```
 
 ### **bulk_update_with_fly_table**
@@ -161,6 +161,6 @@ Generate sql and execute
             VALUES
                 ROW(7, False, 1), ROW(15, True, 0)
         ) AS fly_table (id, active, gender)
-    ) tmp ON account.id = tmp.id
-    SET account.active = tmp.active, account.gender = tmp.gender
+    ) tmp ON account.id=tmp.id
+    SET account.active=tmp.active, account.gender=tmp.gender
 ```

examples/fastapi-efficient-sql.postman_collection.json

@@ -155,7 +155,7 @@
 				"method": "POST",
 				"header": [],
 				"url": {
-					"raw": "{{local}}:8000/api/account/last_login/update?account_id=8",
+					"raw": "{{local}}:8000/api/account/last_login/update?aid=8",
 					"host": [
 						"{{local}}"
 					],
@@ -168,7 +168,7 @@
 					],
 					"query": [
 						{
-							"key": "account_id",
+							"key": "aid",
 							"value": "8"
 						}
 					]
@@ -203,7 +203,7 @@
 				"header": [],
 				"body": {
 					"mode": "raw",
-					"raw": "{\n    \"account_ids\": [4, 5, 6]\n}",
+					"raw": "{\n    \"aids\": [4, 5, 6]\n}",
 					"options": {
 						"raw": {
 							"language": "json"

examples/service/routers/account.py

@@ -56,7 +56,7 @@ async def query_group_by_locale_view(
         fields=[
             "locale", "gender", "COUNT(1) cnt"
         ],
-        wheres="id BETWEEN 1 AND 12",
+        wheres=Q(id__range=[1, 12]),
         groups=["locale", "gender"],
         having="cnt > 0",
         orders=["locale", "-gender"],
@@ -104,7 +104,7 @@ async def query_last_login_view(
             "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",
+        wheres=f"id IN ({','.join(map(str, aids))}) AND gender=1",
         # wheres=Q(Q(id__in=aids), Q(gender=1), join_type="AND"),
         # wheres={"id__in": aids, "gender": 1},
         # wheres=[Q(id__in=aids), Q(gender=1)],
@@ -127,7 +127,7 @@ async def update_last_login_view(
             },
             "$.uuid": faker.uuid4(),
         },
-        wheres=f"id = {aid}",
+        wheres=Q(id=aid),
     )
     return {"row_cnt": row_cnt}
 
@@ -158,7 +158,7 @@ async def bulk_clone_view(
     aids: List[int] = Body(..., embed=True),
 ):
     ok = await AccountMgr.insert_into_select(
-        wheres=f"id IN ({', '.join(map(str, aids))})",
+        wheres=Q(id__in=aids),
         remain_fields=["gender", "locale"],
         assign_field_dict={
             "active": False,

fastapi_esql/__init__.py

@@ -17,7 +17,7 @@
     "CursorHandler",
     "RawSQL",
     "SQLizer",
-    "QsParsingError"
+    "QsParsingError",
     "WrongParamsError",
     "timing",
 ]

fastapi_esql/orm/base_app.py

@@ -1,7 +1,5 @@
 from abc import ABCMeta
 
-from .base_model import BaseModel
-
 
 class AppMetaclass(ABCMeta):
 
@@ -25,6 +23,7 @@ def rw_conn(self):
 
     @property
     def table(self):
-        if self.model is BaseModel:
+        db_table = self.model._meta.db_table
+        if not db_table:
             raise NotImplementedError(f"Class attribute `model` was not defined by {self.__name__}!")
-        return self.model._meta.db_table
+        return db_table

fastapi_esql/orm/base_manager.py

@@ -6,7 +6,6 @@
 from tortoise.models import Model
 
 from .base_app import AppMetaclass
-from .base_model import BaseModel
 from ..utils.sqlizer import SQLizer
 from ..utils.cursor_handler import CursorHandler
 
@@ -15,7 +14,7 @@
 
 class BaseManager(metaclass=AppMetaclass):
 
-    model = BaseModel
+    model = Model
 
     @classmethod
     async def get_by_pk(
@@ -98,7 +97,7 @@ async def upsert_json_field(
             wheres,
             cls.model,
         )
-        return await CursorHandler.calc_row_cnt(sql, cls.rw_conn, logger)
+        return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)
 
     @classmethod
     async def upsert_on_duplicated(
@@ -113,7 +112,7 @@ async def upsert_on_duplicated(
             insert_fields,
             upsert_fields,
         )
-        return await CursorHandler.calc_row_cnt(sql, cls.rw_conn, logger)
+        return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)
 
     @classmethod
     async def insert_into_select(
@@ -144,4 +143,4 @@ async def bulk_update_with_fly_table(
             join_fields,
             update_fields,
         )
-        return await CursorHandler.calc_row_cnt(sql, cls.rw_conn, logger)
+        return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)

fastapi_esql/utils/cursor_handler.py

@@ -20,7 +20,7 @@ async def fetch_dicts(
             return None
 
     @classmethod
-    async def calc_row_cnt(
+    async def sum_row_cnt(
         cls,
         sql: str,
         conn: BaseDBAsyncClient,

fastapi_esql/utils/sqlizer.py

@@ -51,15 +51,15 @@ def resolve_wheres(
         return modifier.where_criterion.get_sql(quote_char="`")
 
     @classmethod
-    def resolve_orders(cls, orderings: List[str]) -> str:
-        orders = []
-        for o in orderings:
+    def resolve_orders(cls, orders: List[str]) -> str:
+        orders_ = []
+        for o in orders:
             if o.startswith("-"):
                 order = "DESC"
             else:
                 order = "ASC"
-            orders.append(f"{o.strip('-')} {order}")
-        return ", ".join(orders)
+            orders_.append(f"{o.strip('-')} {order}")
+        return ", ".join(orders_)
 
     @classmethod
     def _sqlize_value(cls, value, to_json=False) -> str:
@@ -234,8 +234,8 @@ def bulk_update_with_fly_table(
         if not all([table, dicts, join_fields, update_fields]):
             raise WrongParamsError("Please check your params")
 
-        joins = [f"{table}.{jf} = tmp.{jf}" for jf in join_fields]
-        updates = [f"{table}.{uf} = tmp.{uf}" for uf in update_fields]
+        joins = [f"{table}.{jf}=tmp.{jf}" for jf in join_fields]
+        updates = [f"{table}.{uf}=tmp.{uf}" for uf in update_fields]
 
         sql = f"""
     UPDATE {table}