SuperAPI AI 工具集

logseq-db-plugin-api

编程与开发

查看项目

更新于 10-16 06:13

技能介绍

用途:为开发 Logseq DB 图谱插件提供系统化指导,内容基于实际插件 logseq-checklist v1.0.0 验证,适用于数据库图谱而非 Markdown 图谱。

主要能力:涵盖标签/类管理、属性处理、块操作等核心 API;用 DB.onChanged 做事件驱动更新与防抖;通过“内容→datascript→属性”多层方式可靠检测标签;迭代未知属性名并按命名空间键(如 :user.property/name)访问;使用 Datalog 查询图谱,包括 or-join 实现标签继承、区分 :block/title 与 :block/name;讨论插件文件组织、设置注册、错误处理、测试与部署等架构实践;并集中列出验证错误、查询无结果、方法名误用等常见陷阱。

使用方式:需 Logseq 0.11.0+、@logseq/libs 0.3.0+、Node.js 18+,建议 Vite 搭配 vite-plugin-logseq。入口用 logseq.ready(main) 注册,开发时运行 pnpm run dev,在 Logseq 设置→插件中加载本地插件目录;生产环境用 pnpm run build。使用属性前先调用 logseq.Editor.upsertProperty 定义类型,添加标签用 addBlockTag();查询用 logseq.DB.datascriptQuery。

适用场景:需要编程创建/管理标签与属性、实时响应数据库变化、Datalog 查询、处理复杂标签检测或属性迭代、并希望采用生产级架构的 Logseq DB 插件。

限制:资料未提供收费、价格或平台等其它信息;不适用于 Markdown/文件式图谱。注意事项包括:勿依赖 block.properties.tags,改为遍历命名空间键;避免使用 created、modified 等保留名,日期用 YYYY-MM-DD;实体引用应通过 Datalog 解引用而非 getPage()。