Tools

Der Server bietet 63 Tools: fünf Sitzungs-Tools, drei Lese-Tools, 54 Bearbeitungs-Tools, je eines pro Bearbeitungsvorgang, und erd_batch, das mehrere Bearbeitungs-Tools als eine Änderung ausführt.

Jedes Tool außer erd_list_documents erhält als erstes Argument den path des Dokuments, und die Tabellen unten führen ihn nicht auf. Ein mit ? gekennzeichnetes Argument ist optional.

Sitzungs-Tools

Tool	Argumente	Was es tut
erd_list_documents		Listet ERD-Dokumente mit path, open, active, dirty und readonly auf: die des Editors, der das Arbeitsverzeichnis bedient, was in einer JetBrains-IDE jedes geöffnete Projekt umfasst, andernfalls die ERD-Dateien unter dem Arbeitsverzeichnis.
erd_open_document	create?	Öffnet ein Dokument zum Bearbeiten, und zwar im ERD Editor des Editors, der es bedient, falls es einen solchen gibt. Mit create legt es die Datei zuerst an, wenn sie fehlt, und ein Name ohne Endung erhält .erd.json.
erd_save		Speichert ein Dokument, das ein Editor hält. VS Code lässt die Änderungen des Agenten ungespeichert, bis dieses Tool aufgerufen wird; Obsidian und eine JetBrains-IDE speichern sie so, wie sie Ihre speichern, und dieses Tool schreibt sie sofort. Im Headless-Modus ist jede Änderung bereits geschrieben, und dieses Tool bewirkt nichts.
erd_undo		Macht die letzte Änderung dieses Agenten rückgängig, nie Ihre. Aufrufe, die keinen Rückgängig-Eintrag erzeugt haben, werden übersprungen und genannt.
erd_redo		Wendet die Änderung erneut an, die erd_undo zuletzt rückgängig gemacht hat.

Was Speichern und Rückgängigmachen im jeweiligen Modus bewirken, wird in Live und Headless beschrieben.

Dokument lesen

Tool	Argumente	Was es tut
erd_list	query?, offset?, limit?, namesOnly?	Die Einstellungen und Anzahlen, dann eine Seite mit Tabellen samt ihren Indizes und Beziehungen, jede Tabelle mit ihrer ID, Position und Größe auf der Zeichenfläche, Spaltenanzahl und Tabellengruppe, falls sie in einer ist. Sofern es nicht sucht, folgen auf die Tabellen die Tabellengruppen und dann die Notizen.
erd_get	tableIds?, tableNames?, relationshipIds?, indexIds?, memoIds?, tableGroupIds?	Die genannten Entitäten vollständig: Tabellen mit ihren Spalten und ihrer Tabellengruppe, Beziehungen mit ihren Spalten sowie onDelete und onUpdate, Indizes mit ihren Spalten, Notizen mit ihrem Text, Tabellengruppen mit ihren Tabellen.
erd_read	format, vendor?, statements?, header?, tableIds?, tableNames?, groupNames?	Das ganze Dokument auf einmal in einem von vier Formaten oder die DDL nur einiger Tabellen oder Tabellengruppen.

Ein Agent findet IDs mit erd_list, liest Spalten und weitere Details mit erd_get und übergibt diese IDs an die Bearbeitungs-Tools. Die Größe einer Tabelle in erd_list ist der Rahmen, den sie auf der Zeichenfläche einnimmt: die Höhe exakt, die Breite ungefähr. Eine Tabellengruppe wird mit dem Rechteck aufgeführt, das sie speichert, sowie mit ihrem Namen, ihrer Farbe und der Zahl der Tabellen, die sie enthält. Jede Beziehung wird einmal aufgeführt, bei einer ihrer beiden Tabellen. Die Einstellungen, die erd_list und erd_read melden, sind die, die die Datei speichert – siehe Einstellungen.

erd_read akzeptiert eines von vier Formaten:

format	Was es liefert
snapshot	Kompaktes JSON mit jeder Entität und ihrer ID, Tabellengruppen eingeschlossen, und den Einstellungen mit den Skripten von Schema SQL. Es lässt weg, was sich von Betrachter zu Betrachter unterscheidet: gemessene Breiten, die Stapelreihenfolge, die Ansicht und die Registerkarte. Bei einem großen Schema umfangreich.
sql	DDL für eine der acht Datenbanken Databricks, MariaDB, MSSQL, MySQL, Oracle, PostgreSQL, Snowflake oder SQLite. vendor ist standardmäßig die Datenbank, auf die das Dokument eingestellt ist. Die DDL des ganzen Dokuments enthält seine Skripte vor und nach den Tabellen. Mit tableIds, tableNames oder groupNames nur diese Tabellen, mit den Fremdschlüsseln, die sie enthalten, und ohne Skripte. Fremdschlüssel enthalten ihre Aktionen für ON DELETE und ON UPDATE, außer denen, die die Zieldatenbank weglässt – siehe ON DELETE und ON UPDATE.
json	Das ganze Dokument genau so, wie ein Speichern die Datei schreibt, einschließlich aller Änderungen, die der Editor noch nicht gespeichert hat – siehe Speicherform und Laufzeitwert.
scripts	Nur die Skripte vor und nach den Tabellen des Dokuments, als {"before":"…","after":"…"}, jedes leer, wenn es nicht gesetzt ist, wie groß das Schema auch sein mag.

Nur das Format sql akzeptiert vendor, statements, header, tableIds, tableNames und groupNames, und jedes andere Format lehnt sie ab.

• statements: create, der Standardwert; ifNotExists, das bei MySQL, MariaDB, PostgreSQL, SQLite und Databricks CREATE TABLE IF NOT EXISTS und bei den anderen ein einfaches CREATE TABLE schreibt; oder recreate, das die Tabellen vor dem Erstellen löscht, wobei Snowflake stattdessen CREATE OR REPLACE TABLE schreibt.
• header: none, der Standardwert; use, das die Datenbank oder das Schema auswählt, das der Datenbankname des Dokuments nennt; oder createAndUse, das diese zuerst erstellt. Oracle kennt nur use, daher schreibt createAndUse dort use, und PostgreSQL kennt nur createAndUse, daher schreibt use dort keinen Vorspann. SQLite schreibt keinen, und keine Datenbank schreibt einen, solange der Datenbankname leer oder kein einfacher Bezeichner ist.
• groupNames: die Tabellen der genannten Tabellengruppen, nach Namen ohne Beachtung der Groß-/Kleinschreibung, zusammengeführt mit tableIds und tableNames. Ein Name, der zu keiner Gruppe passt, wird mit notFound abgelehnt. Eine Gruppe ohne Tabelle fügt keine hinzu, und ein Lesevorgang, dem gar keine Tabelle bleibt, etwa wenn jede genannte Gruppe leer ist und keine Tabelle genannt wird, wird mit invalidArgs abgelehnt.

statements und header gelten auch für die DDL einzelner Tabellen. Sie funktionieren wie die Optionen Statements und Header der Registerkarte Schema SQL des Editors, allerdings steht die Registerkarte anfangs auf If not exists und CREATE + USE. Namen werden mit dem Begrenzertyp eingefasst, den die Datei speichert, also mit dem gesperrten, solange Bracket Type gesperrt ist – siehe Sperren.

Große Schemas

Auch Schemas mit Hunderten oder Tausenden von Tabellen funktionieren. Ein Lesevorgang liefert höchstens 40.000 Zeichen, unterhalb der Grenze, ab der Claude Code ein Tool-Ergebnis in eine Datei auslagert.

• erd_list liefert standardmäßig eine Seite mit 100 Einträgen, zuerst die Tabellen, dann die Tabellengruppen, dann die Notizen, und gibt mit nextOffset und einem Hinweis note an, wo die nächste Seite beginnt. Übergeben Sie diesen Wert von nextOffset als offset, mit demselben Wert für query.
• query findet Tabellen anhand von Wörtern in einem Tabellen- oder Spaltennamen oder einem Kommentar, ohne Beachtung der Groß-/Kleinschreibung. Tabellen, deren Namen mehr dieser Wörter enthalten, kommen zuerst. Eine Suche listet keine Tabellengruppen oder Notizen auf.
• namesOnly listet nur die Tabellennamen auf, etwa 2.000 kurze Namen in einer Antwort.
• erd_get und erd_read akzeptieren neben IDs auch tableNames, und erd_read akzeptiert groupNames, sodass ein Agent, der um eine SQL-Abfrage auf einem großen Schema gebeten wird, nur die DDL der Tabellen liest, die er braucht.
• erd_get führt IDs und Namen, die nichts bezeichnen, unter missing auf und die IDs, für die in einer Antwort kein Platz ist, unter notReturned, damit sie erneut angefragt werden können.
• Ein Lesevorgang, der für eine Antwort zu groß ist, wird mit tooLarge abgelehnt, zusammen mit einem Hinweis, wie er sich eingrenzen lässt.

Bearbeitungs-Tools

IDs stammen aus erd_list und erd_get oder aus den createdIds des Aufrufs, der die Entität erstellt hat. Eine neue ID besteht aus 25 Kleinbuchstaben und Ziffern, etwa 03h17be2plxpj5n59tqag7ogj, während eine ID, die das Dokument bereits enthält, ihre Form behält, leiten Sie daher aus der Form einer ID nichts ab. x und y sind die linke und die obere Kante auf der Zeichenfläche in Pixeln, und eine Farbe ist eine CSS-Hexfarbe, etwa #3b82f6, oder eine leere Zeichenkette, die die Farbe entfernt.

Tabellen

Tool	Argumente	Was es tut
erd_add_table		Fügt an einer freien Stelle eine leere Tabelle hinzu und gibt ihre ID in createdIds zurück.
erd_remove_table	tableId	Entfernt eine Tabelle samt ihren Spalten, Indizes und jeder Beziehung, die sie berührt.
erd_change_table_name	tableId, value	Benennt eine Tabelle um.
erd_change_table_comment	tableId, value	Legt den Kommentar einer Tabelle fest. Eine leere Zeichenkette löscht ihn.
erd_change_table_color	tableId, color	Legt die Farbe einer Tabelle fest.
erd_move_table	tableId, x, y	Verschiebt eine Tabelle an eine Position auf der Zeichenfläche.
erd_move_tables	positions	Verschiebt mehrere Tabellen in einer Änderung, die ein einziges erd_undo rückgängig macht. positions enthält { tableId, x, y } pro Tabelle, jede Tabelle höchstens einmal.
erd_sort_tables		Ordnet alle Tabellen in Zeilen über die Zeichenfläche an, die mit den wenigsten Spalten zuerst, so wie erd_import_sql, erd_import_graphql, erd_import_dbml und erd_import_aml sie anordnen. Die Tabellen einer Tabellengruppe bleiben zusammen, und der Rahmen jeder Gruppe wird um sie herum angepasst.

Spalten

Tool	Argumente	Was es tut
erd_add_column	tableId	Fügt einer Tabelle eine leere Spalte hinzu und gibt ihre ID in createdIds zurück.
erd_remove_columns	tableId, columnIds	Entfernt Spalten aus einer Tabelle, samt den Beziehungen und Indexeinträgen, die sie verwenden.
erd_change_column_name	tableId, columnId, value	Benennt eine Spalte um.
erd_change_column_data_type	tableId, columnId, value	Legt den Datentyp fest, etwa INT oder VARCHAR(255). Solange Datentyp-Synchronisierung für Beziehungen eingeschaltet ist, folgt die Änderung den Beziehungen in beide Richtungen, wie im Editor: Ein Serial-Typ erreicht die Fremdschlüssel als der Ganzzahltyp, den er speichert, so wie erd_add_relationship ihn kopiert, und ein Serial-Schlüssel behält seinen Typ, wenn sich einer seiner Fremdschlüssel ändert, womit die Änderung dort endet. Die Synchronisierung ein- oder auszuschalten ist Sache des Benutzers, und erd_list meldet sie als relationshipDataTypeSync.
erd_change_column_default	tableId, columnId, value	Legt den Standardwert als SQL-Text fest. Eine leere Zeichenkette löscht ihn.
erd_change_column_comment	tableId, columnId, value	Legt den Kommentar fest. Eine leere Zeichenkette löscht ihn.
erd_set_column_primary_key	tableId, columnId, value	true macht die Spalte zum Teil des Primärschlüssels, false nimmt sie heraus.
erd_set_column_unique	tableId, columnId, value	Legt fest, ob die Spalte eindeutig ist.
erd_set_column_not_null	tableId, columnId, value	Legt fest, ob die Spalte NOT NULL ist.
erd_set_column_auto_increment	tableId, columnId, value	Legt fest, ob die Spalte automatisch inkrementiert wird.
erd_move_column	tableId, columnId, targetColumnId	Verschiebt eine Spalte innerhalb ihrer Tabelle an die Position einer anderen Spalte.

Beziehungen

relationshipType ist die Kardinalität am Ende an der Kindtabelle: ZeroOne, ZeroN, OneOnly oder OneN. Die Starttabelle ist die Elterntabelle, die referenzierte Seite, die den Primärschlüssel enthält, und die Endtabelle ist die Kindtabelle. onDelete und onUpdate sind die Aktionen des Fremdschlüssels für ON DELETE und ON UPDATE: none, noAction, cascade, setNull, setDefault oder restrict. none schreibt keine Klausel, sodass das Standardverhalten der Datenbank gilt – siehe ON DELETE und ON UPDATE. Eine bei erd_add_relationship oder erd_link_columns weggelassene Aktion ist none.

Tool	Argumente	Was es tut
erd_add_relationship	startTableId, endTableId, relationshipType, onDelete?, onUpdate?	Setzt zwei Tabellen in Beziehung. Es kopiert den Primärschlüssel der Elterntabelle als Fremdschlüsselspalten in die Kindtabelle und erstellt zuerst eine Primärschlüsselspalte, wenn die Elterntabelle keine hat. Jede Fremdschlüsselspalte wird so benannt, wie das Zeichnen einer Beziehung im Editor sie benennt: Der Schlüssel id von users ergibt users_id, und ein Schlüssel wie member_id behält seinen Namen – siehe Namen der Fremdschlüsselspalten. Jede übernimmt den Datentyp ihres Schlüssels, außer dass ein Serial-Schlüssel den Ganzzahltyp ergibt, den er speichert, etwa integer für serial4, und ein bloßes serial außerhalb von PostgreSQL, MySQL und MariaDB serial bleibt – siehe Identifizierende Beziehungen. createdIds enthält die neue Schlüsselspalte, falls eine erstellt wurde, die Fremdschlüsselspalten und zuletzt die ID der Beziehung.
erd_link_columns	startTableId, startColumnIds, endTableId, endColumnIds, relationshipType, onDelete?, onUpdate?	Zeichnet eine Beziehung zwischen bereits vorhandenen Spalten und paart Start- und Endspalten nach ihrer Position. Es benennt keine Spalte um und ändert keinen Datentyp.
erd_remove_relationship	relationshipId	Entfernt eine Verbindungslinie. Ihre Fremdschlüsselspalten bleiben in der Tabelle.
erd_change_relationship_type	relationshipId, relationshipType	Ändert die Kardinalität einer Beziehung.
erd_change_relationship_on_delete	relationshipId, onDelete	Legt die Aktion für ON DELETE einer Beziehung fest: was das Löschen einer Elternzeile mit ihren Kindzeilen macht.
erd_change_relationship_on_update	relationshipId, onUpdate	Legt die Aktion für ON UPDATE einer Beziehung fest: was das Ändern eines Elternschlüssels mit dessen Kindzeilen macht.

Da erd_add_relationship die Fremdschlüsselspalten beim Ausführen benennt, benennen Sie zuerst die Elterntabelle und ihren Primärschlüssel.

Kein Tool ändert die Spalten einer bestehenden Beziehung so, wie es der Dialog Spalten zuordnen des Editors tut. Um eine Beziehung anderen Spalten zuzuordnen, führen Sie erd_remove_relationship, das ihre Fremdschlüsselspalten in der Tabelle lässt, und erd_link_columns mit den gewünschten Spalten in einem erd_batch aus, das ein einziges erd_undo rückgängig macht.

Indizes

Die ID einer Indexspalte ist ein Eintrag der Spaltenliste des Index, die erd_get liefert, nicht die ID der Tabellenspalte.

Tool	Argumente	Was es tut
erd_add_index	tableId	Fügt einer Tabelle einen leeren Index hinzu und gibt seine ID in createdIds zurück.
erd_remove_index	indexId	Entfernt einen Index.
erd_change_index_name	indexId, value	Benennt einen Index um.
erd_set_index_unique	indexId, value	Legt fest, ob der Index eindeutig ist.
erd_add_index_column	indexId, columnId	Fügt dem Index eine Spalte seiner Tabelle hinzu und gibt die ID der neuen Indexspalte zurück. Eine Spalte, die bereits im Index ist, bleibt unverändert.
erd_remove_index_column	indexId, indexColumnId	Entfernt eine Spalte aus einem Index.
erd_move_index_column	indexId, indexColumnId, targetIndexColumnId	Verschiebt eine Spalte innerhalb eines Index an die Position einer anderen seiner Spalten.
erd_set_index_column_order	indexId, indexColumnId, orderType	Legt die Sortierreihenfolge einer Spalte in einem Index fest, ASC oder DESC.

Notizen

Tool	Argumente	Was es tut
erd_add_memo		Fügt an einer freien Stelle eine leere Notiz hinzu und gibt ihre ID in createdIds zurück.
erd_remove_memo	memoId	Entfernt eine Notiz.
erd_change_memo_value	memoId, value	Ersetzt den Text einer Notiz.
erd_change_memo_color	memoId, color	Legt die Farbe einer Notiz fest.
erd_move_memo	memoId, x, y	Verschiebt eine Notiz an eine Position auf der Zeichenfläche.
erd_resize_memo	memoId, width, height	Ändert die Größe einer Notiz. Die Breite muss mindestens etwa 116 Pixel und die Höhe mindestens 100 betragen. Es erzeugt keinen Rückgängig-Eintrag, da der Editor eine Größenänderung einer Notiz nur beim Ziehen aufzeichnet.

Solange Notizen über View Option → Memos ausgeblendet sind, fügt erd_add_memo trotzdem eine hinzu, und sie bleibt ausgeblendet, bis Notizen wieder eingeblendet werden. erd_list und erd_get listen auch ausgeblendete Notizen auf.

Tabellengruppen

Eine Tabellengruppe ist ein benannter Rahmen, der hinter ihren Tabellen gezeichnet wird, und ihre Farbe erscheint auf dem Rahmen und quer über die Tabellenköpfe ihrer Tabellen – siehe Tabellengruppen. Eine Tabelle gehört höchstens zu einer Gruppe. erd_move_table, erd_move_tables und erd_move_table_group ändern nie, welche Tabellen eine Gruppe enthält, wohin sie eine Tabelle auch setzen, während im Editor eine Tabelle dort, wo sie abgelegt wird, einer Gruppe beitritt oder sie verlässt – siehe Tabellen hinzufügen und entfernen. erd_add_table_group und erd_set_table_group fügen Tabellen einer Gruppe hinzu, und erd_remove_table_group lässt ihre Tabellen ohne Gruppe zurück. Eine Gruppe speichert ein Rechteck, mindestens 160 Pixel breit und 100 hoch, die Titelleiste eingeschlossen, und der Editor zeichnet den Rahmen so vergrößert, dass er jede ihrer Tabellen aufnimmt.

Tool	Argumente	Was es tut
erd_add_table_group	name, color?, x?, y?, width?, height?, tableIds?	Fügt eine Gruppe hinzu und gibt ihre ID in createdIds zurück. Übergeben Sie entweder tableIds oder ein Rechteck, also x, y, width und height zusammen. Mit tableIds verlässt jede Tabelle eine etwaige bisherige Gruppe, und das Rechteck wird so um sie herum angepasst, wie es beim Gruppieren ausgewählter Tabellen geschieht. Ein Rechteck nimmt jede Tabelle ohne Gruppe auf, deren Mittelpunkt darin liegt, wie beim Zeichnen einer Gruppe. Ein leerer Wert von name lässt die Gruppe unbenannt. Ein einziges erd_undo entfernt die Gruppe und setzt jede Tabelle in die Gruppe zurück, in der sie war.
erd_remove_table_group	groupId	Entfernt eine Gruppe. Ihre Tabellen bleiben, wo sie sind, ohne Gruppe.
erd_change_table_group_name	groupId, value	Benennt eine Gruppe um. Eine leere Zeichenkette lässt sie unbenannt.
erd_change_table_group_color	groupId, color	Legt die Farbe einer Gruppe fest.
erd_move_table_group	groupId, x, y	Verschiebt eine Gruppe so, dass ihr Rechteck an diesem Punkt beginnt, und ihre Tabellen um denselben Versatz mit, wie beim Ziehen ihrer Titelleiste. Eine Verschiebung um weniger als 20 Pixel, waagerecht und senkrecht zusammengerechnet, erzeugt keinen Rückgängig-Eintrag.
erd_resize_table_group	groupId, x?, y?, width, height	Legt das Rechteck einer Gruppe fest, wobei ihre Tabellen bleiben, wo sie sind. Ohne x und y bleibt ihre Ecke erhalten. Ein Rechteck, das die Tabellen der Gruppe samt ihrem Innenabstand nicht aufnehmen würde, wird abgelehnt, mit einer Meldung, die den Rahmen nennt, den es aufnehmen muss.
erd_set_table_group	tableIds, groupId	Fügt Tabellen einer Gruppe hinzu, wobei jede eine etwaige bisherige Gruppe verlässt. Der Wert null oder eine leere Zeichenkette für groupId nimmt sie aus jeder Gruppe heraus.

Solange Gruppen über View Option → Table Groups ausgeblendet sind, fügen diese Tools trotzdem Gruppen hinzu und ändern sie, und diese bleiben ausgeblendet, bis Gruppen eingeblendet werden – siehe Gruppen ausblenden. erd_sort_tables hält die Tabellen jeder Gruppe zusammen, erd_import_dbml und erd_import_json bringen Gruppen mit – siehe Import – und erd_read schreibt mit groupNames die DDL ausgewählter Gruppen. Eine Version von ERD Editor, die noch keine Tabellengruppen kennt, verwirft beim Speichern einer Datei deren Gruppen, wie es die Erweiterung für VS Code vor 4.0.0 und die Plugins für Obsidian und JetBrains vor 1.0.0 tun – siehe Aktualisieren.

Einstellungen

Ein Agent legt die Einstellungen des Schemas selbst fest: die Datenbank, ihren Namen und die Skripte von Schema SQL. Jede andere Einstellung, die das Dokument speichert, legt der Benutzer im Editor fest: die Schalter der Ansichtsoptionen, die Optionen der Registerkarte Einstellungen, Sprache und Schreibweisen des Codegenerators, den Begrenzertyp und die Sperren. Kein Tool ändert sie, mit Ausnahme der Importe im Modus replace: erd_import_json übernimmt die Einstellungen und Sperren des Dokuments, das es lädt, und die anderen vier setzen die Ansicht an den Anfang der Zeichenfläche zurück – siehe Import. Der Server 1.0.0 hat die Tools entfernt, die sie festlegten: erd_set_language, erd_set_table_name_case, erd_set_column_name_case, erd_set_bracket_type, erd_set_relationship_data_type_sync, erd_set_relationship_optimization, erd_set_column_order, erd_set_max_width_comment, erd_set_ignore_save_settings und erd_set_show.

erd_list und das Format snapshot von erd_read melden die Einstellungen so, wie die Datei sie speichert, wobei lockSettings ein Kennzeichen pro Sperre enthält: viewport, canvasType, language, tableNameCase, columnNameCase und bracketType. Eine gesperrte Sprache, Schreibweise oder ein gesperrter Begrenzertyp wird mit dem gesperrten Wert gemeldet, dem Wert, den die Datei behält und mit dem jeder Editor öffnet, unabhängig davon, was der Bildschirm eines Editors zeigt. Die Ansicht und die Registerkarte werden nicht gemeldet.

erd_set_ddl_script erzeugt einen Rückgängig-Eintrag. erd_set_database und erd_set_database_name erzeugen keinen, daher kann erd_undo sie nicht rückgängig machen.

Tool	Argumente	Was es tut
erd_set_database	value	Legt die Datenbank fest: MariaDB, MSSQL, MySQL, Oracle, PostgreSQL, SQLite, Databricks oder Snowflake. Damit werden die Datentypen der Datenbank gewählt sowie die DDL, die erd_read schreibt, wenn kein Wert für vendor angegeben ist.
erd_set_database_name	value	Legt den Datenbanknamen fest, den die Vorspanne use und createAndUse von erd_read nennen.
erd_set_ddl_script	position, sql	Legt eines der beiden Skripte fest, die um die Tabellen herum geschrieben werden – siehe Skripte vor und nach den Tabellen. position ist before für ein Skript vor den Tabellen, etwa CREATE EXTENSION oder CREATE SCHEMA, oder after für eines nach ihnen, etwa GRANT oder CREATE VIEW. sql ersetzt das ganze Skript, höchstens 10.000 Zeichen, und eine leere Zeichenkette entfernt es. Lesen Sie das aktuelle Skript zuerst mit dem Format scripts von erd_read.

Ein Skript geht unverändert in die DDL jeder Datenbank ein, schreiben Sie es daher für die Datenbank des Dokuments. Bei MSSQL wird nach einem Skript, dessen letzte Zeile nicht GO ist, eine Zeile GO angefügt. Eine Version von ERD Editor, die diese Skripte noch nicht kennt, verwirft beim Speichern einer Datei deren Skripte, wie es die Erweiterung für VS Code vor 4.0.0 und die Plugins für Obsidian und JetBrains vor 1.0.0 tun – siehe Aktualisieren.

Import

Diese Tools lesen ein Schema so ein, wie es das Import-Menü des Editors tut – siehe Dateien importieren oder exportieren. Jedes erhält den Text als value sowie mode: replace, der Standardwert, oder append.

Tool	Argumente	Was es tut
erd_import_sql	value, mode?	Lädt SQL-DDL, Anweisungen wie CREATE TABLE und Ähnliches.
erd_import_graphql	value, mode?	Lädt eine GraphQL-SDL.
erd_import_dbml	value, mode?	Lädt DBML. Jede TableGroup wird zu einer Tabellengruppe aus den Tabellen, die sie nennt – siehe DBML.
erd_import_aml	value, mode?	Lädt AML.
erd_import_json	value, mode?	Lädt ein JSON-Dokument von erd-editor, etwa eine andere Datei .erd.json.

replace ersetzt das Dokument, und erd_undo stellt das vorherige wieder her:

• erd_import_sql, erd_import_graphql, erd_import_dbml und erd_import_aml ersetzen alle Tabellen, Beziehungen, Indizes, Notizen und Tabellengruppen. Sie behalten die Einstellungen des Dokuments bei, seine Sperren eingeschlossen, abgesehen von der Ansicht, die bei 100 % an den Anfang der Zeichenfläche zurückkehrt.
• erd_import_json ersetzt das ganze Dokument, seine Einstellungen eingeschlossen: Die Einstellungen und Sperren des JSON treten an die Stelle derer dieses Dokuments, und ein JSON, das keine Sperren enthält, schaltet jede Sperre ein und setzt die Ansicht an den Anfang der Zeichenfläche. Um die Einstellungen dieses Dokuments zu behalten, gehen Sie von dem Text aus, den das Format json von erd_read liefert. Ein leerer Text ergibt ein neues Dokument wie jenes, das erd_open_document mit create erstellt.

append fügt den Import dem Dokument hinzu, wie Importieren und hinzufügen im Editor, und ein einziges erd_undo nimmt die ganze Ergänzung zurück:

• Was der Text enthält, kommt als neue Entitäten mit neuen IDs hinzu, in einem Block unterhalb von allem, was das Dokument enthält, ausgeblendete Notizen und Tabellengruppen eingeschlossen, an dessen linker Kante ausgerichtet. Jede bereits vorhandene Tabelle und Einstellung bleibt, auch eine Tabelle mit demselben Namen: Nichts wird nach Namen zusammengeführt.
• Beziehungen und Indizes kommen nur zwischen den Tabellen hinzu, die der Import mitbringt, daher wird ein Fremdschlüssel auf eine Tabelle, die der Text nicht deklariert, verworfen.
• erd_import_sql, erd_import_graphql und erd_import_aml fügen Tabellen mit ihren Beziehungen und Indizes hinzu, und erd_import_dbml auch seine Tabellengruppen. erd_import_json fügt Tabellen, Beziehungen, Indizes, Notizen und Tabellengruppen hinzu, nie seine Einstellungen, und lehnt einen leeren Text ab.

Ein JSON-Dokument behält seine eigene Anordnung, seine Tabellengruppen eingeschlossen: mit replace dort, wo es seine Tabellen platziert, und mit append innerhalb des hinzugefügten Blocks. Die Tabellen aus SQL, GraphQL, DBML und AML werden in Zeilen angeordnet, die mit den wenigsten Spalten zuerst und die Tabellen jeder Gruppe zusammen, so wie erd_sort_tables sie platziert, nie per Flow, wie sie der Import des Editors selbst nach Möglichkeit anordnet. Diese vier Tools lehnen in beiden Modi einen leeren Text ab.

erd_batch

erd_batch führt mehrere Bearbeitungs-Tools der Reihe nach als eine Änderung aus, alle oder keines.

• operations enthält bis zu 100 Einträge, jeder { tool, as?, args? }, wobei args die Argumente des Tools ohne path sind.
• Die Operationen werden zuerst an einer Kopie des Dokuments erprobt. Eine abgelehnte wird genannt, etwa operations[1] erd_remove_table: …, und nichts wird angewendet.
• Ein einziges erd_undo macht den ganzen Stapel rückgängig, abgesehen von den Operationen, die es nicht rückgängig machen kann und die undoNote im Ergebnis nennt: die eines Tools, das keinen Rückgängig-Eintrag erzeugt, etwa erd_set_database, und die, die das Dokument geändert haben, ohne einen zu erzeugen, etwa ein kurzes erd_move_table_group. Einen Stapel, der überhaupt keinen Rückgängig-Eintrag erzeugt hat, überspringt erd_undo. historyEntries im Ergebnis zählt die Verlaufseinträge des Editors darin, nicht Aufrufe von erd_undo.
• In einer Live-Sitzung übernimmt der Editor den ganzen Stapel oder nichts davon.

Ein Agent kann die IDs, die ein Stapel erstellt, vor dem Aufruf nicht kennen, daher lässt eine mit as benannte Operation eine spätere darauf verweisen: $name oder $name.0 für ihre erste erstellte ID, $name.1 für ihre zweite und $name.last für ihre letzte. Ein Name besteht aus ASCII-Buchstaben, Ziffern und Unterstrichen, beginnt nicht mit einer Ziffer und benennt nur eine einzige Operation. Ein Verweis wird nur dort aufgelöst, wo ein Argument eine Entitäts-ID erwartet, daher bleibt ein Name oder Kommentar, der $x lautet, Text.

Eine Tabelle mit ihren Spalten und einer Beziehung in einem Aufruf:

{
  "path": "shop.erd.json",
  "operations": [
    { "tool": "erd_add_table", "as": "users" },
    { "tool": "erd_change_table_name", "args": { "tableId": "$users", "value": "users" } },
    { "tool": "erd_add_column", "as": "uid", "args": { "tableId": "$users" } },
    { "tool": "erd_change_column_name", "args": { "tableId": "$users", "columnId": "$uid", "value": "id" } },
    { "tool": "erd_change_column_data_type", "args": { "tableId": "$users", "columnId": "$uid", "value": "BIGINT" } },
    { "tool": "erd_set_column_primary_key", "args": { "tableId": "$users", "columnId": "$uid", "value": true } },
    { "tool": "erd_add_table", "as": "orders" },
    { "tool": "erd_change_table_name", "args": { "tableId": "$orders", "value": "orders" } },
    { "tool": "erd_add_relationship", "args": { "startTableId": "$users", "endTableId": "$orders", "relationshipType": "ZeroN", "onDelete": "cascade" } }
  ]
}

Die Tabelle users und ihr Schlüssel id werden vor der Beziehung benannt, daher heißt die Fremdschlüsselspalte, die die Beziehung orders hinzufügt, users_id.

Ergebnisse

Eine Änderung liefert als Antwort eine Zeile JSON:

{"tool":"erd_add_table","mode":"live","createdIds":["03h17be2plxpj5n59tqag7ogj"],"batches":1,"historyEntries":1}

Feld	Bedeutung
mode	live oder headless – siehe Live und Headless.
createdIds	Die IDs dessen, was der Aufruf erstellt hat, der Reihe nach.
batches, historyEntries	Wie viele Änderungsstapel der Aufruf gesendet und wie viele Verlaufseinträge im Editor er erzeugt hat.
undoable, undoNote	undoable ist false, wenn erd_undo den Aufruf überspringen wird, und undoNote sagt, warum: Das Tool erzeugt keinen Rückgängig-Eintrag, der Aufruf hat das Dokument geändert, ohne einen zu erzeugen, wie es ein erd_move_table_group um weniger als 20 Pixel tut, oder das Dokument hatte den Wert bereits. Ein Ergebnis von erd_batch enthält immer einen Hinweis undoNote. Hat der Stapel einen Rückgängig-Eintrag erzeugt, besagt der Hinweis, dass ein einziges erd_undo den Stapel rückgängig macht, und nennt jede Operation, die es bestehen lässt; hat er keinen erzeugt, enthält das Ergebnis undoable: false, und der Hinweis besagt, dass erd_undo den Stapel überspringt.
mismatch	Vorhanden, wenn der Aufruf eine andere Anzahl von Stapeln oder Verlaufseinträgen erzeugt hat, als das Tool angibt.
notes	Vorhanden, wenn sich an der Sitzung etwas geändert hat, etwa ein Editor, der beendet wurde oder das Dokument nicht mehr bedient, oder eine Datei, die sich auf dem Datenträger geändert hat.

Eine Ablehnung ist ein Fehlerergebnis mit einem Code und einer Meldung, die sagt, was zu tun ist:

{"error":{"code":"notFound","message":"tableId nope names no live table; read the document for current ids"}}

code	Grund
notFound	Eine ID bezeichnet nichts Vorhandenes, oder die Datei existiert nicht.
invalidArgs	Ein Argument fehlt oder hat den falschen Wert.
invalidPath	Der Pfad ist kein ERD-Dokument. Unter Windows auch ein Pfad mit einem Namen, den Windows nicht so speichert, wie er geschrieben ist, oder einer, der ein Dokument erreicht, das ein Editor unter einem anderen Pfad hält, den die Meldung nennt.
invalidDocument	Die Datei ist kein Dokument, das der Editor lesen kann.
tooLarge	Ein Lesevorgang passt nicht in eine Antwort.
blocked	Ein Editor mit ausgeschaltetem Hub hält das Dokument. Die Meldung sagt, wie der Hub eingeschaltet wird: Vertrauen Sie in VS Code dem Arbeitsbereich und schalten Sie dineug.erd-editor.agentHub.enabled ein, oder laden Sie das Fenster neu; schalten Sie in Obsidian Coding agents ein, oder laden Sie Obsidian neu; schalten Sie in einer JetBrains-IDE Coding agents ein, oder starten Sie die IDE neu, wenn Coding agents eingeschaltet ist.
hubDisabled	Eine JetBrains-IDE hält das Dokument nur in einem Projekt, dem sie nicht vertraut. Lesevorgänge funktionieren weiterhin; vertrauen Sie dem Projekt, damit der Agent Änderungen vornehmen kann.
conflict	Die Datei hat sich während des Aufrufs auf dem Datenträger geändert. Es wurde nichts geschrieben.
hubAppeared, hubGone	Ein Editor hat begonnen, ein Dokument zu bedienen, das der Agent auf dem Datenträger bearbeitete, oder der Editor, der es bediente, läuft noch, aber seine Sperrdatei und Verbindung sind verschwunden. Es wurde nichts geschrieben.
notSaved	erd_save konnte das Dokument des Editors nicht speichern.
readonly	Der Editor hält das Dokument schreibgeschützt, etwa eine Datei, die er nicht schreiben oder nicht als Diagramm lesen kann. Ohne Editor ist die Datei selbst schreibgeschützt, etwa eine nicht ausgecheckte Datei in Perforce oder TFVC. Es wurde nichts geschrieben.
protocolMismatch	Die Erweiterung oder das Plugin ERD Editor des Editors und der Server sprechen unterschiedliche Protokollversionen, etwa Server 1.0.0 mit einer Erweiterung für VS Code in Version 3.x. Auch Lesevorgänge werden abgelehnt, und die Meldung nennt die Seite, die aktualisiert werden muss – siehe Aktualisieren.
hubUnreachable, timeout, disconnected	Der Hub eines Editors hat die Verbindung nicht angenommen, nicht innerhalb von 30 Sekunden geantwortet oder sie während des Aufrufs getrennt. Unter Windows bedeutet hubUnreachable auch, dass Windows den Agenten vom Hub ferngehalten hat: Der Editor läuft mit mehr Rechten als der Agent, etwa wenn er als Administrator gestartet wurde und der Agent nicht, oder der Agent läuft in einer Sandbox.

Andere Codes sind seltener, und jede Ablehnung enthält eine Meldung, die sagt, was passiert ist.

Die Bearbeitungs-Tools, erd_batch und die drei Lese-Tools lehnen ein Argument, das sie nicht deklarieren, oder eines mit falschem Typ mit einem JSON-RPC-Fehler für ungültige Parameter (-32602) ab, bevor sie das Dokument berühren, sodass ein falsch geschriebenes Argument nie stillschweigend verworfen wird. Die fünf Sitzungs-Tools ignorieren Argumente, die sie nicht kennen.