Schema
.erd.json 是编辑器的文档格式。如果需要在编辑器之外生成、校验或迁移文档，可以阅读本页。
从 4.0.0 起，文档有两种序列化形式，两者的 version 都是 '3.0.0'。存储形式是文件所保存的形式：它是 editor.value 返回的内容、JSON 导出写入的内容，也是所发布的 JSON Schema 唯一接受的形式。运行时值是编辑器所持有的完整文档，由 editor.runtimeValue 返回。setInitialValue()、value 的 setter 和 setSchemaJSON() 都能读取这两种形式、较早发布版本保存的任何文件，以及 v2 的 .vuerd 文档。在 4.0.0 之前只有一种形式：value 返回编辑器所持有的完整文档，就像现在的 runtimeValue 一样。
存储形式与运行时值
存储形式只包含现存的实体：doc.tableIds 中列出的每个表、这些表所列出的列、两端的表都被保留的关系、被保留的表的索引及其所指的列仍由该表列出的索引列，以及列出的备注和表分组。它不包含编辑器在加载时推算出的内容或在打开期间保留的内容：已删除的实体、seqColumnIds 和 seqIndexColumnIds、所有 zIndex、测量得到的宽度、列的 ui，以及关系的 identification、startRelationshipType 和锚点。下面的类型将这些字段都标注为 // runtime only。
每个集合都以 id 为键，按码元（code unit）顺序排列，其中列先按 tableId 分组，索引列先按 indexId 分组。每个实体都按固定顺序写出其字段，文本以两个空格缩进，并以换行符结尾。因此，同一个文档总是写出相同的字节，一次编辑只会改变它所涉及的内容，在字体不同的机器上保存的文件重新打开后也会得到相同的 value。
VS Code、Obsidian 和 JetBrains 插件只在编辑改变了 value 时才写入文件，因此较早发布版本保存的文件会一直保持其旧形式，直到第一次编辑为止。
运行时值保留了存储形式所省略的内容：已删除的实体、序列、z-index、宽度、键标记、关系标志和锚点。它以两个空格缩进，末尾没有换行符。它只应用于通过 setInitialValue() 为协作者或第二个视图载入初始文档，这样，另一个编辑器发来的对删除操作的 Undo 就能在那里完整地恢复该实体。切勿将它写入文件，JSON Schema 会拒绝它。已不再有任何机制回收已删除的实体，因此运行时值会一直保留它们，直到下次从文件打开该文档。
两种形式都会把每项锁定的设置按其锁定的值写出（参见 lockSettings），只在有脚本包含文本时写出 settings.ddlScripts，并且只在表的 groupId 不为空时写出它。存储形式只在存在表分组时写出 doc.tableGroupIds 和 tableGroupEntities；运行时值则在文档持有分组或已删除的分组时写出它们。
TypeScript
这些类型描述的是运行时值。标注为 // runtime only 的字段不包含在存储形式中，标注为 ? 的字段只在有内容时才会写出。
ERDEditorSchemaV3
type ERDEditorSchemaV3 = {
$schema: 'https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json';
version: '3.0.0';
settings: Settings;
doc: Doc;
collections: {
tableEntities: Record<string, Table>;
tableColumnEntities: Record<string, Column>;
relationshipEntities: Record<string, Relationship>;
indexEntities: Record<string, Index>;
indexColumnEntities: Record<string, IndexColumn>;
memoEntities: Record<string, Memo>;
tableGroupEntities?: Record<string, TableGroup>;
};
};
每个实体都以其 id 为键，id 是一个不透明的字符串；解析时会丢弃 id 缺失或为空的实体。从 4.0.0 起，每个新 id 都是以 Uuid25 形式写出的 UUIDv7，即 25 位小写的 36 进制数字，例如 03gzrxjv20bdlcak89q25d2m7，因此同一个编辑器生成的 id 会按其生成的顺序排序。文档会保留它所持有的 id，例如较早发布版本的 nanoid id 或 v2 文件的 id，因此任何代码都不应依赖 id 的形状。
从 4.0.0 起，实体不再带有 meta 对象（createAt、updateAt），EntityMeta 和 EntityType 类型也已移除。不再有任何地方写入它，解析时会丢弃旧文件中带有的 meta，JSON Schema 也会拒绝它。它唯一的用途是为已删除实体的垃圾回收计时，而垃圾回收也已一并移除。
Settings
type Settings = {
originX: number;
originY: number;
zoomLevel: number;
show: number; // Constants: Show
database: number; // Constants: Database
databaseName: string;
canvasType: string; // Constants: CanvasType
language: number; // Constants: Language
tableNameCase: number; // Constants: NameCase
columnNameCase: number; // Constants: NameCase
bracketType: number; // Constants: BracketType
relationshipDataTypeSync: boolean;
columnOrder: number[]; // Constants: ColumnType
maxWidthComment: number;
lockSettings: number; // Constants: LockSettingType
ddlScripts?: DDLScripts;
};
type DDLScripts = {
before: string;
after: string;
};
// Constants
const CanvasType = {
ERD: 'ERD',
visualization: '@dineug/erd-editor/builtin-visualization',
schemaSQL: '@dineug/erd-editor/builtin-schema-sql',
generatorCode: '@dineug/erd-editor/builtin-generator-code',
settings: 'settings',
} as const;
const Show = {
tableComment: 1,
columnComment: 2,
columnDataType: 4,
columnDefault: 8,
columnAutoIncrement: 16,
columnPrimaryKey: 32,
columnUnique: 64,
columnNotNull: 128,
relationship: 256,
columnAlternateKey: 512,
hideReferentialAction: 1024,
hideTableGroup: 2048,
hideMemo: 4096,
} as const;
const ColumnType = {
columnName: 1,
columnDataType: 2,
columnNotNull: 4,
columnUnique: 8,
columnAutoIncrement: 16,
columnDefault: 32,
columnComment: 64,
} as const;
const Database = {
MariaDB: 1,
MSSQL: 2,
MySQL: 4,
Oracle: 8,
PostgreSQL: 16,
SQLite: 32,
Databricks: 64,
Snowflake: 128,
} as const;
const Language = {
GraphQL: 1,
csharp: 2,
Java: 4,
Kotlin: 8,
TypeScript: 16,
JPA: 32,
Scala: 64,
Go: 128,
SQLAlchemy: 256,
TypeORM: 512,
Sequelize: 1024,
Drizzle: 2048,
DBML: 4096,
AML: 8192,
Mermaid: 16384,
PHP: 32768,
Doctrine: 65536,
Rust: 131072,
SeaORM: 262144,
Swift: 524288,
Zod: 1048576,
JSONSchema: 2097152,
} as const;
const NameCase = {
none: 1,
camelCase: 2,
pascalCase: 4,
snakeCase: 8,
} as const;
const BracketType = {
none: 1,
doubleQuote: 2,
singleQuote: 4,
backtick: 8,
} as const;
const LockSettingType = {
viewport: 1, // originX, originY and zoomLevel
canvasType: 2,
language: 4,
tableNameCase: 8,
columnNameCase: 16,
bracketType: 32,
} as const;
originX 和 originY 表示视图，也就是场景坐标 (0, 0) 落在屏幕上的位置。
zoomLevel 的范围是 0.1 ~ 1.5。保存时超过 1 的文档在 3.5.0 之前的编辑器中会以 1 打开。
从 4.0.0 起，settings 中不再带有 width、height、scrollTop、scrollLeft、relationshipOptimization 和 ignoreSaveSettings。不再有任何地方写入它们，解析器也不保留其中任何一个，JSON Schema 会拒绝仍带有它们的文件。
canvasType 是文档打开时所在的标签页。在 Visualization 标签页中保存的文档会保存 '@dineug/erd-editor/builtin-visualization'，但不会记录当时显示的是 Graph 模式还是 Flow 模式，新创建的编辑器会以 Graph 模式显示该标签页。
从 4.0.0 起，当 Canvas Type 锁定开启时（新文档中即是如此），文档会保留锁定时所显示的标签页，切换标签页时 value 保持原样。在 Settings 标签页上开启的锁定保留的是读者进入该页之前所在的标签页；而锁定的 'settings'（只有手工编辑才能写入）会以 'ERD' 打开。
Flow 模式自身的状态都不会被序列化，它的布局、缩放、平移、行显示和聚焦的表都只保留在编辑器中，因此 originX、originY 和 zoomLevel 始终描述的是 ERD 画布。
show 和 lockSettings 是位掩码，将各标志位通过 OR 运算组合。
columnOrder 是一个数组，按显示顺序保存全部七个 ColumnType 值。
database、language、tableNameCase、columnNameCase 和 bracketType 各自只保存一个值，JSON Schema 会拒绝组合后的值。
新文档的 show 为 431：tableComment、columnComment、columnDataType、columnDefault、columnPrimaryKey、columnNotNull 和 relationship。
从 3.10.0 起新增了两个 show 标志位，在新文档以及 3.10.0 之前保存的所有文档中都处于关闭状态。
columnAlternateKey（512）对应 Alternate Key 显示选项。设置后，每个由两列或更多列组成的唯一索引，其列都会被标记为 AK1.1、AK1.2 等。它默认关闭，因此现有的图都不会改变宽度。
hideReferentialAction（1024）则正好相反：设置后，它会隐藏连接线上的 ON DELETE 与 ON UPDATE 标签，因此这些标签默认显示。该标志位关闭时，Referential Actions 显示选项处于勾选状态。它不会改变任何表的尺寸。
3.10.0 之前的编辑器会原样保留整个 show 数值，因此在其中保存后，这两个标志位依然存在。
从 4.0.0 起又新增了两个 show 标志位，在新文档以及 4.0.0 之前保存的所有文档中都处于关闭状态。与 hideReferentialAction 一样，它们各自隐藏其所指的内容，因此表分组和备注默认显示。
hideTableGroup（2048）隐藏表分组，hideMemo（4096）隐藏所有备注。它们对应 Table Groups 和 Memos 两个显示选项，各自在对应的标志位关闭时处于勾选状态。两者都不会改变任何表的尺寸。
4.0.0 之前的编辑器会原样保留整个 show 数值，因此在其中保存后，这两个标志位依然存在。
从 4.0.0 起，Language 新增了八个 Code Generator 目标，即从 Mermaid 到 JSONSchema。解析器不认识的 language 会读作 GraphQL，因此 4.0.0 之前的编辑器打开以其中某个目标保存的文档时会显示 GraphQL，在其中保存则会写出 GraphQL。
从 4.0.0 起，lockSettings 取代了 ignoreSaveSettings，LockSettingType 则取代了已被移除的 SaveSettingType。lockSettings 指明文档按锁定时的状态保存哪些设置。viewport 同时涵盖 originX、originY 和 zoomLevel，因为不带缩放级别保存的原点会在别处打开；其他每个位则涵盖与其同名的字段。它们就是 Settings 标签页中的 Lock 各行。
锁定的设置无论编辑器显示的是什么，都按其锁定的值写出，value 和 runtimeValue 都是如此；其他所有设置则按其当前状态写出。因此，在相应的锁定开启期间，滚动和缩放、切换标签页，或者更改 Code Generator 的语言、某种名称大小写或括号类型，都会让文件保持原样。锁定时取的是该设置在那一刻的值，解析时则从所保存的字段中取得锁定的值。
从零开始创建的文档（新的编辑器或用于数据复制的 store，或者赋给 value 或 setInitialValue() 的空白值）的 lockSettings 为 63，即所有锁定都处于开启状态。settings 中不带 lockSettings 的文档（4.0.0 之前保存的所有文件，无论其 ignoreSaveSettings 是什么，以及所有 v2 文档）打开时同样所有锁定都处于开启状态：其视图和标签页与新文档相同（originX 和 originY 为 0，zoomLevel 为 1，ERD 标签页），其语言、名称大小写和括号类型则锁定为保存时的值。写明了锁定的文档会保留这些锁定（包括 0），以及它保存的每一个值。
解析时会保留 lockSettings 的每一个位，包括未知的位，因此之后的版本新增的锁定在这里保存后依然存在；JSON Schema 只检查它是否为整数。4.0.0 之前的编辑器保存时会丢弃 lockSettings，并按当前状态写出视图和标签页，因此该文件再次在这里打开时，会被当作 4.0.0 之前保存的文件。
从 4.0.0 起，ddlScripts 保存 Schema SQL 标签页的两段脚本，每种数据库的 DDL 都会写出它们：before 写在头部之后、各表之前，after 写在生成的 DDL 之后。DDL 写出每段脚本时使用 LF 换行符，去掉其前面的空行和后面的空白，在 MSSQL 上还会以 GO 结尾，如前置与后置脚本所述；ddlScripts 本身则按输入的原样保存每段脚本。只有在任一段脚本包含文本时才会写出该键，并且此时两段都会写出；缺少该键，或者脚本不是字符串时，读作 ''。该标签页中 Statements、Header 和 Tables 的选择不会保存在文档中。
4.0.0 之前的编辑器会在加载文档时丢弃这些脚本，因此在其中保存会丢失它们。
Database、Language、Show、LockSettingType 和 ReferentialAction 只会追加新值。已保存的文档中存储的是数字，因此新增的数据库厂商、代码生成目标、标志位、锁定或操作会占用下一个比特位，而不是中间的某个位置。
Doc
type Doc = {
tableIds: string[];
relationshipIds: string[];
indexIds: string[];
memoIds: string[];
tableGroupIds?: string[];
};
每个列表都是某一类实体的顺序，DDL、表的排序和绘制顺序都会读取它。在存储形式中，每个列表只包含被保留的实体的 id，每个 id 只出现一次，并按所列出的顺序排列。从 4.0.0 起，tableGroupIds 是表分组的顺序。
从 4.0.0 起，叠放顺序不再保存。解析时，对于列表中列出的、不带 zIndex 的每个表、备注和表分组，会按其在所属列表中的位置叠放，排在后面的位于前方：表分组从 1 开始，表从 2 开始，备注位于所有表之上。带有 zIndex 的实体（例如运行时值中的实体，或 4.0.0 之前保存的文件中的实体）会保留它。因此，将表或备注移到最前面的操作，在重新打开文件后就会丢失。
Collection: tableEntities
type Table = {
id: string;
name: string;
comment: string;
columnIds: string[];
seqColumnIds: string[]; // runtime only
groupId?: string;
ui: TableUI;
};
type TableUI = {
x: number;
y: number;
zIndex: number; // runtime only
widthName: number; // runtime only
widthComment: number; // runtime only
color: string;
};
从 4.0.0 起，表带有 groupId，即它所属的表分组的 id。groupId 缺失或为空，或者它所指的分组不在 doc.tableGroupIds 中，都表示不属于任何分组；存储形式只在它指向被保留的分组时才写出它。
解析时，如果 seqColumnIds 缺失或缺少列出的某个 id，会以 columnIds 作为其初始值；编辑器每次加载时都会用自己的字体重新测量 widthName 和 widthComment。
Collection: tableColumnEntities
type Column = {
id: string;
tableId: string;
name: string;
comment: string;
dataType: string;
default: string;
options: number; // Constants: ColumnOption
ui: ColumnUI; // runtime only
};
type ColumnUI = {
keys: number; // Constants: ColumnUIKey
widthName: number;
widthComment: number;
widthDataType: number;
widthDefault: number;
};
// Constants
const ColumnOption = {
autoIncrement: 1,
primaryKey: 2,
unique: 4,
notNull: 8,
} as const;
const ColumnUIKey = {
primaryKey: 1,
foreignKey: 2,
} as const;
从 4.0.0 起，存储形式不写出列的 ui。每次加载时都会推算出 keys（主键标记取自 options 的 primaryKey 位，外键标记取自以该列为终点的关系），并测量四个宽度。
4.0.0 之前的编辑器显示在这里保存的文件时，其中的列不带主键图标。
Collection: relationshipEntities
type Relationship = {
id: string;
identification: boolean; // runtime only
relationshipType: number; // Constants: RelationshipType
startRelationshipType: number; // Constants: StartRelationshipType; runtime only
onDelete: number; // Constants: ReferentialAction
onUpdate: number; // Constants: ReferentialAction
start: RelationshipPoint;
end: RelationshipPoint;
};
type RelationshipPoint = {
tableId: string;
columnIds: string[];
x: number; // runtime only
y: number; // runtime only
direction: number; // Constants: Direction; runtime only
};
// Constants
const RelationshipType = {
ZeroOne: 2,
ZeroN: 4,
OneOnly: 8,
OneN: 16,
} as const;
const StartRelationshipType = {
ring: 1,
dash: 2,
} as const;
const ReferentialAction = {
none: 1,
noAction: 2,
cascade: 4,
setNull: 8,
setDefault: 16,
restrict: 32,
} as const;
const Direction = {
left: 1,
right: 2,
top: 4,
bottom: 8,
} as const;
从 3.10.0 起，关系带有 onDelete 和 onUpdate，即它的 ON DELETE 与 ON UPDATE 操作。两者各自只保存一个 ReferentialAction 值。默认值 none 不会写出任何子句，因此由数据库自身的默认行为决定。其余五个值分别对应 NO ACTION、CASCADE、SET NULL、SET DEFAULT 和 RESTRICT。Schema SQL 只会为支持该操作的数据库写出对应的子句。
存储形式总会写出这两个字段，并且从 4.0.0 起 JSON Schema 要求必须包含它们，但只检查两者是否为整数。解析时，缺少该字段（3.10.0 之前保存的所有文档都是如此）仍读作 none，不在列表中的值同样读作 none。
3.10.0 之前的编辑器不认识这两个字段，会在加载文档时将其丢弃，因此在其中保存会丢失所有操作。
从 4.0.0 起，每次加载时都会推算出存储形式所省略的内容。当关系的每个终点列都是主键时，该关系为识别关系；当所有这些列都为 NOT NULL 时，其 startRelationshipType 为 dash，否则为 ring；已没有任何终点列的关系则为非识别关系且为 dash，与新建关系的初始状态相同。锚点 x、y 和 direction 会重新放置。
Collection: indexEntities
type Index = {
id: string;
name: string;
tableId: string;
indexColumnIds: string[];
seqIndexColumnIds: string[]; // runtime only
unique: boolean;
};
解析时，如果 seqIndexColumnIds 缺失或缺少列出的某个 id，会以 indexColumnIds 作为其初始值。
Collection: indexColumnEntities
type IndexColumn = {
id: string;
indexId: string;
columnId: string;
orderType: number; // Constants: OrderType
};
// Constants
const OrderType = {
ASC: 1,
DESC: 2,
} as const;
Collection: memoEntities
type Memo = {
id: string;
value: string;
ui: MemoUI;
};
type MemoUI = {
x: number;
y: number;
width: number;
height: number;
zIndex: number; // runtime only
color: string;
};
从 4.0.0 起，表与备注共用同一个叠放顺序，按 zIndex 排序，因此把表移到最前面可能会让它位于备注之上。解析时，不带 zIndex 保存的备注会叠放在所有表之上，如 Doc 所述。4.0.0 之前保存的文件中的备注会保留其保存的 zIndex，该值与表的 zIndex 来自同一个计数器，因此较早发布版本绘制在所有表之上的备注，打开时可能会位于在它之后被移到最前面的表之下。
Collection: tableGroupEntities
type TableGroup = {
id: string;
name: string;
color: string;
ui: TableGroupUI;
};
type TableGroupUI = {
x: number;
y: number;
width: number;
height: number;
zIndex: number; // runtime only
};
从 4.0.0 起，文档可以包含表分组：绘制在表后面、带有名称和颜色的矩形。表通过自身的 groupId 加入分组，因此分组不保存成员列表。与 doc.tableGroupIds 一样，存储形式只在存在分组时才写出该集合，不带该集合的文档（例如 4.0.0 之前保存的文档）没有任何分组。Show.hideTableGroup 会隐藏它们。
4.0.0 之前的编辑器会在加载文档时丢弃分组以及每个表的 groupId，因此在其中保存会丢失所有分组。
JSON Schema
规范的 schema 文件发布在 json-schema/schema.json，可通过 $schema 直接引用。
{
"$schema": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"version": "3.0.0"
}
在 .erd.json 文件顶部写入 $schema，VS Code 等支持 JSON Schema 的编辑器就会校验该文档，并在编辑时自动补全其字段。
从 4.0.0 起，该 schema 只描述存储形式。每个带命名字段的对象都是封闭的（additionalProperties: false），存储形式总会写出的每个字段都是必需的，它所省略的字段则一个都没有列出。因此它会拒绝运行时值。它也会拒绝较早发布版本保存的文件（带有 meta、宽度、zIndex、ignoreSaveSettings 等内容），直到 4.0.0 的编辑器再次保存该文件为止。3.2.0 或更高版本保存的文件已经写明了此 schema 的 URL，该 URL 指向 main 分支，因此按它进行校验的编辑器现在就会将该文件标记出来。3.0.0 或 3.1.0 保存的文件，以及 v2 文档，都没有写明 $schema。
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"title": "ERD Editor document",
"description": "The storage form an ERD Editor file holds (.erd, .erd.json, .vuerd, .vuerd.json): the live entities alone, each collection keyed in id order, without what an editor derives on load or keeps while it is open",
"type": "object",
"properties": {
"$schema": {
"type": "string"
},
"version": {
"description": "Version of the schema",
"const": "3.0.0"
},
"settings": {
"$ref": "#/$defs/settings"
},
"doc": {
"$ref": "#/$defs/doc"
},
"collections": {
"type": "object",
"properties": {
"tableEntities": {
"$ref": "#/$defs/tableEntities"
},
"tableColumnEntities": {
"$ref": "#/$defs/tableColumnEntities"
},
"relationshipEntities": {
"$ref": "#/$defs/relationshipEntities"
},
"indexEntities": {
"$ref": "#/$defs/indexEntities"
},
"indexColumnEntities": {
"$ref": "#/$defs/indexColumnEntities"
},
"memoEntities": {
"$ref": "#/$defs/memoEntities"
},
"tableGroupEntities": {
"$ref": "#/$defs/tableGroupEntities"
}
},
"required": [
"tableEntities",
"tableColumnEntities",
"relationshipEntities",
"indexEntities",
"indexColumnEntities",
"memoEntities"
],
"additionalProperties": false
}
},
"required": ["$schema", "version", "settings", "doc", "collections"],
"additionalProperties": false,
"$defs": {
"settings": {
"type": "object",
"properties": {
"originX": {
"type": "number"
},
"originY": {
"type": "number"
},
"zoomLevel": {
"type": "number",
"minimum": 0.1,
"maximum": 1.5
},
"show": {
"description": "bit value (tableComment: 1) | (columnComment: 2) | (columnDataType: 4) | (columnDefault: 8) | (columnAutoIncrement: 16) | (columnPrimaryKey: 32) | (columnUnique: 64) | (columnNotNull: 128) | (relationship: 256) | (columnAlternateKey: 512) | (hideReferentialAction: 1024) | (hideTableGroup: 2048) | (hideMemo: 4096); the three hide bits hide what they name while set",
"type": "integer"
},
"database": {
"description": "bit value (MariaDB: 1) | (MSSQL: 2) | (MySQL: 4) | (Oracle: 8) | (PostgreSQL: 16) | (SQLite: 32) | (Databricks: 64) | (Snowflake: 128)",
"type": "integer",
"enum": [1, 2, 4, 8, 16, 32, 64, 128]
},
"databaseName": {
"type": "string"
},
"canvasType": {
"enum": [
"ERD",
"@dineug/erd-editor/builtin-visualization",
"@dineug/erd-editor/builtin-schema-sql",
"@dineug/erd-editor/builtin-generator-code",
"settings"
]
},
"language": {
"description": "bit value (GraphQL: 1) | (csharp: 2) | (Java: 4) | (Kotlin: 8) | (TypeScript: 16) | (JPA: 32) | (Scala: 64) | (Go: 128) | (SQLAlchemy: 256) | (TypeORM: 512) | (Sequelize: 1024) | (Drizzle: 2048) | (DBML: 4096) | (AML: 8192) | (Mermaid: 16384) | (PHP: 32768) | (Doctrine: 65536) | (Rust: 131072) | (SeaORM: 262144) | (Swift: 524288) | (Zod: 1048576) | (JSONSchema: 2097152)",
"type": "integer",
"enum": [1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152]
},
"tableNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer",
"enum": [1, 2, 4, 8]
},
"columnNameCase": {
"description": "bit value (none: 1) | (camelCase: 2) | (pascalCase: 4) | (snakeCase: 8)",
"type": "integer",
"enum": [1, 2, 4, 8]
},
"bracketType": {
"description": "bit value (none: 1) | (doubleQuote: 2) | (singleQuote: 4) | (backtick: 8)",
"type": "integer",
"enum": [1, 2, 4, 8]
},
"relationshipDataTypeSync": {
"type": "boolean"
},
"columnOrder": {
"description": "bit value (columnName: 1) | (columnDataType: 2) | (columnNotNull: 4) | (columnUnique: 8) | (columnAutoIncrement: 16) | (columnDefault: 32) | (columnComment: 64)",
"type": "array",
"prefixItems": [
{ "type": "integer" },
{ "type": "integer" },
{ "type": "integer" },
{ "type": "integer" },
{ "type": "integer" },
{ "type": "integer" },
{ "type": "integer" }
],
"minItems": 7,
"maxItems": 7
},
"maxWidthComment": {
"type": "integer"
},
"lockSettings": {
"description": "bit value (viewport: 1) | (canvasType: 2) | (language: 4) | (tableNameCase: 8) | (columnNameCase: 16) | (bracketType: 32); a locked setting is saved as it stood when locked, the viewport being originX, originY and zoomLevel",
"type": "integer"
},
"ddlScripts": {
"description": "SQL the Schema SQL writes as is for every database: before after the header and ahead of the tables, after past the generated DDL. Absent while both are empty",
"type": "object",
"properties": {
"before": { "type": "string" },
"after": { "type": "string" }
},
"required": ["before", "after"],
"additionalProperties": false
}
},
"required": [
"originX",
"originY",
"zoomLevel",
"show",
"database",
"databaseName",
"canvasType",
"language",
"tableNameCase",
"columnNameCase",
"bracketType",
"relationshipDataTypeSync",
"columnOrder",
"maxWidthComment",
"lockSettings"
],
"additionalProperties": false
},
"doc": {
"description": "The order of each kind of entity, which the DDL, the sort and the draw order read",
"type": "object",
"properties": {
"tableIds": {
"type": "array",
"items": {
"type": "string"
}
},
"relationshipIds": {
"type": "array",
"items": {
"type": "string"
}
},
"indexIds": {
"type": "array",
"items": {
"type": "string"
}
},
"memoIds": {
"type": "array",
"items": {
"type": "string"
}
},
"tableGroupIds": {
"description": "Order of the table groups. Written while a group exists; absent means none",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["tableIds", "relationshipIds", "indexIds", "memoIds"],
"additionalProperties": false
},
"tableEntities": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"comment": {
"type": "string"
},
"columnIds": {
"type": "array",
"items": {
"type": "string"
}
},
"groupId": {
"description": "Id of the table group in doc.tableGroupIds the table belongs to; absent means none",
"type": "string"
},
"ui": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"color": {
"type": "string"
}
},
"required": ["x", "y", "color"],
"additionalProperties": false
}
},
"required": ["id", "name", "comment", "columnIds", "ui"],
"additionalProperties": false
}
},
"tableColumnEntities": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"tableId": {
"type": "string"
},
"name": {
"type": "string"
},
"comment": {
"type": "string"
},
"dataType": {
"type": "string"
},
"default": {
"type": "string"
},
"options": {
"description": "bit value (autoIncrement: 1) | (primaryKey: 2) | (unique: 4) | (notNull: 8)",
"type": "integer"
}
},
"required": [
"id",
"tableId",
"name",
"comment",
"dataType",
"default",
"options"
],
"additionalProperties": false
}
},
"relationshipEntities": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"relationshipType": {
"description": "bit value (ZeroOne: 2) | (ZeroN: 4) | (OneOnly: 8) | (OneN: 16)",
"type": "integer"
},
"onDelete": {
"description": "bit value (none: 1) | (noAction: 2) | (cascade: 4) | (setNull: 8) | (setDefault: 16) | (restrict: 32); none, the default, writes no ON DELETE clause",
"type": "integer"
},
"onUpdate": {
"description": "bit value (none: 1) | (noAction: 2) | (cascade: 4) | (setNull: 8) | (setDefault: 16) | (restrict: 32); none, the default, writes no ON UPDATE clause",
"type": "integer"
},
"start": {
"$ref": "#/$defs/RelationshipPoint"
},
"end": {
"$ref": "#/$defs/RelationshipPoint"
}
},
"required": [
"id",
"relationshipType",
"onDelete",
"onUpdate",
"start",
"end"
],
"additionalProperties": false
}
},
"indexEntities": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"tableId": {
"type": "string"
},
"indexColumnIds": {
"type": "array",
"items": {
"type": "string"
}
},
"unique": {
"type": "boolean"
}
},
"required": ["id", "name", "tableId", "indexColumnIds", "unique"],
"additionalProperties": false
}
},
"indexColumnEntities": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"indexId": {
"type": "string"
},
"columnId": {
"type": "string"
},
"orderType": {
"description": "bit value (ASC: 1) | (DESC: 2)",
"type": "integer"
}
},
"required": ["id", "indexId", "columnId", "orderType"],
"additionalProperties": false
}
},
"memoEntities": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "string"
},
"ui": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"color": {
"type": "string"
}
},
"required": ["x", "y", "width", "height", "color"],
"additionalProperties": false
}
},
"required": ["id", "value", "ui"],
"additionalProperties": false
}
},
"tableGroupEntities": {
"description": "Named, coloured rectangles drawn behind tables; a table joins one through its groupId. Written while a group exists; absent means none",
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"ui": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": ["x", "y", "width", "height"],
"additionalProperties": false
}
},
"required": ["id", "name", "color", "ui"],
"additionalProperties": false
}
},
"RelationshipPoint": {
"type": "object",
"properties": {
"tableId": {
"type": "string"
},
"columnIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["tableId", "columnIds"],
"additionalProperties": false
}
}
}