feat✨: 添加shortcut和usage

zhenxun/builtin_plugins/superuser/exec_sql.py

@@ -1,18 +1,9 @@
+from nonebot import on_command
 from nonebot.permission import SUPERUSER
 from nonebot.plugin import PluginMetadata
 from nonebot.rule import to_me
-from nonebot_plugin_alconna import (
-    Alconna,
-    AlconnaQuery,
-    Args,
-    Arparma,
-    Match,
-    Option,
-    Query,
-    on_alconna,
-    store_true,
-)
-from nonebot_plugin_saa import Text
+from nonebot_plugin_alconna import UniMsg
+from nonebot_plugin_saa import Image, Text
 from nonebot_plugin_session import EventSession
 from tortoise import Tortoise
 
@@ -20,6 +11,7 @@ from zhenxun.configs.utils import PluginExtraData
 from zhenxun.services.db_context import TestSQL
 from zhenxun.services.log import logger
 from zhenxun.utils.enum import PluginType
+from zhenxun.utils.image_utils import ImageTemplate
 
 __plugin_meta__ = PluginMetadata(
     name="数据库操作",
@@ -35,44 +27,59 @@ __plugin_meta__ = PluginMetadata(
     ).dict(),
 )
 
-
-_matcher = on_alconna(
-    Alconna(
-        "exec",
-        Args["sql?", str],
-        Option("-l|--list", action=store_true, help_text="查看数据表"),
-    ),
+_matcher = on_command(
+    "exec",
     rule=to_me(),
     permission=SUPERUSER,
     priority=1,
     block=True,
 )
 
+_table_matcher = on_command(
+    "查看所有表",
+    rule=to_me(),
+    permission=SUPERUSER,
+    priority=1,
+    block=True,
+)
+
+SELECT_TABLE_SQL = """
+select a.tablename as name,d.description as desc from pg_tables a
+    left join pg_class c on relname=tablename
+    left join pg_description d on oid=objoid and objsubid=0 where a.schemaname = 'public'
+"""
+
 
 @_matcher.handle()
-async def _(
-    sql: Match[str],
-    session: EventSession,
-    arparma: Arparma,
-    query_list: Query[bool] = AlconnaQuery("list.value", False),
-):
-    db = Tortoise.get_connection("default")
-    if query_list.result:
-        query = await db.execute_query_dict(
-            "select tablename from pg_tables where schemaname = 'public'"
-        )
-        msg = "数据库中的所有表名：\n"
-        for tablename in query:
-            msg += str(tablename["tablename"]) + "\n"
-        logger.info("查看数据库所有表", arparma.header_result, session=session)
-        await Text(msg[:-1]).finish()
-    else:
-        if not sql.available:
-            await Text("必须带有需要执行的 SQL 语句...").finish()
-        sql_text = sql.result
+async def _(session: EventSession, message: UniMsg):
+    sql_text = message.extract_plain_text().strip()
+    if sql_text.startswith("exec"):
+        sql_text = sql_text[4:]
+    logger.info(f"执行SQL语句: {sql_text}", "exec", session=session)
+    try:
         if not sql_text.lower().startswith("select"):
             await TestSQL.raw(sql_text)
-            await Text("执行 SQL 语句成功!").finish()
         else:
+            db = Tortoise.get_connection("default")
             res = await db.execute_query_dict(sql_text)
-            # TODO: Alconna空格sql无法接收
+    except Exception as e:
+        logger.error("执行 SQL 语句失败...", session=session, e=e)
+        await Text(f"执行 SQL 语句失败... {type(e)}").finish()
+    await Text("执行 SQL 语句成功!").finish()
+
+
+@_table_matcher.handle()
+async def _(session: EventSession):
+    try:
+        db = Tortoise.get_connection("default")
+        query = await db.execute_query_dict(SELECT_TABLE_SQL)
+        column_name = ["表名", "简介"]
+        data_list = []
+        for table in query:
+            data_list.append([table["name"], table["desc"]])
+        logger.info("查看数据库所有表", "查看所有表", session=session)
+        table = await ImageTemplate.table_page("数据库表", "", column_name, data_list)
+        await Image(table.pic2bs4()).send()
+    except Exception as e:
+        logger.error("获取表数据失败...", session=session, e=e)
+        await Text(f"获取表数据失败... {type(e)}").send()