插件获取/调用/建立数据库(GsData.db)简单

字数统计:992 字

阅读时长:3 分钟

💡 提醒

💡强烈推荐使用该方法去写数据库，基类提供了大部分较为常用的数据库方法（增删改查）

继承已经写好的基类，可以在较少代码量的前提下，生成专属插件的表并共享所有基类方法

有非常多额外的扩展方法（实现bot_id管理、多uid绑定、随机调用CK等等）

第一步、继承基类，建立自己的表

参考

from typing import Optional
from sqlmodel import Field

from gsuid_core.utils.database.base_models import Bind, User

class WzryBind(Bind, table=True):
    # 注意，这里的列名无需新增id等基类已经有的列，只需要根据自己实际需求新增列名即可
    # 具体基类有什么列可以点进Bind类去查看
    uid: Optional[str] = Field(default=None, title='王者荣耀UID')


class WzryUser(User, table=True):
    uid: Optional[str] = Field(default=None, title='王者荣耀UID')

第二步、调用方法

参考

import asyncio
from ..utils.database.models import WzryBind

async def main():
    # 注意，继承不同基类的表，方法可能不同，建议使用VSC查看所有方法，以及所有入参
    # GsCore完全使用TypeHint进行类型判断，如果VSC中代码用红线标注，务必查看函数入参，确保修改正确
	await WzryBind.insert_uid(qid, ev.bot_id, uid, ev.group_id)

asyncio.run(main())

第三步、（可选）映射数据库到网页控制台

参考

from gsuid_core.webconsole.mount_app import PageSchema, GsAdminModel, site

# 注意，管理模型【一定】要携带@site.register_admin
# 否则【无需管理员账户】也能在网页控制台中【看到该表并修改】
@site.register_admin
class WzryBindadmin(GsAdminModel): # 一定要继承自GsAdminModel
    pk_name = 'id' # 一般无需修改，代表主键映射
    #label自定义，icon可参考https://fontawesome.com/v4/icons/
    page_schema = PageSchema(label='王者绑定管理', icon='fa fa-users')

    # 配置管理模型
    model = WzryBind # 填入第一步中继承的模型即可


@site.register_admin
class WzryUseradmin(GsAdminModel):
    pk_name = 'id'
    page_schema = PageSchema(label='王者CK管理', icon='fa fa-database')

    # 配置管理模型
    model = WzryUser

额外、继承Base_Model

💡 提醒

💡在上面从gsuid_core.utils.database.base_models 继承基础的 Bind, User，Push，Cache表时，你可能会注意到一丝命名风格不舒服， 比如：

• 默认会有几列预设的列名，例如uid, cookie等等。
• 默认的方法名称为select_data_by_uid等等。

这是由于预设的四大表是基于游戏工具的视角设计，包含了大多数游戏工具应有的列和方法，但如果你写的插件和游戏类无关，那么这些列和默认方法就会比较碍眼。

GsCore当然也提供了更上游的基类以供继承，下面是具体代码。

演示参考如下 ⬇

from typing import Optional

from sqlmodel import Field

from gsuid_core.utils.database.base_models import BaseModel, with_session

# 创建类时传参带上`table=True`才是建表，否则只是Python内部的类继承，不会实际建立表格
class MyTable(BaseModel, table=True):
    # 注意，这里的列名无需新增id等基类已经有的列，只需要根据自己实际需求新增列名即可
    # 具体基类有什么列可以点进BaseModel类去查看
    city: Optional[str] = Field(default=None, title='城市')

    # 示例一个类方法
    @classmethod
    @with_session
    async def get_user_city(
        cls,
        session: AsyncSession,
        user_id: str,
    ) -> Optional[str]:
        '''根据传入`user_id`，判定是否绑定城市'''
        data = await cls.select_data(user_id)
        return data.city if data else None

实例参考 ⬇

class MajsPaipu(BaseIDModel, table=True):
    account_id: str = Field(default="", title="雀魂账号ID")
    uuid: str = Field(default="", title="牌谱UUID")
    paipu_type: int = Field(default=-1, title="牌谱类型")
    paipu_type_name: str = Field(default="", title="牌谱类型名称")

    @classmethod
    @with_session
    async def insert_data(
        cls: Type[T_MajsPaipu],
        session: AsyncSession,
        uuid: str,
        account_id: str,
        paipu_type: int,
        paipu_type_name: str,
    ) -> int:
        return await cls.full_insert_data(
            uuid=uuid,
            account_id=account_id,
            paipu_type=paipu_type,
            paipu_type_name=paipu_type_name,
        )

    @classmethod
    @with_session
    async def data_exist(
        cls: Type[T_MajsPaipu], session: AsyncSession, uuid: str
    ) -> bool:
        stmt = select(cls).where(cls.uuid == uuid)
        result = await session.execute(stmt)
        data = result.scalars().all()
        return bool(data)