Schéma
.erd.json je formát dokumentov editora. Túto stránku si prečítajte, ak potrebujete dokument generovať, overovať alebo migrovať mimo editora.
Od verzie 4.0.0 má dokument dve serializácie, obe s hodnotou '3.0.0' v poli version. Úložná forma je to, čo obsahuje súbor: vracia ju editor.value, zapisuje ju export JSON a je jedinou formou, ktorú prijíma zverejnená JSON Schema. Hodnota za behu je celý dokument tak, ako ho drží editor, a vracia ju editor.runtimeValue. Metóda setInitialValue(), setter value a metóda setSchemaJSON() načítajú obe formy, akýkoľvek súbor uložený staršou verziou a dokument .vuerd vo formáte v2. Pred verziou 4.0.0 existovala iba jedna: vlastnosť value vracala celý dokument tak, ako ho držal editor, rovnako ako teraz vlastnosť runtimeValue.
Úložná forma a hodnota za behu
Úložná forma obsahuje iba aktuálne entity: každú tabuľku uvedenú v doc.tableIds, stĺpce, ktoré tieto tabuľky uvádzajú, vzťahy medzi dvoma zachovanými tabuľkami, indexy zachovaných tabuliek so stĺpcami indexu, ktorých stĺpec tabuľka stále uvádza, a uvedené poznámky a skupiny tabuliek. Vynecháva to, čo editor odvodí pri načítaní alebo drží, kým je otvorený: odstránené entity, polia seqColumnIds a seqIndexColumnIds, všetky polia zIndex, namerané šírky, pole ui stĺpca a identification, startRelationshipType a body ukotvenia vzťahu. Nižšie uvedené typy označujú každé z týchto polí ako // runtime only.
Každá kolekcia má ako kľúče identifikátory zoradené v poradí kódových jednotiek, pričom stĺpce sú najprv zoskupené podľa tableId a stĺpce indexov podľa indexId. Každá entita zapisuje svoje polia v pevnom poradí a text je odsadený dvoma medzerami a končí znakom nového riadka. Rovnaký dokument sa preto vždy zapíše do rovnakých bajtov, úprava zmení iba to, čoho sa týka, a súbor uložený na počítači s inými písmami sa znova otvorí s rovnakou hodnotou value.
VS Code, Obsidian a doplnok pre JetBrains zapisujú súbor iba vtedy, keď úprava zmení hodnotu value, takže súbor uložený staršou verziou si zachová svoju starú formu až do prvej úpravy.
Hodnota za behu zachováva to, čo úložná forma vynecháva: odstránené entity, sekvencie, z-indexy, šírky, značky kľúčov, príznaky vzťahov a body ukotvenia. Je odsadená dvoma medzerami a nekončí znakom nového riadka. Používajte ju iba na inicializáciu spolupracovníka alebo druhého zobrazenia pomocou metódy setInitialValue(), aby vrátenie späť odstránenia, ktoré pošle iný editor, tam obnovilo celú entitu. Nikdy ju nezapisujte do súboru; JSON Schema ju odmietne. Na odstránené entity sa už nevzťahuje zber nepotrebných údajov (garbage collection), takže hodnota za behu ich zachováva, kým sa dokument nabudúce neotvorí zo svojho súboru.
Obe formy zapisujú každé zamknuté nastavenie s jeho zamknutou hodnotou (pozrite si pole lockSettings), pole settings.ddlScripts iba vtedy, keď niektorý skript obsahuje text, a pole groupId tabuľky iba vtedy, keď nie je prázdne. Úložná forma zapisuje doc.tableGroupIds a tableGroupEntities iba vtedy, keď existuje skupina tabuliek; hodnota za behu ich zapisuje, kým dokument obsahuje skupinu alebo odstránenú skupinu.
TypeScript
Typy opisujú hodnotu za behu. Pole označené // runtime only sa v úložnej forme vynecháva a pole označené ? sa zapisuje iba vtedy, keď niečo obsahuje.
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>;
};
};
Kľúčom každej entity je jej id, nepriehľadný reťazec; pri parsovaní sa entita, ktorej pole id chýba alebo je prázdne, zahodí. Od verzie 4.0.0 je každý nový identifikátor UUIDv7 zapísaný vo forme Uuid25, ako 25 číslic v sústave so základom 36 písaných malými písmenami, napríklad 03gzrxjv20bdlcak89q25d2m7, takže identifikátory, ktoré vytvorí jeden editor, sa zoradia v poradí, v akom ich vytvoril. Dokument si ponechá identifikátory, ktoré obsahuje, napríklad identifikátory nanoid staršej verzie alebo identifikátory súboru vo formáte v2, takže nič by sa nemalo spoliehať na tvar identifikátora.
Od verzie 4.0.0 nemá žiadna entita objekt meta (createAt, updateAt) a typy EntityMeta a EntityType boli odstránené. Nič ho nezapisuje, pri parsovaní sa objekt meta zo staršieho súboru zahodí a JSON Schema ho odmietne. Slúžil iba na časovanie zberu nepotrebných údajov (garbage collection) pri odstránených entitách, ktorý takisto zanikol.
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 a originY predstavujú zobrazenie: bod obrazovky, na ktorý pripadne bod scény (0, 0).
Hodnota zoomLevel je v rozsahu od 0.1 do 1.5. Dokument uložený s hodnotou nad 1 sa v editore staršom ako verzia 3.5.0 otvorí s hodnotou 1.
Od verzie 4.0.0 nastavenia neobsahujú polia width, height, scrollTop, scrollLeft, relationshipOptimization ani ignoreSaveSettings. Nič ich nezapisuje, parser nezachová žiadne z nich a JSON Schema odmietne súbor, ktorý ich ešte obsahuje.
canvasType je karta, na ktorej sa dokument otvorí. Dokument uložený na karte Vizualizácia obsahuje '@dineug/erd-editor/builtin-visualization', ale nie to, či bol zobrazený režim Graph alebo Flow, a novo vytvorený editor zobrazí túto kartu v režime Graph.
Od verzie 4.0.0 si dokument, kým je zapnuté zamknutie Canvas Type, ako je to v novom dokumente, ponechá kartu, ktorá bola zobrazená v čase zamknutia, a prepínanie kariet ponechá hodnotu value bez zmeny. Zamknutie na karte Nastavenia zachová kartu, z ktorej ste na ňu prišli, a zamknutá hodnota 'settings', ktorú možno zapísať iba ručnou úpravou, sa otvorí ako 'ERD'.
Žiadny vlastný stav režimu Flow sa neserializuje – jeho rozmiestnenie, priblíženie, posúvanie, zobrazenie riadkov a zameranie na tabuľky zostávajú v editore –, takže originX, originY a zoomLevel vždy opisujú plátno ERD.
show a lockSettings sú bitové masky – príznaky kombinujte operáciou OR.
columnOrder je pole, ktoré obsahuje všetkých sedem hodnôt ColumnType v poradí zobrazenia.
Každé z polí database, language, tableNameCase, columnNameCase a bracketType obsahuje práve jednu hodnotu a JSON Schema kombinovanú hodnotu odmietne.
V novom dokumente má show hodnotu 431: tableComment, columnComment, columnDataType, columnDefault, columnPrimaryKey, columnNotNull a relationship.
Od verzie 3.10.0 existujú ďalšie dva príznaky show, oba vypnuté v novom dokumente aj v každom dokumente uloženom pred verziou 3.10.0.
columnAlternateKey (512) je možnosť zobrazenia Alternate Key. Ak je príznak nastavený, stĺpce každého jedinečného indexu nad dvoma alebo viacerými stĺpcami sa označia ako AK1.1, AK1.2 a tak ďalej. Na začiatku je vypnutý, takže šírka žiadneho existujúceho diagramu sa nezmení.
hideReferentialAction (1024) funguje opačne: ak je príznak nastavený, skryje popisy ON DELETE a ON UPDATE na spojniciach, takže predvolene sú zobrazené. Možnosť zobrazenia Referential Actions je začiarknutá, kým je príznak vypnutý. Nemení veľkosť žiadnej tabuľky.
Editor starší ako verzia 3.10.0 uchováva show ako celé číslo, takže pri uložení v ňom sa oba príznaky zachovajú.
Od verzie 4.0.0 existujú ďalšie dva príznaky show, oba vypnuté v novom dokumente aj v každom dokumente uloženom pred verziou 4.0.0. Podobne ako hideReferentialAction každý z nich skryje to, čo pomenúva, takže skupiny tabuliek a poznámky sú predvolene zobrazené.
hideTableGroup (2048) skryje skupiny tabuliek a hideMemo (4096) skryje všetky poznámky. Zodpovedajú možnostiam zobrazenia Table Groups a Memos, z ktorých každá je začiarknutá, kým je jej príznak vypnutý. Ani jeden z nich nemení veľkosť žiadnej tabuľky.
Editor starší ako verzia 4.0.0 uchováva show ako celé číslo, takže pri uložení v ňom sa oba príznaky zachovajú.
Od verzie 4.0.0 má konštanta Language osem ďalších cieľových jazykov pre Generátor kódu, od Mermaid po JSONSchema. Hodnota language, ktorú parser nepozná, sa načíta ako GraphQL, takže editor starší ako verzia 4.0.0 otvorí dokument, ktorý bol uložený s jedným z nich, s jazykom GraphQL a uložením v ňom sa zapíše GraphQL.
Od verzie 4.0.0 zaujíma pole lockSettings miesto poľa ignoreSaveSettings a konštanta LockSettingType miesto konštanty SaveSettingType, ktorá bola odstránená. Pole lockSettings určuje nastavenia, ktoré dokument ukladá v stave, v akom boli v čase zamknutia. Bit viewport pokrýva polia originX, originY a zoomLevel spoločne, pretože počiatok uložený bez svojho priblíženia sa otvorí inde, a každý ďalší bit pokrýva pole, podľa ktorého je pomenovaný. Zodpovedajú riadkom Lock na karte Nastavenia.
Vlastnosti value aj runtimeValue zapisujú zamknuté nastavenie s jeho zamknutou hodnotou bez ohľadu na to, čo editor zobrazuje, a každé ďalšie nastavenie v jeho aktuálnom stave. Kým je teda zapnuté príslušné zamknutie, posúvanie a zmena priblíženia, prepínanie kariet alebo zmena jazyka na karte Generátor kódu, štýlu názvov či typu úvodzoviek ponechá súbor bez zmeny. Zamknutie prevezme hodnotu, ktorú má nastavenie v tej chvíli, a pri parsovaní sa zamknutá hodnota prevezme z uloženého poľa.
Dokument začatý od nuly – nový editor alebo replikačné úložisko či prázdna hodnota zadaná do value alebo setInitialValue() – má pole lockSettings nastavené na 63, čiže všetky zamknutia sú zapnuté. Dokument, ktorého settings neobsahujú lockSettings – každý súbor uložený pred verziou 4.0.0 bez ohľadu na jeho ignoreSaveSettings a každý dokument vo formáte v2 –, sa takisto otvorí so všetkými zamknutiami zapnutými: jeho zobrazenie a karta sú rovnaké ako v novom dokumente (originX a originY 0, zoomLevel 1, karta ERD) a jeho jazyk, štýly názvov a typ úvodzoviek sú zamknuté na uložených hodnotách. Dokument, ktorý svoje zamknutia uvádza, si ich zachová vrátane 0 a takisto všetky hodnoty, ktoré uložil.
Pri parsovaní sa zachová každý bit poľa lockSettings vrátane neznámych, takže zamknutie, ktoré pridá novšia verzia, sa pri uložení v tejto verzii zachová; JSON Schema overuje iba to, či ide o celé číslo. Editor starší ako verzia 4.0.0 pri ukladaní pole lockSettings zahodí a zobrazenie a kartu zapíše v aktuálnom stave, takže súbor sa v tejto verzii znova otvorí ako súbor uložený pred verziou 4.0.0.
Od verzie 4.0.0 obsahuje pole ddlScripts dva skripty z karty Schéma SQL, ktoré DDL zapisuje pre každú databázu: before za hlavičku a pred tabuľky, after za vygenerovaný kód DDL. DDL zapíše každý z nich so zalomeniami riadkov LF, bez úvodných prázdnych riadkov a koncových prázdnych znakov a pri MSSQL ukončený príkazom GO, ako opisuje časť Skripty pred tabuľkami a za nimi; samotné pole ddlScripts uchováva každý skript tak, ako bol zadaný. Kľúč sa zapisuje iba vtedy, keď niektorý zo skriptov obsahuje text, a vtedy s oboma; chýbajúci kľúč alebo skript, ktorý nie je reťazcom, sa načíta ako ''. Voľby Statements, Header a Tables na tejto karte sa v dokumente neukladajú.
Editor starší ako verzia 4.0.0 pri načítaní dokumentu skripty zahodí, takže uložením v ňom sa stratia.
Do konštánt Database, Language, Show, LockSettingType a ReferentialAction sa hodnoty iba pridávajú. Uložený dokument uchováva číslo, takže nový databázový systém, cieľ generovania kódu, príznak, zamknutie alebo akcia dostane nasledujúci bit namiesto miesta uprostred.
Doc
type Doc = {
tableIds: string[];
relationshipIds: string[];
indexIds: string[];
memoIds: string[];
tableGroupIds?: string[];
};
Každý zoznam určuje poradie jedného druhu entít, z ktorého vychádzajú DDL, triedenie tabuliek a poradie vykresľovania. V úložnej forme obsahuje každý zoznam iba identifikátory zachovaných entít, každý raz, v uvedenom poradí. Od verzie 4.0.0 určuje pole tableGroupIds poradie skupín tabuliek.
Od verzie 4.0.0 sa poradie prekrývania neukladá. Pri parsovaní sa každá uvedená tabuľka, poznámka a skupina tabuliek, ktorá nemá pole zIndex, zaradí do poradia prekrývania podľa svojho miesta vo svojom zozname, pričom neskoršie sú vpredu: skupiny tabuliek od 1, tabuľky od 2 a poznámky nad všetkými tabuľkami. Entita, ktorá má pole zIndex, ako v hodnote za behu alebo v súbore uloženom pred verziou 4.0.0, si ho ponechá. Presunutie tabuľky alebo poznámky dopredu sa preto pri opätovnom otvorení súboru stratí.
Kolekcia: 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;
};
Od verzie 4.0.0 má tabuľka pole groupId, identifikátor skupiny tabuliek, do ktorej patrí. Chýbajúce alebo prázdne pole groupId alebo také, ktoré neoznačuje žiadnu skupinu v doc.tableGroupIds, znamená, že tabuľka nemá skupinu, a úložná forma ho zapisuje iba vtedy, keď označuje zachovanú skupinu.
Ak pole seqColumnIds chýba alebo v ňom chýba niektorý uvedený identifikátor, pri parsovaní sa nastaví na columnIds a editor pri každom načítaní znova zmeria widthName a widthComment pomocou vlastných písiem.
Kolekcia: 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;
Od verzie 4.0.0 úložná forma nezapisuje pole ui stĺpca. Pri každom načítaní sa odvodí pole keys, značka primárneho kľúča z bitu primaryKey poľa options a značka cudzieho kľúča zo vzťahov, ktoré končia na danom stĺpci, a zmerajú sa štyri šírky.
Editor starší ako verzia 4.0.0 zobrazí stĺpce súboru uloženého v tejto verzii bez ikon primárneho kľúča.
Kolekcia: 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;
Od verzie 3.10.0 má vzťah polia onDelete a onUpdate, ktoré predstavujú jeho akcie ON DELETE a ON UPDATE. Každé z nich obsahuje práve jednu hodnotu ReferentialAction. Predvolená hodnota none nezapisuje žiadnu klauzulu, takže platí predvolené správanie samotnej databázy. Ostatných päť zodpovedá NO ACTION, CASCADE, SET NULL, SET DEFAULT a RESTRICT. Schéma SQL zapíše klauzulu iba pre databázu, ktorá danú akciu prijíma.
Úložná forma vždy zapisuje obe polia a od verzie 4.0.0 ich JSON Schema vyžaduje, pričom overuje iba to, či je každé z nich celé číslo. Pri parsovaní sa chýbajúce pole, ako v každom dokumente uloženom pred verziou 3.10.0, stále načíta ako none, a rovnako aj hodnota mimo zoznamu.
Editor starší ako verzia 3.10.0 tieto polia nepozná a pri načítaní dokumentu ich zahodí, takže uložením v ňom sa stratia všetky akcie.
Od verzie 4.0.0 sa pri každom načítaní odvodí to, čo úložná forma vynecháva. Vzťah je identifikujúci, keď je každý stĺpec, na ktorom končí, primárnym kľúčom, a jeho pole startRelationshipType má hodnotu dash, keď je každý takýto stĺpec NOT NULL, inak ring; vzťah, ktorému nezostal žiadny koncový stĺpec, je neidentifikujúci a má hodnotu dash, tak ako začína nový vzťah. Body ukotvenia x, y a direction sa umiestnia znova.
Kolekcia: indexEntities
type Index = {
id: string;
name: string;
tableId: string;
indexColumnIds: string[];
seqIndexColumnIds: string[]; // runtime only
unique: boolean;
};
Ak pole seqIndexColumnIds chýba alebo v ňom chýba niektorý uvedený identifikátor, pri parsovaní sa nastaví na indexColumnIds.
Kolekcia: indexColumnEntities
type IndexColumn = {
id: string;
indexId: string;
columnId: string;
orderType: number; // Constants: OrderType
};
// Constants
const OrderType = {
ASC: 1,
DESC: 2,
} as const;
Kolekcia: 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;
};
Od verzie 4.0.0 tabuľky a poznámky zdieľajú jedno poradie prekrývania určené hodnotou zIndex, takže tabuľka sa po presunutí dopredu môže dostať nad poznámku. Pri parsovaní sa poznámka uložená bez poľa zIndex zaradí nad všetky tabuľky, ako opisuje časť Doc. Poznámka v súbore uloženom pred verziou 4.0.0 si ponechá uložený zIndex, ktorý pochádzal z rovnakého počítadla ako pri tabuľkách, takže poznámka, ktorú staršia verzia vykreslila nad všetkými tabuľkami, sa môže otvoriť pod tabuľkou, ktorá bola po nej presunutá dopredu.
Kolekcia: 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
};
Od verzie 4.0.0 môže dokument obsahovať skupiny tabuliek: pomenované farebné obdĺžniky vykreslené za tabuľkami. Tabuľka sa k skupine pripojí prostredníctvom vlastného poľa groupId, takže skupina neobsahuje zoznam členov. Úložná forma zapisuje kolekciu, podobne ako doc.tableGroupIds, iba vtedy, keď existuje nejaká skupina, a dokument bez tejto kolekcie, napríklad uložený pred verziou 4.0.0, nemá žiadne skupiny. Príznak Show.hideTableGroup ich skryje.
Editor starší ako verzia 4.0.0 pri načítaní dokumentu zahodí skupiny aj pole groupId každej tabuľky, takže uložením v ňom sa stratia všetky skupiny.
JSON Schema
Kanonický súbor schémy je zverejnený na adrese json-schema/schema.json a možno naň priamo odkazovať pomocou $schema.
{
"$schema": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"version": "3.0.0"
}
Uveďte pole $schema na začiatku súboru .erd.json a editory, ktoré rozumejú JSON Schema, napríklad VS Code, budú počas úprav dokument overovať a automaticky dopĺňať jeho polia.
Od verzie 4.0.0 schéma opisuje iba úložnú formu. Každý objekt s pomenovanými poľami je uzavretý (additionalProperties: false), každé pole, ktoré úložná forma vždy zapisuje, je povinné a žiadne pole, ktoré vynecháva, nie je uvedené. Hodnotu za behu preto odmietne. Odmietne aj súbor uložený pred verziou 4.0.0 s jeho meta, šírkami, zIndex, ignoreSaveSettings a ďalšími poľami, kým tento súbor znova neuloží editor vo verzii 4.0.0 alebo novšej. Súbor uložený verziou 3.2.0 alebo novšou už uvádza adresu URL tejto schémy, ktorá odkazuje na vetvu main, takže editor, ktorý podľa nej overuje, teraz súbor označí ako chybný. Súbor uložený verziou 3.0.0 či 3.1.0 alebo dokument vo formáte v2 neuvádza $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
}
}
}