Schemă
.erd.json este formatul de document al editorului. Citiți această pagină dacă trebuie să generați, să validați sau să migrați un document în afara editorului.
Începând cu versiunea 4.0.0, un document are două serializări, ambele cu câmpul version egal cu '3.0.0'. Forma de stocare este ceea ce conține un fișier: este ceea ce returnează editor.value, ceea ce scrie exportul JSON și singura formă pe care o acceptă JSON Schema publicată. Valoarea de execuție este întregul document așa cum îl păstrează un editor, pe care îl returnează editor.runtimeValue. Metoda setInitialValue(), setterul value și metoda setSchemaJSON() citesc oricare dintre cele două forme, orice fișier salvat de o versiune anterioară și un document .vuerd v2. Înainte de versiunea 4.0.0, exista una singură: proprietatea value returna întregul document așa cum îl păstra editorul, cum face acum proprietatea runtimeValue.
Forma de stocare și valoarea de execuție
Forma de stocare conține doar entitățile existente: fiecare tabel listat în doc.tableIds, coloanele pe care le listează aceste tabele, relațiile dintre două tabele păstrate, indexurile tabelelor păstrate cu coloanele de index a căror coloană este încă listată de tabel, precum și notele și grupurile de tabele listate. Omite ceea ce un editor deduce la încărcare sau păstrează cât timp este deschis: entitățile eliminate, seqColumnIds și seqIndexColumnIds, fiecare câmp zIndex, lățimile măsurate, câmpul ui al coloanelor, precum și identification, startRelationshipType și ancorele unei relații. Tipurile de mai jos marchează fiecare dintre aceste câmpuri cu // runtime only.
Cheile fiecărei colecții sunt ID-urile, în ordinea unităților de cod, coloanele fiind grupate mai întâi după tableId, iar coloanele de index după indexId. Fiecare entitate își scrie câmpurile într-o ordine fixă, iar textul este indentat cu două spații și se termină cu un caracter de linie nouă. Astfel, același document scrie mereu aceiași octeți, o editare modifică doar ceea ce atinge, iar un fișier salvat pe un calculator cu alte fonturi se redeschide cu aceeași valoare pentru value.
VS Code, Obsidian și pluginul pentru JetBrains scriu un fișier doar când o editare modifică proprietatea value, așa că un fișier salvat de o versiune anterioară își păstrează forma veche până la prima editare.
Valoarea de execuție păstrează ceea ce omite forma de stocare: entitățile eliminate, secvențele, valorile z-index, lățimile, marcajele de cheie, indicatorii relațiilor și ancorele. Este indentată cu două spații, fără caracter de linie nouă la final. Folosiți-o doar pentru a inițializa un colaborator sau o a doua vizualizare prin metoda setInitialValue(), astfel încât, atunci când un alt editor trimite anularea unei eliminări, entitatea să revină acolo întreagă. Nu o scrieți niciodată într-un fișier; JSON Schema o refuză. Nimic nu mai colectează entitățile eliminate, așa că valoarea de execuție le păstrează până la următoarea deschidere a documentului din fișierul său.
Ambele forme scriu fiecare setare blocată cu valoarea ei blocată (consultați lockSettings), câmpul settings.ddlScripts doar cât timp un script conține text, iar câmpul groupId al unui tabel doar cât timp nu este gol. Forma de stocare scrie doc.tableGroupIds și tableGroupEntities doar cât timp există un grup de tabele; valoarea de execuție le scrie cât timp documentul conține un grup sau unul eliminat.
TypeScript
Tipurile descriu valoarea de execuție. Un câmp marcat cu // runtime only este omis din forma de stocare, iar un câmp marcat cu ? este scris doar cât timp conține ceva.
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>;
};
};
Cheia fiecărei entități este câmpul ei id, un șir de caractere opac; parsarea renunță la orice entitate al cărei câmp id lipsește sau este gol. Începând cu versiunea 4.0.0, fiecare ID nou este un UUIDv7 scris în forma Uuid25, adică 25 de cifre în baza 36, cu litere mici, de exemplu 03gzrxjv20bdlcak89q25d2m7, astfel încât ID-urile generate de un editor se sortează în ordinea în care le-a creat. Un document păstrează ID-urile pe care le conține, de exemplu ID-urile nanoid ale unei versiuni anterioare sau ID-urile unui fișier v2, așa că nimic nu ar trebui să se bazeze pe forma unui ID.
Începând cu versiunea 4.0.0, nicio entitate nu are un obiect meta (createAt, updateAt), iar tipurile EntityMeta și EntityType au fost eliminate. Nimic nu îl scrie, parsarea renunță la obiectul meta dintr-un fișier mai vechi, iar JSON Schema îl refuză. Acesta determina doar momentul colectării gunoiului pentru entitățile eliminate, care nu mai există nici ea.
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;
Câmpurile originX și originY reprezintă vizualizarea: punctul de pe ecran în care ajunge punctul (0, 0) al scenei.
Câmpul zoomLevel ia valori de la 0.1 la 1.5. Un document salvat cu o valoare peste 1 se deschide la 1 într-un editor anterior versiunii 3.5.0.
Începând cu versiunea 4.0.0, setările nu conțin câmpurile width, height, scrollTop, scrollLeft, relationshipOptimization sau ignoreSaveSettings. Nimic nu le scrie, parserul nu păstrează niciunul dintre ele, iar JSON Schema refuză un fișier care le mai conține.
Câmpul canvasType este fila pe care se deschide un document. Un document salvat pe fila Vizualizare conține '@dineug/erd-editor/builtin-visualization', dar nu și dacă era afișat modul Graph sau Flow, iar un editor nou creat afișează această filă în modul Graph.
Începând cu versiunea 4.0.0, cât timp blocarea Canvas Type este activată, cum este într-un document nou, documentul păstrează fila afișată în momentul blocării, iar schimbarea filei lasă proprietatea value așa cum era. O blocare activată pe fila Setări reține fila din care a venit cititorul, iar o valoare blocată 'settings', pe care o poate scrie doar o editare manuală, se deschide pe 'ERD'.
Nimic din starea proprie a modului Flow nu este serializat – plasarea, zoomul, deplasarea, afișarea rândurilor și tabelele focalizate rămân în editor –, așa că originX, originY și zoomLevel descriu întotdeauna pânza ERD.
Câmpurile show și lockSettings sunt măști de biți: combinați indicatorii cu OR.
Câmpul columnOrder este un tablou care conține toate cele șapte valori ColumnType, în ordinea afișării.
Câmpurile database, language, tableNameCase, columnNameCase și bracketType conțin fiecare exact o valoare, iar JSON Schema respinge o valoare combinată.
Într-un document nou, câmpul show are valoarea 431: tableComment, columnComment, columnDataType, columnDefault, columnPrimaryKey, columnNotNull și relationship.
Începând cu versiunea 3.10.0, câmpul show are încă doi indicatori, ambii dezactivați într-un document nou și în orice document salvat înainte de versiunea 3.10.0.
Indicatorul columnAlternateKey (512) este opțiunea de afișare Alternate Key. Când este activat, marchează coloanele fiecărui index unic pe două sau mai multe coloane cu AK1.1, AK1.2 și așa mai departe. Inițial este dezactivat, așa că nicio diagramă existentă nu își schimbă lățimea.
Indicatorul hideReferentialAction (1024) funcționează invers: când este activat, ascunde etichetele ON DELETE și ON UPDATE de pe conectori, așa că acestea sunt afișate implicit. Opțiunea de afișare Referential Actions este bifată cât timp indicatorul este dezactivat. Nu modifică dimensiunea niciunui tabel.
Un editor anterior versiunii 3.10.0 păstrează câmpul show ca număr întreg, așa că ambii indicatori se păstrează și după o salvare acolo.
Începând cu versiunea 4.0.0, câmpul show are încă doi indicatori, ambii dezactivați într-un document nou și în orice document salvat înainte de versiunea 4.0.0. La fel ca hideReferentialAction, fiecare ascunde ceea ce numește, așa că grupurile de tabele și notele sunt afișate implicit.
Indicatorul hideTableGroup (2048) ascunde grupurile de tabele, iar hideMemo (4096) ascunde toate notele. Acestea sunt opțiunile de afișare Table Groups și Memos, fiecare bifată cât timp indicatorul corespunzător este dezactivat. Niciunul nu modifică dimensiunea vreunui tabel.
Un editor anterior versiunii 4.0.0 păstrează câmpul show ca număr întreg, așa că ambii indicatori se păstrează și după o salvare acolo.
Începând cu versiunea 4.0.0, constanta Language are încă opt ținte ale generatorului de cod, de la Mermaid până la JSONSchema. O valoare language pe care parserul nu o cunoaște este citită ca GraphQL, așa că un editor anterior versiunii 4.0.0 deschide pe GraphQL un document salvat cu una dintre ele, iar o salvare acolo scrie GraphQL.
Începând cu versiunea 4.0.0, câmpul lockSettings ia locul câmpului ignoreSaveSettings, iar tipul LockSettingType pe cel al tipului SaveSettingType, care a fost eliminat. Câmpul lockSettings numește setările pe care un document le salvează așa cum erau în momentul blocării. Bitul viewport acoperă împreună originX, originY și zoomLevel, deoarece o origine salvată fără zoomul ei se deschide în alt loc, iar fiecare dintre ceilalți biți acoperă câmpul după care este numit. Acestea sunt rândurile Lock din fila Setări.
O setare blocată este scrisă cu valoarea ei blocată, indiferent ce afișează editorul, atât de value, cât și de runtimeValue, iar orice altă setare este scrisă așa cum este. Astfel, cât timp blocarea corespunzătoare este activată, derularea și zoomul, schimbarea filei sau modificarea limbajului generatorului de cod, a unui stil de denumire ori a tipului de delimitator lasă fișierul așa cum era. Blocarea preia valoarea pe care o are setarea în acel moment, iar parsarea preia valoarea blocată din câmpul salvat.
Un document pornit de la zero – un editor sau un store de replicare nou, ori o valoare goală transmisă proprietății value sau metodei setInitialValue() – are câmpul lockSettings egal cu 63, adică toate blocările activate. Un document al cărui obiect settings nu conține câmpul lockSettings – orice fișier salvat înainte de versiunea 4.0.0, indiferent de valoarea ignoreSaveSettings, și orice document v2 – se deschide de asemenea cu toate blocările activate: vizualizarea și fila sunt cele ale unui document nou (originX și originY la 0, zoomLevel la 1, fila ERD), iar limbajul, stilurile de denumire și tipul de delimitator sunt blocate la valorile salvate. Un document care își numește blocările le păstrează, inclusiv 0, precum și fiecare valoare pe care a salvat-o.
Parsarea păstrează fiecare bit din lockSettings, inclusiv pe cei necunoscuți, așa că o blocare adăugată de o versiune ulterioară se păstrează după o salvare aici; JSON Schema verifică doar că este un număr întreg. Un editor anterior versiunii 4.0.0 renunță la lockSettings când salvează și scrie vizualizarea și fila așa cum sunt, astfel că fișierul se deschide din nou aici ca unul salvat înainte de versiunea 4.0.0.
Începând cu versiunea 4.0.0, câmpul ddlScripts conține cele două scripturi ale filei Schemă SQL, pe care le scrie codul DDL pentru fiecare bază de date: before după antet și înaintea tabelelor, after după codul DDL generat. Codul DDL le scrie pe fiecare cu sfârșituri de linie LF, fără liniile goale de la început și fără spațiile albe de la final, iar pentru MSSQL le încheie cu GO, așa cum se descrie în Scripturi înainte și după tabele; câmpul ddlScripts însuși păstrează fiecare script așa cum a fost tastat. Cheia este scrisă doar cât timp unul dintre scripturi conține text, și atunci cu ambele; o cheie lipsă sau un script care nu este un șir de caractere este citit ca ''. Opțiunile Statements, Header și Tables ale filei nu se salvează în document.
Un editor anterior versiunii 4.0.0 renunță la scripturi când încarcă un document, așa că o salvare acolo le pierde.
Constantele Database, Language, Show, LockSettingType și ReferentialAction se extind doar prin adăugare la final. Un document salvat stochează numărul, așa că un nou sistem de baze de date, o nouă țintă de generare de cod, un nou indicator, o nouă blocare sau o nouă acțiune primește bitul următor, nu o poziție la mijloc.
Doc
type Doc = {
tableIds: string[];
relationshipIds: string[];
indexIds: string[];
memoIds: string[];
tableGroupIds?: string[];
};
Fiecare listă este ordinea unui tip de entitate, pe care o citesc codul DDL, sortarea tabelelor și ordinea de desenare. În forma de stocare, fiecare listă conține doar ID-urile entităților păstrate, fiecare o singură dată, în ordinea listată. Începând cu versiunea 4.0.0, lista tableGroupIds este ordinea grupurilor de tabele.
Începând cu versiunea 4.0.0, ordinea de suprapunere nu se salvează. Parsarea așază în stivă fiecare tabel, notă și grup de tabele listat care nu are câmpul zIndex după poziția sa în listă, cele care urmează fiind în față: grupurile de tabele de la 1, tabelele de la 2, iar notele deasupra tuturor tabelelor. O entitate care are câmpul zIndex, ca într-o valoare de execuție sau într-un fișier salvat înainte de versiunea 4.0.0, îl păstrează. Prin urmare, aducerea unui tabel sau a unei note în prim-plan se pierde la redeschiderea fișierului.
Colecție: 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;
};
Începând cu versiunea 4.0.0, un tabel are câmpul groupId, ID-ul grupului de tabele căruia îi aparține. Un câmp groupId lipsă sau gol, ori unul care nu numește niciun grup din doc.tableGroupIds, înseamnă că tabelul nu are grup, iar forma de stocare îl scrie doar cât timp numește un grup păstrat.
Parsarea inițializează seqColumnIds cu columnIds când acesta lipsește sau nu conține un ID listat, iar un editor măsoară din nou widthName și widthComment cu propriile fonturi la fiecare încărcare.
Colecție: 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;
Începând cu versiunea 4.0.0, forma de stocare nu scrie câmpul ui al coloanelor. Fiecare încărcare deduce câmpul keys – marcajul de cheie primară din bitul primaryKey al câmpului options, iar marcajul de cheie străină din relațiile care se termină pe coloană – și măsoară cele patru lățimi.
Un editor anterior versiunii 4.0.0 afișează coloanele unui fișier salvat aici fără pictogramele de cheie primară.
Colecție: 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;
Începând cu versiunea 3.10.0, o relație are câmpurile onDelete și onUpdate, acțiunile sale ON DELETE și ON UPDATE. Fiecare conține exact o valoare ReferentialAction. Valoarea none, cea implicită, nu scrie nicio clauză, așa că se aplică valoarea implicită a bazei de date. Celelalte cinci corespund acțiunilor NO ACTION, CASCADE, SET NULL, SET DEFAULT și RESTRICT. Fila Schemă SQL scrie o clauză doar pentru o bază de date care acceptă acțiunea respectivă.
Forma de stocare le scrie întotdeauna pe amândouă, iar, începând cu versiunea 4.0.0, JSON Schema le cere, verificând doar că fiecare este un număr întreg. Parsarea citește în continuare un câmp lipsă, ca în orice document salvat înainte de versiunea 3.10.0, ca none, la fel și o valoare din afara listei.
Un editor anterior versiunii 3.10.0 nu cunoaște aceste câmpuri și renunță la ele când încarcă un document, așa că o salvare acolo pierde toate acțiunile.
Începând cu versiunea 4.0.0, fiecare încărcare deduce ceea ce omite forma de stocare. O relație este identificatoare când fiecare coloană pe care se termină este o cheie primară, iar câmpul ei startRelationshipType este dash când fiecare astfel de coloană este NOT NULL și ring în caz contrar; o relație căreia nu i-a mai rămas nicio coloană de capăt este neidentificatoare și dash, așa cum pornește o relație nouă. Ancorele, x, y și direction, sunt plasate din nou.
Colecție: indexEntities
type Index = {
id: string;
name: string;
tableId: string;
indexColumnIds: string[];
seqIndexColumnIds: string[]; // runtime only
unique: boolean;
};
Parsarea inițializează seqIndexColumnIds cu indexColumnIds când acesta lipsește sau nu conține un ID listat.
Colecție: indexColumnEntities
type IndexColumn = {
id: string;
indexId: string;
columnId: string;
orderType: number; // Constants: OrderType
};
// Constants
const OrderType = {
ASC: 1,
DESC: 2,
} as const;
Colecție: 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;
};
Începând cu versiunea 4.0.0, tabelele și notele împart aceeași stivă, ordonată după zIndex, așa că aducerea unui tabel în prim-plan îl poate plasa peste o notă. Parsarea plasează o notă salvată fără zIndex deasupra tuturor tabelelor, așa cum se descrie în Doc. O notă dintr-un fișier salvat înainte de versiunea 4.0.0 își păstrează valoarea zIndex salvată, care provenea din același contor ca valorile tabelelor, așa că o notă pe care o versiune anterioară a desenat-o peste toate tabelele se poate deschide sub un tabel adus în prim-plan după ea.
Colecție: 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
};
Începând cu versiunea 4.0.0, un document poate conține grupuri de tabele: dreptunghiuri denumite și colorate, desenate în spatele tabelelor. Un tabel intră într-un grup prin propriul câmp groupId, așa că un grup nu conține o listă de membri. Forma de stocare scrie colecția, la fel ca doc.tableGroupIds, doar cât timp există un grup, iar un document fără ea, de exemplu unul salvat înainte de versiunea 4.0.0, nu are grupuri. Indicatorul Show.hideTableGroup le ascunde.
Un editor anterior versiunii 4.0.0 renunță la grupuri și la câmpul groupId al fiecărui tabel când încarcă un document, așa că o salvare acolo pierde toate grupurile.
JSON Schema
Fișierul de schemă canonic este publicat la json-schema/schema.json și poate fi referențiat direct prin câmpul $schema.
{
"$schema": "https://raw.githubusercontent.com/dineug/erd-editor/main/json-schema/schema.json",
"version": "3.0.0"
}
Puneți câmpul $schema la începutul unui fișier .erd.json, iar editoarele care înțeleg JSON Schema, de exemplu VS Code, validează documentul și completează automat câmpurile pe măsură ce editați.
Începând cu versiunea 4.0.0, schema descrie doar forma de stocare. Fiecare obiect cu câmpuri denumite este închis (additionalProperties: false), fiecare câmp pe care forma de stocare îl scrie întotdeauna este obligatoriu, iar niciun câmp pe care ea îl omite nu este numit. Prin urmare, refuză valoarea de execuție. Refuză și un fișier salvat înainte de versiunea 4.0.0, cu câmpul său meta, lățimile, zIndex, ignoreSaveSettings și celelalte, până când un editor cu versiunea 4.0.0 sau o versiune ulterioară salvează din nou acel fișier. Un fișier salvat de versiunea 3.2.0 sau de o versiune ulterioară numește deja URL-ul acestei scheme, care indică ramura main, așa că un editor care validează pe baza ei semnalează acum fișierul. Un fișier salvat de versiunea 3.0.0 sau 3.1.0, ori un document v2, nu conține niciun câmp $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
}
}
}