[思源笔记挂件] 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

关于 docker 端的发布功能

试了一下软件版的发布，是没有问题的。打开区域网段 +6808 是没问题的然后又用 docker 端的发布，就打不开了， [图片] [图片] [图片] 而且我给内网做了穿透，这样就可以分享笔记了。发布可以让别人没办法编辑

底部反链与笔记整理的问题

[图片] 我有一段文本用块引关联多个主题，当我在主题 1 中整理该段文本的时候，该怎么做比较好。是把该文本复制到主题 1 中，然后删除主题 1 的反链吗？各位大佬都是怎么处理的，听听大家想法

分享一套个人会员账号订阅管理的数据库模板

[图片] 如图，之前一直用 notion 管理，现在非常热衷于 All in Siyuan，用 chatgpt 4 帮忙搞了一套数据库模板，分享给大家；可以统计按月或者按年的会员或者订阅，可以根据初次扣费的时间，计算下次扣费的日期以及剩余天数，还有年度总成本。附件直接导入即可食用。只需要填写名称、付费类型、年付金 ..

思源图床建议

因为是多端用户，笔记中又有很多图片，手机在同步后会将所有图片下载到手机，手机端只是浏览查看，很少用来写作，思源笔记可以将文档中的图片上传到图库，那么可不可以将图片链接替换为图床链接，在手机端只保存文字而不是一股脑全下载到本地。

欢迎来到这里！

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

关于

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

相关帖子

云端存储服务提供商网络连通性校验异常

有没有什么同步比较快的办法

关于 docker 端的发布功能

更新 3.1.13 版本后的反链面板中的有趣问题

底部反链与笔记整理的问题

分享一套个人会员账号订阅管理的数据库模板

思源图床建议

欢迎来到这里！