[思源笔记挂件] Query: 一个将思源笔记数据库查询结果以表格样式渲染的挂件

项目地址: Zuoqiu-Yingyi/widget-query

本文章不会与项目文档同步更新, 可能已经过时, 具体内容请以项目的 README 为准

一个将思源笔记数据库查询结果以表格样式渲染的挂件

现已上架思源笔记社区集市, 如果您需要订阅思源笔记增值服务，欢迎使用我的推荐码: h0sc9rc

预览 | PREVIEW

功能 | FUNCTION

符合正则表达式 ^\s*SELECT\s+\*\s+FROM\s+blocks.* 的 SQL 语句将启用自定义渲染模式
- 这个正则表达式在 /src/script/module/config.js 中的 config.query.regs.blocks 配置
自定义渲染模式 | Custom rendering modes
- 可以在 config.query.limit 中设置过长查询结果的截取方案
  - config.query.maxlen: 最大长度
  - config.query.maxrow: 最多行数
- 可以在 config.query.fields 中设置想要显示的字段
- 可以在 config.query.align 中设置各字段的对齐方式
- 可以在 config.query.handler 中设置各字段的处理方法
部分模板字段解析支持
- .prefix{.field}
  - prefix: 前缀字段
    - block: 挂件块
    - parent: 挂件块的上级块
    - root: 挂件块所在文档块
  - field: 属性字段
    - 数据库中 blocks 表的字段名
普通模式
- 完整显示查询结果

自定义配置 | CUSTOM CONFIG

创建文件 <工作空间>/data/widgets/custom.js
在文件 <工作空间>/data/widgets/custom.js 中定义的值将覆盖 <工作空间>/widgets/Query/src/script/module/config.js 中对应的值

配置示例 | CONFIG EXAMPLE

/* 路径 | Path
 * <工作空间>/data/widgets/custom.js
 * <workspace>/data/widgets/custom.js
 */

import {
    cutString,
    ReplaceSpace,
    ReplaceCRLF,
    ialParser,
    markdown2span,
    timestampFormat,
    isEmptyString,
} from '/widgets/Query/src/script/utils/string.js';

import {
    templateParse
} from '/widgets/Query/src/script/utils/templateParser.js'

export var config = {
    token: '', // API token, 无需填写
    query: { // 查询配置
        width: '128px', // 宽度
        height: '32px', // 高度
        radius: '8px', // 圆角
        regs: {
            blocks: /^\s*SELECT\s+\*\s+FROM\s+blocks.*/i, // 块查询的正则表达式
        },
        maxlen: 64, // 查询结果每个字段最大长度
        maxrow: 3, // 查询结果每个字段最大行数
        limit: 'row', // 查询结果字段限制, (null 为不限制, 'len' 为限制长度, 'row' 为限制行数)
        CRLF: '<br />', // 换行符替换
        space: ' ', // 空白字符替换
        template: { // 类似模板字段解析支持, 类似 .prefix{.field}, 目前支持的有 .root{.<挂件所在文档块的字段名>} .parent{.<挂件上级块的字段名>} .block{挂件块的字段名}
            enable: true, // 是否启用模板解析
            handler: async (data) => { // 模板解析处理函数
                return await templateParse(data);
            }
        },
        fields: [ // 需渲染的 blocks 表的字段, 顺序分先后
            // 'content', // 去除了 Markdown 标记符的文本
            'markdown', // 包含完整 Markdown 标记符的文本
            'created', // 创建时间
            'updated', // 更新时间
            'type', // 内容块类型，参考((20210210103523-ombf290 "类型字段"))
            'hpath', // 人类可读的内容块所在文档路径

            // 'id', // 内容块 ID
            // 'parent_id', // 双亲块 ID, 如果内容块是文档块则该字段为空
            // 'root_id', // 文档块 ID
            // 'box', // 笔记本 ID
            // 'path', // 内容块所在文档路径
            // 'name', // 内容块名称
            // 'alias', // 内容块别名
            // 'memo', // 内容块备注
            // 'hash', // content 字段的 SHA256 校验和
            // 'length', // markdown 字段文本长度
            // 'subtype', // 内容块子类型，参考((20210210103411-tcbcjja "子类型字段"))
            // 'ial', // 内联属性列表，形如 `{: name="value"}`
            // 'sort', // 排序权重, 数值越小排序越靠前
        ],
        align: { // 查询结果字段对齐样式(':-' 左对齐, ':-:' 居中, '-:' 右对齐)
            content: ':-',
            markdown: ':-',
            created: ':-:',
            updated: ':-:',
            type: ':-:',
            hpath: ':-',

            id: ':-:',
            parent_id: ':-:',
            root_id: ':-:',
            hash: ':-:',
            box: ':-:',
            path: ':-',
            name: ':-',
            alias: ':-',
            memo: ':-',
            length: '-:',
            subtype: '-:',
            ial: ':-',
            sort: '-:',
        },
        default: {
            handler: (row) => { // 其他查询结果默认处理方法
                return `\`${row[key]}\``;
            },
        },
        handler: { // 块查询结果各字段处理方法
            content: (row) => {
                switch (config.query.limit) {
                    case 'len':
                        return markdown2span(cutString(ReplaceSpace(row.content, config.query.space), config.query.maxlen));
                    case 'row':
                        return markdown2span(ReplaceCRLF(cutString(row.content, undefined, config.query.maxrow), config.query.CRLF));
                    default:
                        return markdown2span(row.content);
                }
            },
            markdown: (row) => {
                switch (config.query.limit) {
                    case 'len':
                        return markdown2span(cutString(ReplaceSpace(row.markdown, config.query.space), config.query.maxlen));
                    case 'row':
                        return markdown2span(ReplaceCRLF(cutString(row.markdown, undefined, config.query.maxrow), config.query.CRLF));
                    default:
                        return markdown2span(row.markdown);
                }
            },
            created: (row) => {
                return timestampFormat(row.created);
            },
            updated: (row) => {
                return timestampFormat(row.updated);
            },
            type: (row) => {
                return `((${row.id} "${config.query.map.blocktype[row.type]}"))`;
            },
            hpath: (row) => {
                return `((${row.root_id} "${row.hpath}"))`;
            },

            id: (row) => {
                return `((${row.id} "${row.id}"))`;
            },
            parent_id: (row) => {
                if (isEmptyString(row.parent_id)) return '';
                else return `((${row.parent_id} "${row.parent_id}"))`;
            },
            root_id: (row) => {
                return `((${row.root_id} "${row.root_id}"))`;
            },
            hash: (row) => {
                return `\`${row.hash}\``;
            },
            box: (row) => {
                return `\`${row.box}\``;
            },
            path: (row) => {
                return `\`${row.path}\``;
            },
            name: (row) => {
                return markdown2span(row.name);
            },
            alias: (row) => {
                return markdown2span(row.alias);
            },
            memo: (row) => {
                return markdown2span(row.memo);
            },
            length: (row) => {
                return row.length;
            },
            subtype: (row) => {
                return config.query.map.subtype[row.subtype];
            },
            ial: (row) => {
                let ial = ialParser(row.ial);
                let ial_markdown = [];
                for (let key of Object.keys(ial)) {
                    switch (key) {
                        case 'id':
                        case 'updated':
                            continue;
                        case 'icon':
                            ial_markdown.push(`\`${key}\`\: :${ial[key].replace(/\.\w+$/, '')}:`);
                            break;
                        default:
                            ial_markdown.push(`\`${key}\`\: \`${ial[key]}\``);
                            break;
                    }
                }
                return ial_markdown.join(config.query.CRLF);
            },
            sort: (row) => {
                return row.sort;
            },
        },
        map: { // 映射表
            blocktype: { // 块类型映射
                d: '文档块',
                h: '标题块',
                l: '列表块',
                i: '列表项',
                c: '代码块',
                m: '公式块',
                t: '表格块',
                b: '引述块',
                s: '超级块',
                p: '段落块',
                tb: '分隔线',
                video: '视频块',
                audio: '音频块',
                widget: '挂件块',
                iframe: 'iframe',
                query_embed: '嵌入块',
                '': '',
                null: '',
                undefined: '',
            },
            subtype: { // 子类型映射
                o: '有序列表',
                u: '无序列表',
                t: '任务列表',
                h1: '一级标题',
                h2: '二级标题',
                h3: '三级标题',
                h4: '四级标题',
                h5: '五级标题',
                h6: '六级标题',
                '': '',
                null: '',
                undefined: '',
            },
        },
    },
};

开始 | START

该挂件已在思源笔记社区集市上架, 可直接在集市中安装

参考 & 感谢 | REFERENCE & THANKS

作者 \| Author	项目 \| Project	许可证 \| License
leolee9086	leolee9086/cc-baselib	Unknown

更改日志 | CHANGE LOG

CHANGE LOG

在行级公式前面加上 `$$` 转成公式块

单独占据一行的行级公式块前加上 $$ 可以转成公式块，但是这个功能好像存在一点问题，就是会将整个公式的 span 都放入公式块里面。不知道这个是设计如此还是后来出了 bug。（或者这整个功能就是 bug）附上录屏如下。 [视频] 录屏里面有用插件，但是我记得在没有插件时候我就这样用了。试了一下插件最大的影响就是把 _ ..

思源笔记丨动态图标使用笔记

思源笔记 v3.1.11 支持了动态图标：Add internal kernel API `/api/icon/getDynamicIcon` by Achuan-2 · Pull Request #12939 · siyuan-note/siyuan 这篇帖子分享下如何用链接传参的方式使用动态图标，选择图标样式、颜色 ..

数据库视图多选粘贴优化建议

在迁移 notion 中的数据时，思源中的粘贴效果较为不错，但是多选的粘贴似乎不能自动分隔选项。 [图片] 此处仅展示了单个框框，多个记录复制粘贴的时候也是一样的效果，希望可以优化一下。使其自动根据逗号或者空格分割成多个选项。

思源笔记 v3.1.11 发布，改进细节

概述该版本修复了一些缺陷，并改进了很多细节，其中比较重要的是改进了数据同步、文档树和反链面板。变更记录以下是此版本中的详细变更。改进功能 [链接] [链接] [链接] [链接] [链接] [链接] [链接] 数据库资源字段的本地资源支持重命名图片标题支持换行拖动文件时指示插入位置数据库单元格支持垂直拖动 ..

思源能不能把浏览器的浏览网页的功能补全，在写文档过程中，频繁切浏览器和思源的窗口，效率好低

比如在 mac 上，向系统注册浏览网页的接口，让思源有能力成为默认浏览器比如支持 iframe 里面，打里面的链接，可以在新标签页打开新的链接比如正常浏览的时候，遇到有微信登录的界面，不会调到默认浏览器上，导致没法继续。比如支持新建标签页的时候输入网址等比如在 iframe 或者新建标签页浏览的时候，支持右键菜 ..

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

关于

SELECT * FROM blocks WHERE id IN ( SELECT block_id FROM attributes WHERE name = 'custom-class' AND value = 'report' ) AND id IN ( SELECT block_id FROM attributes WHERE name = 'custom-status' AND value = 'finish' )

17 回帖

[思源笔记挂件] Query: 一个将思源笔记数据库查询结果以表格样式渲染的挂件

注册关于

请输入回帖内容 ...

larryggao • 2 年前
订阅者付费者支持者

思源真正有价值的挂件终于出来了！

感谢作者~
crowds21 • 2 年前
订阅者付费者

牛逼
mozhu • 2 年前
订阅者付费者支持者捐赠者

孩子用上了，很喜欢
PiChou • 2 年前
订阅者付费者

妙啊 😁
SyTlr • 2 年前
订阅者

大佬牛啤！

这里有个小反馈，希望采纳一下：https://github.com/siyuan-note/bazaar/issues/294#issue-1131535066

1 回复
shuoying • 2 年前
订阅者支持者捐赠者恶龙作者

已修复: 默认块查询结果应排除自身
abumn • 2 年前

这个挂件真的很不错啊
vitalQ • 2 年前 • 1 评论
付费者
只查文档块的 sql 要怎么写，我写了
```
select * from blocks where type = '文档块'
```
貌似是不行的
1 回复

select * from blocks where type = 'd', 详情请参考思源数据库表与字段 · 语雀

shuoying • 2 年前
shuoying • 2 年前
订阅者支持者捐赠者恶龙作者

type = 'd', 详情请参考思源数据库表与字段- blocks | 内容块 - 语雀
RenaEmiya • 2 年前
订阅者

想请教一下，可以支持自定义属性的查询吗，比如我给某个块增加了"birthday"的属性，在思源里实际属性是"custom-birthday"。

然后我在 query 挂件块的 query-fields 里写入["hpath", "type","custom-birthday"]，似乎是无法渲染的。

1 回复
akaCarlo • 1 年前 • 1 评论
订阅者

当返回内容大于 11 条时，返回的表格仅显示前 11 条，并可以通过滚动条显示其余的内容。

将表格的自定义块属性 custom-render 的属性值设置为一个不是 scroll 的值即可

shuoying • 1 年前
akaCarlo • 1 年前
订阅者

当返回内容大于 11 条时，返回的表格折叠仅显示前 11 条，并可以通过滚动条显示其余的内容。如何让返回结果不折叠，显示全部的内容呢？
shuoying • 1 年前
订阅者支持者捐赠者恶龙作者
思源的块属性保存在 attributes 表里面, 因此想要查询自定义块属性需要使用类似如下 SQL 进行查询:
```
SELECT * FROM blocks WHERE id in (SELECT a.block_id FROM attributes AS a WHERE a.name = 'custom-birthday')
```
akaCarlo • 1 年前
订阅者

感谢前面的回答，再请教下，如果通过搜索自定义属性，返回同时满足两项自定义属性的内容，比如说 custom-class 为 report，与此同时 custom-status 为 finish

1 回复

shuoying • 1 年前

订阅者支持者捐赠者恶龙作者

上述 SQL 语句我没有测试过, 不过应该可以满足要求

clx92clx • 1 年前 • 1 评论

大佬，插件是否支持 JOIN 语法

支持

shuoying • 1 年前
jzman • 9 个月前
付费者

请教一下，Query 挂件有没有这种 markdown 样式的任务样式渲染出来，案例如下：

渲染后的样式：

将渲染后的样式填充到 Query 挂件的表格中。

[思源笔记挂件] Query: 一个将思源笔记数据库查询结果以表格样式渲染的挂件

widget-query

预览 | PREVIEW

功能 | FUNCTION

自定义配置 | CUSTOM CONFIG

配置示例 | CONFIG EXAMPLE

开始 | START

参考 & 感谢 | REFERENCE & THANKS

更改日志 | CHANGE LOG

相关帖子

在行级公式前面加上 `$$` 转成公式块

页面删除

思源笔记丨动态图标使用笔记

数据库视图多选粘贴优化建议

思源笔记 v3.1.11 发布，改进细节

嵌套表格、单元格外观可单独设置，这些表格特性，绝对不可能在思源里实现吗？

思源能不能把浏览器的浏览网页的功能补全，在写文档过程中，频繁切浏览器和思源的窗口，效率好低

欢迎来到这里！