feat(backend): mysql/tendb的webconsole添加时区和字符集查询 #11233

Author: huangwentai-wendel

dbm-ui/backend/db_services/dbbase/cluster/handlers.py

@@ -366,13 +366,17 @@ def _get_instance_objs(self, instances: List[DBInstance]):
         return instance_objs
 
     @staticmethod
-    def console_rpc(instances: list, cmd: str, db_query: bool, rpc_function: Callable, is_check: bool = True):
+    def console_rpc(
+        instances: list, cmd: str, db_query: bool, rpc_function: Callable, is_check: bool = True, **options
+    ):
         """
         通用的RPC命令执行器，只支持select语句
         @param instances: 实例信息
         @param cmd: 执行命令
         @param db_query: 是否只允许查询系统库 -- DB自助查询
         @param rpc_function: 用于执行RPC请求的函数
+        @param is_check: 校验select语句
+        @param options: 操作合集项
         """
         # 校验select语句
         if is_check:
@@ -387,11 +391,15 @@ def console_rpc(instances: list, cmd: str, db_query: bool, rpc_function: Callabl
         instance_rpc_results: List = []
 
         if ClusterServiceHandler.__check_special_sql(cmd):
-            instance_rpc_results = ClusterServiceHandler.__dbconsole_special_query(bk_cloud__instances_map, cmd)
+            instance_rpc_results = ClusterServiceHandler.__dbconsole_special_query(
+                bk_cloud__instances_map, cmd, **options
+            )
         else:
             for bk_cloud_id, addresses in bk_cloud__instances_map.items():
                 # 使用传入的rpc_function进行rpc调用
-                rpc_results = rpc_function({"bk_cloud_id": bk_cloud_id, "addresses": addresses, "cmds": [cmd]})
+                params = {"bk_cloud_id": bk_cloud_id, "addresses": addresses, "cmds": [cmd]}
+                params.update(options)
+                rpc_results = rpc_function(params)
 
                 cmd_results = [
                     {
@@ -406,7 +414,7 @@ def console_rpc(instances: list, cmd: str, db_query: bool, rpc_function: Callabl
         return instance_rpc_results
 
     @classmethod
-    def __dbconsole_special_query(cls, bk_cloud__instances_map, cmd):
+    def __dbconsole_special_query(cls, bk_cloud__instances_map, cmd, **options):
         """
         用于dbaconsole的特殊查询，目前复用webconsole，因此不支持单次多条查询
         webconsole账户也不支持查询主从同步信息
@@ -439,7 +447,9 @@ def __dbconsole_special_query(cls, bk_cloud__instances_map, cmd):
 
         instance_rpc_results: List = []
         for bk_cloud_id, addresses in bk_cloud__instances_map.items():
-            rpc_results = DRSApi.rpc({"bk_cloud_id": bk_cloud_id, "addresses": addresses, "cmds": cmds})
+            params = {"bk_cloud_id": bk_cloud_id, "addresses": addresses, "cmds": cmds}
+            params.update(options)
+            rpc_results = DRSApi.rpc(params)
             cmd_results = [
                 {
                     "instance": res["address"],

dbm-ui/backend/db_services/dbbase/serializers.py

@@ -190,13 +190,18 @@ class Meta:
 
 
 class WebConsoleSerializer(serializers.Serializer):
+    class OptionsSerializer(serializers.Serializer):
+        time_zone = serializers.CharField(help_text=_("时区"), default="utc+8")
+        character_set = serializers.CharField(help_text=_("字符集"), default="default")
+
     cluster_id = serializers.IntegerField(help_text=_("集群ID"))
     cmd = serializers.CharField(help_text=_("sql语句"))
     # redis 额外参数
     db_num = serializers.IntegerField(help_text=_("数据库编号(redis 额外参数)"), required=False)
     raw = serializers.BooleanField(help_text=_("源编码(redis 额外参数)"), required=False)
     # mongodb 额外参数
     session_time = DBTimezoneField(help_text=_("会话创建时间(mongodb 额外参数)"), required=False)
+    options = OptionsSerializer(help_text=_("额外操作项合集"), required=False, default={})
 
 
 class DBConsoleSerializer(serializers.Serializer):

dbm-ui/backend/db_services/dbbase/views.py

@@ -332,6 +332,10 @@ def webconsole(self, request):
 
         # mysql / tendbcluster
         if db_type in [DBType.MySQL, DBType.TenDBCluster]:
+            if not data.get("options", {}).get("time_zone"):
+                data["options"]["time_zone"] = "+8:00"
+            if not data.get("options", {}).get("character_set"):
+                data["options"]["character_set"] = "default"
             data = RemoteServiceHandler(bk_biz_id=cluster.bk_biz_id).webconsole_rpc(**data)
         # redis
         elif db_type in ClusterType.redis_cluster_types():

dbm-ui/backend/db_services/mysql/remote_service/handlers.py

@@ -284,7 +284,7 @@ def webconsole_rpc(self, cluster_id: int, cmd: str, **kwargs):
         try:
             instances = [{"bk_cloud_id": cluster.bk_cloud_id, "instance": remote_address}]
             rpc_results = ClusterServiceHandler.console_rpc(
-                instances, cmd, db_query=False, rpc_function=DRSApi.webconsole_rpc
+                instances, cmd, db_query=False, rpc_function=DRSApi.webconsole_rpc, **kwargs
             )
             return {"query": rpc_results[0]["table_data"], "error_msg": rpc_results[0]["error_msg"]}
         except SQLParseBaseException as e: