Schema
.erd.json はエディタのドキュメント形式です。エディタの外部でドキュメントを生成・検証・移行する必要がある場合は、このページを参照してください。
4.0.0 からは、ドキュメントには 2 つのシリアライズ形式があり、どちらも version は '3.0.0' です。保存形式はファイルが保持する形式で、editor.value が返す値であり、JSON の書き出しが書き込む内容であり、公開されている JSON Schema が受け付ける唯一の形式です。ランタイム値はエディタが保持しているとおりのドキュメント全体で、editor.runtimeValue が返します。setInitialValue()、value の setter、setSchemaJSON() は、どちらの形式も、以前のリリースで保存したファイルも、v2 の .vuerd ドキュメントも読み込みます。4.0.0 より前は形式が 1 つだけで、value は、現在の runtimeValue と同じように、エディタが保持しているとおりのドキュメント全体を返していました。
保存形式とランタイム値
保存形式が保持するのは現存するエンティティだけです。つまり、doc.tableIds に並ぶ各テーブル、それらのテーブルが列挙するカラム、残る 2 つのテーブルの間のリレーションシップ、残るテーブルのインデックスと、指すカラムをテーブルがまだ列挙しているインデックスカラム、そしてリストに並ぶメモとテーブルグループです。エディタが読み込むときに導き出すものや、開いている間だけ保持するものは含みません。削除したエンティティ、seqColumnIds と seqIndexColumnIds、すべての zIndex、計測した幅、カラムの ui、そしてリレーションシップの identification、startRelationshipType、接続位置がこれにあたります。以下の型では、これらの各フィールドに // runtime only と記しています。
すべてのコレクションは id をキーとしてコード単位の順に並び、カラムはまず tableId ごとに、インデックスカラムはまず indexId ごとにまとめられます。各エンティティはフィールドを決まった順序で書き出し、テキストは 2 つのスペースでインデントされ、改行で終わります。そのため、同じドキュメントからは常に同じバイト列が書き出され、編集は触れた部分だけを変え、別のフォントを持つマシンで保存したファイルも同じ value で開き直されます。
VS Code、Obsidian、JetBrains のプラグインは、編集によって value が変わったときにだけファイルを書き込むため、以前のリリースで保存したファイルは、最初の編集まで古い形式のままです。
ランタイム値は、保存形式が含まないもの、つまり削除したエンティティ、シーケンス、重なり順、幅、キーのマーク、リレーションシップのフラグ、接続位置を保持します。2 つのスペースでインデントされ、末尾に改行はありません。共同編集の参加者や 2 つ目のビューに 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 がないか空のエンティティは取り除かれます。4.0.0 からは、新しい id はすべて Uuid25 形式で書いた UUIDv7、つまり 03gzrxjv20bdlcak89q25d2m7 のような小文字の 36 進数 25 桁になるため、1 つのエディタが発行した id は作成した順に並びます。ドキュメントは、以前のリリースの nanoid の id や v2 ファイルの id など、保持している id をそのまま保つため、id の形に依存しないでください。
4.0.0 からは、どのエンティティも meta オブジェクト（createAt、updateAt）を持たず、EntityMeta 型と EntityType 型は削除されました。meta を書き出すものはなく、古いファイルが持つ meta はパースで取り除かれ、JSON Schema はこれを受け付けません。meta は削除したエンティティのガベージコレクションの時期を決めるためだけのもので、そのガベージコレクションもなくなりました。
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 からは、設定に 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' は 'ERD' で開きます。
Flow モード自体の状態は何もシリアライズされず、配置、拡大・縮小、表示位置、行の表示、フォーカスしているテーブルはエディタ内にとどまります。そのため、originX、originY、zoomLevel は常に ERD キャンバスを表します。
show と lockSettings はビットマスクです。フラグを OR で結合します。
columnOrder は ColumnType の 7 つの値をすべて表示順で保持する配列です。
database、language、tableNameCase、columnNameCase、bracketType はそれぞれ 1 つの値だけを保持し、組み合わせた値は JSON Schema で拒否されます。
新しいドキュメントの show は 431 で、tableComment、columnComment、columnDataType、columnDefault、columnPrimaryKey、columnNotNull、relationship が設定されています。
3.10.0 からは show のフラグが 2 つ増えました。どちらも、新しいドキュメントと、3.10.0 より前に保存したすべてのドキュメントではオフです。
columnAlternateKey（512）は Alternate Key の表示オプションです。設定すると、2 つ以上のカラムにまたがる各ユニークインデックスのカラムに AK1.1、AK1.2 などのマークが付きます。最初はオフのため、既存のダイアグラムの幅が変わることはありません。
hideReferentialAction（1024）は逆の働きをします。設定するとコネクタの ON DELETE と ON UPDATE のラベルが非表示になるため、ラベルは既定で表示されます。Referential Actions の表示オプションは、このフラグがオフの間チェックが付いた状態になります。このフラグでテーブルのサイズが変わることはありません。
3.10.0 より前のエディタは show を 1 つの整数のまま保持するため、そのエディタで保存しても両方のフラグは失われません。
4.0.0 からは show のフラグがさらに 2 つ増えました。どちらも、新しいドキュメントと、4.0.0 より前に保存したすべてのドキュメントではオフです。hideReferentialAction と同じく、どちらも名前が示すものを非表示にするため、テーブルグループとメモは既定で表示されます。
hideTableGroup（2048）はテーブルグループを、hideMemo（4096）はすべてのメモを非表示にします。これらは Table Groups と Memos の表示オプションで、それぞれ対応するフラグがオフの間チェックが付いた状態になります。どちらのフラグでもテーブルのサイズが変わることはありません。
4.0.0 より前のエディタは show を 1 つの整数のまま保持するため、そのエディタで保存しても両方のフラグは失われません。
4.0.0 からは、Language に Code Generator の対象が Mermaid から JSONSchema まで 8 つ増えました。パーサーが知らない language は GraphQL として読み込まれるため、4.0.0 より前のエディタでは、これらのいずれかで保存したドキュメントは GraphQL で開き、そのエディタで保存すると GraphQL が書き出されます。
4.0.0 からは、ignoreSaveSettings の代わりに lockSettings が、削除された SaveSettingType の代わりに LockSettingType が使われます。lockSettings は、ドキュメントがロックした時点の値で保存する設定を示します。拡大・縮小のレベルなしで保存した原点は別の位置で開くため、viewport は originX、originY、zoomLevel をまとめて扱い、ほかの各ビットはその名前のフィールドを扱います。これらは設定タブの Lock の各行です。
ロックされた設定は、エディタの表示にかかわらず、value でも runtimeValue でもロックされた値で書き出され、それ以外の設定は現在の値のまま書き出されます。そのため、対応するロックがオンの間は、スクロールや拡大・縮小、タブの切り替え、Code Generator の言語、名前のケース、括弧の種類の変更をしても、ファイルは変わりません。ロックすると、その時点で設定が持つ値がロックされた値になり、パースでは保存されたフィールドからロックされた値を取ります。
何もないところから始めたドキュメント、つまり新しいエディタやレプリケーション用の store、あるいは value や setInitialValue() に空の値を渡したドキュメントでは、lockSettings が 63 になり、すべてのロックがオンです。settings に lockSettings がないドキュメント、つまり ignoreSaveSettings の内容にかかわらず 4.0.0 より前に保存したすべてのファイルと、すべての v2 ドキュメントも、すべてのロックがオンの状態で開きます。表示位置とタブは新しいドキュメントと同じ（originX と originY は 0、zoomLevel は 1、ERD タブ）になり、言語、名前のケース、括弧の種類は保存されていた値でロックされます。ロックを指定しているドキュメントは、0 の場合も含めてそのロックを保ち、保存したすべての値を保ちます。
パースでは、未知のビットも含めて lockSettings のすべてのビットが保たれるため、後のリリースで追加されたロックも、ここで保存して失われることはありません。JSON Schema が確認するのは、整数であることだけです。4.0.0 より前のエディタは保存するときに lockSettings を取り除き、表示位置とタブを現在の状態のまま書き出すため、そのファイルはここでは再び 4.0.0 より前に保存したファイルとして開きます。
4.0.0 からは、ddlScripts が Schema SQL タブの 2 つのスクリプトを保持し、すべてのデータベースの 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[];
};
各リストは 1 種類のエンティティの順序で、DDL、テーブルの並べ替え、描画の順序がこれを読み取ります。保存形式では、各リストは残るエンティティの id だけを、それぞれ 1 回ずつ、並んでいる順に保持します。4.0.0 からは、tableGroupIds がテーブルグループの順序です。
4.0.0 からは、重なり順は保存されません。パースでは、zIndex を持たない、リストに並ぶ各テーブル、メモ、テーブルグループを、リスト内の位置に従って、後のものほど前面になるように重ねます。テーブルグループは 1 から、テーブルは 2 から始まり、メモはすべてのテーブルの上に重なります。ランタイム値や 4.0.0 より前に保存したファイルのように zIndex を持つエンティティは、その値を保ちます。そのため、テーブルやメモを最前面に移したことは、ファイルを開き直すと失われます。
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 からは、テーブルは、属するテーブルグループの id である groupId を持ちます。groupId がないか空の場合や、doc.tableGroupIds にないグループを指している場合はグループに属していないことを表し、保存形式は、残るグループを指している間だけ groupId を書き出します。
パースでは、seqColumnIds がないか、columnIds に並ぶ id が欠けている場合は、seqColumnIds を 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 を書き出しません。読み込むたびに、主キーのマークを options の primaryKey ビットから、外部キーのマークをそのカラムで終わるリレーションシップから求めて keys を導き出し、4 つの幅を計測します。
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 からは、リレーションシップは ON DELETE と ON UPDATE のアクションである onDelete と onUpdate を持ちます。それぞれ ReferentialAction の値を 1 つだけ保持します。既定値の none は句を書き出さないため、データベース自体の既定の動作が適用されます。残りの 5 つは NO ACTION、CASCADE、SET NULL、SET DEFAULT、RESTRICT を表します。Schema SQL は、そのアクションを受け付けるデータベースの場合にだけ句を書き出します。
保存形式は常に両方を書き出し、4.0.0 からは JSON Schema も両方を必須とします。JSON Schema が確認するのは、それぞれが整数であることだけです。パースでは引き続き、3.10.0 より前に保存したすべてのドキュメントのようにフィールドがない場合は none として読み込まれ、一覧にない値も同様です。
3.10.0 より前のエディタはこれらのフィールドを認識せず、ドキュメントを読み込むときに取り除くため、そのエディタで保存するとすべてのアクションが失われます。
4.0.0 からは、保存形式が含まないものは読み込むたびに導き出されます。リレーションシップは、終点のカラムがすべて主キーであれば識別リレーションシップになり、startRelationshipType は、それらのカラムがすべて NOT NULL であれば dash、そうでなければ ring になります。終点のカラムが 1 つも残っていないリレーションシップは、新しいリレーションシップの開始時と同じく、非識別リレーションシップで dash になります。接続位置、つまり x、y、direction は配置し直されます。
Collection: indexEntities
type Index = {
id: string;
name: string;
tableId: string;
indexColumnIds: string[];
seqIndexColumnIds: string[]; // runtime only
unique: boolean;
};
パースでは、seqIndexColumnIds がないか、indexColumnIds に並ぶ id が欠けている場合は、seqIndexColumnIds を 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 で順序付けられる 1 つの重なり順を共有するため、テーブルを前面に移すとメモの上に重なることがあります。Doc で説明しているとおり、パースでは、zIndex なしで保存したメモをすべてのテーブルの上に重ねます。4.0.0 より前に保存したファイルのメモは、保存した 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
正式なスキーマファイルは 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 からは、スキーマは保存形式だけを表します。名前付きのフィールドを持つオブジェクトはすべて閉じられ（additionalProperties: false）、保存形式が常に書き出すフィールドはすべて必須で、保存形式が含まないフィールドはどれも定義されていません。そのため、ランタイム値は受け付けません。以前のリリースで保存したファイルも、meta、幅、zIndex、ignoreSaveSettings などを持つため、4.0.0 のエディタで保存し直すまで受け付けません。3.2.0 以降で保存したファイルはすでにこのスキーマの 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
}
}
}