SQL DDL in JSON Schema umwandeln: Typ-Mapping und Regeln

Inhalt
Die CREATE TABLE-Anweisung einer relationalen Datenbank (RDB) und das JSON Schema (JSON Schema Draft-07), das in APIs und dokumentenorientierten Datenbanken verbreitet ist, beschreiben Daten auf unterschiedliche Weise. Wer jede Spalte von Hand abgleicht und überträgt, übersieht deshalb leicht einen Datentyp oder eine Pflichtangabe. Fassen Sie die Umsetzung als Regeln zusammen, also welcher SQL-Typ in welchen JSON-Typ übergeht und wie NOT NULL und UNIQUE jeweils behandelt werden, lassen sich solche Fehler verringern.
Zusammenfassung ① SQL-Datentypen fallen in wenige Gruppen, etwa Ganzzahl, Fließkommazahl, Boolean, Datum und JSON, und werden auf JSON-Schema-Typen abgebildet. ② Nur Spalten mit
NOT NULLundPRIMARY KEYlanden automatisch im Arrayrequired,UNIQUEdagegen nicht. ③ Die Länge vonVARCHAR(maxLength) und die Werteliste vonENUMwerden nicht automatisch übernommen und müssen manuell ergänzt werden.
1. So werden SQL-Datentypen auf JSON-Schema-Typen abgebildet
Die in SQL-DDL verwendeten Datentypen werden nach folgendem Schema in die Eigenschaft type von JSON Schema Draft-07 umgesetzt.
- Ganzzahl:
INT,INTEGER,TINYINT,SMALLINT,MEDIUMINT,BIGINT,SERIAL,BIGSERIAL→{ "type": "integer" } - Fließkommazahl:
DECIMAL,NUMERIC,FLOAT,DOUBLE,REAL→{ "type": "number" } - Boolean:
BOOLEAN,BOOL→{ "type": "boolean" } - Datum:
DATE→{ "type": "string", "format": "date" }/TIMESTAMP,DATETIME→{ "type": "string", "format": "date-time" } - JSON-Typen:
JSON,JSONB→{ "type": "object" } - Übrige Zeichenkettentypen:
VARCHAR,CHAR,TEXTund ähnliche werden durchweg zu{ "type": "string" }. Auch bei einer Längenangabe wieVARCHAR(50)wirdmaxLengthnicht automatisch hinzugefügt.
Ob ein Feld Pflicht ist, wird unabhängig vom Typ entschieden. Nur Spalten mit NOT NULL und Spalten, die als PRIMARY KEY festgelegt sind, werden automatisch in das required-Array auf oberster Ebene eingetragen. Eine UNIQUE-Einschränkung verhindert lediglich doppelte Werte, erzwingt aber nicht, dass ein Wert vorhanden ist. Deshalb gelangt sie nicht automatisch in das required-Array. Wenn Sie die Option „Typ optionaler Spalten als Union mit null festlegen“ aktivieren, wird der Typ von Spalten, die nicht in required stehen, zu einer Union mit null, etwa ["string", "null"].
2. So wird eine DDL-Anweisung tatsächlich interpretiert
Wenn Sie eine SQL-CREATE TABLE-Anweisung in der folgenden Reihenfolge lesen, kommen Sie auch von Hand zum selben Ergebnis.
- Kommentare entfernen: Entfernen Sie zuerst Blockkommentare (
/* ... */) und Zeilenkommentare (--). - Tabellenname und Rumpf trennen: Aus der Form
CREATE TABLE [IF NOT EXISTS] Tabellenname ( ... )trennen Sie den Tabellennamen vom Inhalt in den Klammern. - Spaltenzeilen aufteilen: Teilen Sie den Inhalt der Klammern an den Kommas auf. Kommas innerhalb von Klammern, etwa bei
DECIMAL(10,2), ignorieren Sie dabei (dazu zählen Sie die Verschachtelungstiefe der öffnenden und schließenden Klammern). - Zeilenart bestimmen: Beginnt eine Zeile mit
PRIMARY KEY,CONSTRAINT,FOREIGN KEY,UNIQUE,CHECKoderINDEX, gilt sie nicht als Spalte, sondern als Tabellen-Constraint. Davon wird nur die FormPRIMARY KEY(Spalte1, Spalte2)imrequired-Array berücksichtigt. Die übrigen Constraints fließen nicht in das Schema ein. - Spaltenzeilen parsen: Bei den übrigen Zeilen gilt das erste durch Leerzeichen getrennte Wort als Spaltenname und das zweite als Datentyp. Anschließend wird in der ganzen Zeile nach
NOT NULL,DEFAULT WertundCOMMENT 'Beschreibung'gesucht. Daraus ergeben sich der Eintrag als Pflichtfeld, das Felddefaultund das Felddescription.
Mit unserem Tool prüfen. Statt diese Regeln für jede Spalte von Hand zu wiederholen, können Sie Ihr SQL-DDL einfügen. Das Tool „SQL-DDL zu JSON Schema“ erzeugt daraus nach denselben Regeln sofort ein JSON Schema.
Fügen Sie Ihre CREATE-TABLE-Anweisung aus einer relationalen Datenbank ein und erzeugen Sie automatisch ein JSON Schema nach aktuellem Standard zur Validierung.

3. Typische Stolperstellen
| Situation | Tatsächliches Verhalten |
|---|---|
Längenangabe wie bei VARCHAR(50) | Der Typ wird zu string, maxLength wird aber nicht automatisch ergänzt. |
UNIQUE-Constraint | Anders als PRIMARY KEY landet er nicht automatisch im required-Array. |
ENUM('a','b') | Die Liste wird nicht ausgelesen und es entsteht kein enum-Array, der Typ wird nur zu string. |
COMMENT 'Beschreibung' | Wird automatisch in das Feld description übernommen. |
DEFAULT Wert | Wird in das Feld default übernommen, außer bei NULL und Werten wie CURRENT_TIMESTAMP. |
Fazit
- Ganzzahl-, Fließkomma-, Boolean- und JSON-Typen lassen sich allein anhand des Typnamens direkt abbilden.
- Bei Datumstypen erhalten
DATEundTIMESTAMP/DATETIMEunterschiedlicheformat-Werte. - Das
required-Array wird nur mitNOT NULL- undPRIMARY KEY-Spalten gefüllt,UNIQUEist nicht enthalten. - Die Länge von
VARCHAR(maxLength) und die Werteliste vonENUMwerden nicht automatisch umgesetzt. Ergänzen Sie sie bei Bedarf nach der Umwandlung von Hand.
Fügen Sie Ihre CREATE-TABLE-Anweisung aus einer relationalen Datenbank ein und erzeugen Sie automatisch ein JSON Schema nach aktuellem Standard zur Validierung.
Häufig gestellte Fragen
Wird die Länge von VARCHAR automatisch zu maxLength im JSON Schema?
Nein. Der Konverter bildet derzeit nur den Typ ab und setzt keine Längenbeschränkung. Falls nötig, fügen Sie im umgewandelten JSON beim jeweiligen Feld selbst etwas wie "maxLength": 50 hinzu.
Landen Spalten mit UNIQUE-Constraint automatisch im required-Array?
Nein. Im required-Array stehen nur NOT NULL-Spalten und PRIMARY KEY-Spalten. UNIQUE verhindert doppelte Werte, erzwingt aber nicht, dass ein Wert vorhanden ist, und wird deshalb nicht gesondert behandelt. Soll eine solche Spalte Pflicht sein, müssen Sie sie nach der Umwandlung selbst in das required-Array eintragen.
Wie wird der Typ ENUM behandelt?
Die aktuelle Version liest die ENUM-Liste nicht aus und erzeugt kein enum-Array, sondern wandelt den Typ nur in eine Zeichenkette (string) um. Um die zulässigen Werte einzuschränken, fügen Sie im umgewandelten JSON selbst etwas wie "enum": ["active", "inactive"] hinzu.
Dieser Artikel basiert auf unserem koreanischen Original. Koreanisches Original lesen