feat: add merge_dict, remove_paths & json_type to update_json_field

Author: NightMarcher

README.md

@@ -77,25 +77,31 @@ Generate sql and execute
     LIMIT 10
 ```
 
-### **upsert_json_field**
+### **update_json_field**
 ```python
-await AccountMgr.upsert_json_field(
+await AccountMgr.update_json_field(
     json_field="extend",
+    wheres=Q(id=8),
+    merge_dict={
+        "updated_at": "2022-10-30 21:34:15",
+        "info": {
+            "online_sec": 636,
+        }
+    },
     path_value_dict={
         "$.last_login": {
             "ipv4": "209.182.101.161",
-            "start_datetime": "2022-10-16 11:11:05",
-            "online_sec": 4209,
         },
         "$.uuid": "fd04f7f2-24fc-4a73-a1d7-b6e99a464c5f",
     },
-    wheres=Q(id=8),
+    remove_paths=["$.deprecated"],
+    json_type=dict,
 )
 ```
 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')
+    UPDATE account SET extend =
+    JSON_MERGE_PATCH(JSON_SET(JSON_REMOVE(COALESCE(extend, '{}'), '$.deprecated'), '$.last_login',CAST('{"ipv4": "209.182.101.161"}' AS JSON), '$.uuid','fd04f7f2-24fc-4a73-a1d7-b6e99a464c5f'), '{"updated_at": "2022-10-30 21:34:15", "info": {"online_sec": 636}}')
     WHERE `id`=8
 ```
 

examples/service/routers/account.py

@@ -116,17 +116,23 @@ async def update_last_login_view(
     aid: int = Query(...),
 ):
     faker = Faker()
-    row_cnt = await AccountMgr.upsert_json_field(
+    row_cnt = await AccountMgr.update_json_field(
         json_field="extend",
+        wheres=Q(id=aid),
+        merge_dict={
+            "updated_at": str(faker.past_datetime()),
+            "info": {
+                "online_sec": faker.random_int(),
+            }
+        },
         path_value_dict={
             "$.last_login": {
                 "ipv4": faker.ipv4(),
-                "start_datetime": str(faker.past_datetime()),
-                "online_sec": faker.random_int(),
             },
             "$.uuid": faker.uuid4(),
         },
-        wheres=Q(id=aid),
+        remove_paths=["$.deprecated"],
+        json_type=dict,
     )
     return {"row_cnt": row_cnt}
 

fastapi_esql/orm/base_manager.py

@@ -83,17 +83,23 @@ async def select_custom_fields(
         return await CursorHandler.fetch_dicts(sql, conn, logger)
 
     @classmethod
-    async def upsert_json_field(
+    async def update_json_field(
         cls,
         json_field: str,
-        path_value_dict: Dict[str, Any],
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        merge_dict: Optional[Dict[str, Any]] = None,
+        path_value_dict: Optional[Dict[str, Any]] = None,
+        remove_paths: Optional[List[str]] = None,
+        json_type: type = dict,
     ):
-        sql = SQLizer.upsert_json_field(
+        sql = SQLizer.update_json_field(
             cls.table,
             json_field,
-            path_value_dict,
             wheres,
+            merge_dict,
+            path_value_dict,
+            remove_paths,
+            json_type,
             cls.model,
         )
         return await CursorHandler.sum_row_cnt(sql, cls.rw_conn, logger)

fastapi_esql/utils/sqlizer.py

@@ -121,25 +121,38 @@ def select_custom_fields(
         return sql
 
     @classmethod
-    def upsert_json_field(
+    def update_json_field(
         cls,
         table: str,
         json_field: str,
-        path_value_dict: Dict[str, Any],
         wheres: Union[str, Q, Dict[str, Any], List[Q]],
+        merge_dict: Optional[Dict[str, Any]] = None,
+        path_value_dict: Optional[Dict[str, Any]] = None,
+        remove_paths: Optional[List[str]] = None,
+        json_type: type = dict,
         model: Optional[Model] = None,
     ) -> Optional[str]:
-        if not all([table, json_field, path_value_dict, wheres]):
+        if not all([table, json_field, wheres]):
+            raise WrongParamsError("Please check your params")
+        if not any([merge_dict, path_value_dict, remove_paths]):
             raise WrongParamsError("Please check your params")
 
-        params = []
-        for (path, value) in path_value_dict.items():
-            params.append(f"'{path}'")
-            params.append(cls._sqlize_value(value, to_json=True))
+        json_obj = f"COALESCE({json_field}, '{json_type()}')"
+        if remove_paths:
+            rps = ", ".join(f"'{p}'" for p in remove_paths)
+            json_obj = f"JSON_REMOVE({json_obj}, {rps})"
+        if path_value_dict:
+            pvs = [
+                f"'{path}',{cls._sqlize_value(value, to_json=True)}"
+                for (path, value) in path_value_dict.items()
+            ]
+            json_obj = f"JSON_SET({json_obj}, {', '.join(pvs)})"
+        if merge_dict:
+            json_obj = f"JSON_MERGE_PATCH({json_obj}, {cls._sqlize_value(merge_dict)})"
 
         sql = f"""
-    UPDATE {table}
-    SET {json_field} = JSON_SET(COALESCE({json_field}, '{{}}'), {", ".join(params)})
+    UPDATE {table} SET {json_field} =
+    {json_obj}
     WHERE {cls.resolve_wheres(wheres, model)}"""
         logger.debug(sql)
         return sql