数据规范
QiiDB 数据规范的基本原则是——在 YAML 文件中通过结构化数据描述并定义事物,使用 Markdown 及关联的其他格式(如图片类)的文件详细且具体地描述事物的某个属性。
具备一定规范、标准的结构化数据有助于后续根据自己需求进行加工处理。
定义事物
数据定位
通过文件夹的层级控制去表达数据的「集合」、「记录」等概念:
集合
是一个以英文单词的复数形式命名的文件夹,如 posts
;记录
是一个遵从一定规则的可多层级的文件夹,如 2022/09/27-155519
。
元数据
在 集合
文件夹下的 .meta
文件夹中存放用来定义 记录
的识别规则、实体属性等的元数据,可以是 YAML、Markdown 和批处理脚本等文件。
数据记录
记录
文件夹下的文件规则为——
事物的定义可以是一体化的 entity.yml
(旧为 metadata.yml
),也可以是以 basic.yml
作为基础信息而将额外信息拆分成多个 YAML 文件;entity.yml
与 basic.yml
被认为是「主描述文件」。
若某个属性是文本且内容较多,甚至是富文本,最好以属性名作为文件名将内容存放在 Markdown 文件中;除了单纯拆分文件之外,还可建立子文件夹进一步组织更为复杂的属性描述作为 basic.yml
的扩展补充。
当被拆分的文件或子文件夹与「主描述文件」中的属性同名时会进行覆盖;readme.md
文件会作为 content
属性。