后端即时通讯【免费下载链接】nonebot2跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python项目地址https://gitcode.com/gh_mirrors/no/nonebot2点击查看免费下载nonebot-plugin-orm是 NoneBot 的官方数据库支持插件基于 SQLAlchemy 与 Alembic 构建为机器人项目提供多数据库后端支持、会话管理、关系模型管理与数据库迁移能力。本指南面向插件使用者而非插件开发者从安装、日常迁移操作到数据库连接配置逐层展开读完即可独立完成安装带数据库的插件、升级/回滚数据库、按插件隔离连接的全部日常操作。阅读前提区分项目名与模块名在开始之前请务必分清两个概念nonebot-plugin-orm的所有 CLI 操作都依赖这一点项目名Project Name用于代码仓库与 PyPI 发布名称以nonebot-plugin-开头、词间用横杠分隔例如nonebot-plugin-wordcloud模块名Module Name用于程序导入以nonebot_plugin_开头、词间用下划线分隔例如nonebot_plugin_wordcloud。在nb orm系列命令中统一使用插件模块名下划线形式。有关命名规范更完整的约定可参见 插件命名规范。快速上手创建一个带数据库插件的机器人假设我们要新建一个机器人并安装一个使用数据库存储数据的插件以nonebot-plugin-wordcloud为例完整步骤如下nb init # 初始化项目文件夹 pip install nonebot-plugin-orm[sqlite] # 安装 nonebot-plugin-orm并附带 SQLite 支持 nb plugin install nonebot-plugin-wordcloud # 安装插件 # nb orm heads # 查看有什么插件使用到了数据库可选 nb orm upgrade # 升级数据库 # nb orm check # 检查一下数据库模式是否与模型定义一致可选 nb run # 启动机器人其中各步骤的含义nb init借助 nb-cli 脚手架生成标准 NoneBot 项目骨架pip install nonebot-plugin-orm[sqlite]安装 ORM 插件本体[sqlite]额外附加 SQLite 异步驱动aiosqlite。nonebot-plugin-orm只提供 ORM 与迁移能力本身不含数据库驱动与后端需按所选数据库另行安装对应 extranb plugin install安装目标插件nb orm upgrade将数据库模式同步到当前所有插件模型的最新状态——安装新插件或升级插件版本后必须执行可选地执行nb orm heads观察各插件对应的迁移分支执行nb orm check验证模式一致性nb run启动机器人。关于数据库驱动的更多说明SQLite / PostgreSQL / MySQL 各自的安装方式与连接串格式见 数据库驱动和后端。卸载插件并删除其数据如果不再需要某个插件且希望连同它的数据一并清除按如下顺序操作nb plugin uninstall nonebot-plugin-wordcloud # 卸载插件 # nb orm heads # 查看有什么插件使用到了数据库。可选 nb orm downgrade nonebot_plugin_wordcloudbase # 降级数据库删除数据 # nb orm check # 检查一下数据库模式是否与模型定义一致可选这里的关键是nb orm downgrade 插件模块名base将指定插件分支回滚到初始状态base从而删除该插件创建的所有表和数据。注意此处的模块名使用下划线形式nonebot_plugin_wordcloud而非项目名nonebot-plugin-wordcloud。CLI 命令详解nb orm是nonebot-plugin-orm暴露给 nb-cli 的迁移命令组下面逐条解析上文示例中出现的命令。heads查看迁移分支头nb orm heads显示所有的迁移分支头branch heads一般一个分支对应一个使用数据库的插件。输出格式为迁移 ID (插件模块名) (头部类型)46327b837dd8 (nonebot_plugin_chatrecorder) (head) 9492159f98f7 (nonebot_plugin_user) (head) 71a72119935f (nonebot_plugin_session_orm) (effective head) ade8cdca5470 (nonebot_plugin_wordcloud) (head)head该分支的最新迁移effective head当前生效的整体头部多分支汇合后的全局最新状态。执行此命令可以快速了解当前安装了哪些使用数据库的插件、各自处于什么迁移版本。upgrade升级数据库nb orm upgrade 插件模块名迁移 ID插件模块名迁移 ID为可选参数。不带参数时将所有分支升级到各自的最新版本这也是最常见的用法nb orm upgrade每次安装新插件或更新插件版本后都需要执行一次不带参数的升级命令将数据库模式同步到与机器人当前代码一致的状态。downgrade降级数据库nb orm downgrade 插件模块名迁移 ID当需要回滚插件版本或删除插件时使用。迁移 ID也可以是base即回滚到初始状态相当于该插件从未创建过数据常用于卸载插件后删除其数据nb orm downgrade 插件模块名basecheck检查模式一致性nb orm check检查数据库模式是否与模型定义一致。若不一致会给出具体的差异例如缺失的表、列等。值得注意的是机器人启动前会自动运行此命令当ALEMBIC_STARTUP_CHECKtrue时并在检查失败时阻止启动——这正是定义了模型但没迁移就启动会报错的机制来源。迁移脚本从何而来upgrade/downgrade所驱动的迁移脚本由 Alembic 自动生成开发插件时通过以下命令创建nb orm revision -m first revision --branch-label weather其中-m是迁移描述--branch-label指定分支一般为插件模块名。生成的脚本位于插件包内的migrations目录记录数据库模式的增量变化脚本主体是upgrade()/downgrade()一对互逆操作分别对应建表与删表等 DDL 语句。因此数据库迁移可以像 git 管理代码一样可复现、可逆地同步模式。官方强烈建议永远检查自动生成的迁移脚本并在开发环境中测试后再执行迁移脚本中的任何错误都可能导致数据丢失。开发阶段若频繁修改模型可临时关闭启动检查.env.devALEMBIC_STARTUP_CHECKfalse此时每次启动机器人都会自动将数据库模式与模型定义同步省去手动迁移的繁琐。配置项详解nonebot-plugin-orm通过 NoneBot 的全局配置.env/.env.prod等读取以下配置项用于控制默认数据库连接与引擎行为。sqlalchemy_database_url默认数据库连接 URL默认数据库连接 URL所有未单独指定绑定的插件含机器人核心都使用此连接SQLALCHEMY_DATABASE_URLdialectdriver://username:passwordhost:port/database连接串采用 SQLAlchemy 标准的dialectdriver格式例如SQLitesqliteaiosqlite:///file_path不指定路径时默认数据库文件为data path/nonebot-plugin-orm/db.sqlite3其中数据目录由nonebot-plugin-localstore提供参见 本地存储PostgreSQLpostgresqlpsycopg://user:passwordhost:port/dbnameMySQL / MariaDBmysqlaiomysql://user:passwordhost:port/dbname。连接串的完整语法约定参考 SQLAlchemy 官方引擎配置 / Database URLs一节。sqlalchemy_bind按插件绑定不同数据库将bind keys一般为插件模块名映射到数据库连接 URL、create_async_engine()参数字典或AsyncEngine实例的字典实现不同插件使用不同数据库的隔离。例如让nonebot-plugin-wordcloud使用一个 SQLite 数据库并开启 Echo 选项便于调试而其他所有插件使用默认的 PostgreSQL 数据库SQLALCHEMY_BINDS{ : postgresqlpsycopg://scott:tigerlocalhost/mydatabase, nonebot_plugin_wordcloud: { url: sqliteaiosqlite://, echo: true } }键为空字符串时对应默认连接即sqlalchemy_database_url的取值键为插件模块名如nonebot_plugin_wordcloud时为该插件单独指定连接值为字符串表示直接给出 URL值为字典表示传给create_async_engine()的参数url与echo等。sqlalchemy_engine_options引擎默认参数作为create_async_engine()的默认参数字典对未在 bind 中单独指定的引擎生效SQLALCHEMY_ENGINE_OPTIONS{ pool_size: 5, max_overflow: 10, pool_timeout: 30, pool_recycle: 3600, echo: true }pool_size连接池保留的连接数默认 5max_overflow连接池满后可额外创建的连接数默认 10pool_timeout等待连接超时秒数默认 30pool_recycle连接回收间隔秒数防止数据库端主动断开闲置连接默认 3600echo打印引擎执行的所有 SQL 语句便于调试。sqlalchemy_echo全局调试开关一键开启 SQL 与连接池日志等价于同时打开引擎的 Echo 与 Echo Pool 选项SQLALCHEMY_ECHOtrue调试完成后建议关闭避免日志刷屏影响性能。配置覆盖优先级以上配置之间存在覆盖关系遵循特殊优先于一般的原则具体优先级为sqlalchemy_database_url sqlalchemy_bind sqlalchemy_echo sqlalchemy_engine_options即sqlalchemy_database_url决定默认连接sqlalchemy_bind可以针对特定插件覆盖默认连接sqlalchemy_echo覆盖全局 echo 行为sqlalchemy_engine_options作为兜底默认参数。由于覆盖顺序并非显而易见官方建议只配置必要的选项避免多个配置项叠加产生难以排查的意外行为。数据库驱动与后端选型nonebot-plugin-orm仅提供 ORM 与迁移能力本身不包含数据库后端与驱动需要按目标数据库另行安装数据库安装命令连接串示例SQLitepip install nonebot-plugin-orm[sqlite]sqliteaiosqlite:///file_pathPostgreSQLpip install nonebot-plugin-orm[postgresql]postgresqlpsycopg://user:passwordhost:port/dbnameMySQL / MariaDBpip install nonebot-plugin-orm[mysql]mysqlaiomysql://user:passwordhost:port/dbnameSQLite轻量嵌入式数据库数据以单文件存储、无需独立后端适合开发环境与小型应用但不建议用于大型生产环境PostgreSQL开源关系数据库中对各类高级功能支持最为完善是中小型应用的首选MySQL / MariaDB经典开源关系数据库同样适合中小型应用。安装并配置完成后执行nb orm upgrade完成首次迁移再执行nb orm check验证若输出没有检测到新的升级操作即可启动机器人。进阶阅读会话、依赖注入与自动化测试用户指南之外nonebot-plugin-orm面向插件开发者的能力同样围绕上述 CLI 与配置展开可作为深入使用的延伸会话管理插件通过async_scoped_session作用域为当前事件与事件响应器或get_session()新会话需手动管理依赖注入获取 ORM 会话配合session.get()、session.add()、session.commit()完成增删改查模型与 ORM 会话不应存入 NoneBot 会话状态参见 开发者指南示例依赖注入Model类可作为依赖直接注入查询结果SQLDepends可将任意 SQL 语句通常为select包装为依赖类型标注决定返回迭代器/标量、单个/多个、连续/分块等数据结构详见 依赖注入多后端测试官方推荐用 GitHub Actions 构建测试矩阵通过SQLALCHEMY_DATABASE_URL环境变量在 SQLite / PostgreSQL / MySQL 三种后端上分别执行nb orm upgrade后运行pytest从而保证插件在不同数据库上的兼容性详见 测试指南。小结对普通用户而言nonebot-plugin-orm的日常使用可以浓缩为四条命令、四个配置项命令nb orm heads查看分支→nb orm upgrade升级→nb orm downgrade 模块名base回滚/删数据→nb orm check校验配置SQLALCHEMY_DATABASE_URL默认连接、SQLALCHEMY_BINDS按插件绑定、SQLALCHEMY_ENGINE_OPTIONS引擎默认参数、SQLALCHEMY_ECHO调试开关优先级依次递减。牢记项目名用横杠、模块名用下划线在安装新插件后执行一次nb orm upgrade即可让机器人数据库始终与代码保持一致。赞分享后端即时通讯【免费下载链接】nonebot2跨平台 Python 异步聊天机器人框架 / Asynchronous multi-platform chatbot framework written in Python项目地址https://gitcode.com/gh_mirrors/no/nonebot2点击查看免费下载相关推荐NoneBot 2 用户指南基于 nonebot-plugin-orm 的数据库安装、迁移与配置实战NoneBot 2 用户指南基于 nonebot plugin orm 的数据库安装、迁移与配置实战 导读 nonebot plugin orm 是 None后端即时通讯NoneBot 插件开发实战nonebot-plugin-orm 依赖注入完全指南NoneBot 插件开发实战nonebot plugin orm 依赖注入完全指南 本篇指南围绕 nonebot plugin orm 提供的数据库依赖注入能后端即时通讯NoneBot2 插件数据库开发指南使用 nonebot-plugin-orm 实现模型、迁移与依赖注入NoneBot2 插件数据库开发指南使用 nonebot plugin orm 实现模型、迁移与依赖注入 本篇指南围绕 NoneBot2 生态中的数据库支持插后端即时通讯上一篇Kneed插值方法对比interp1d与polynomial哪个更适合你的数据下一篇BetterDiscord插件设置界面使用Settings组件构建配置页创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考