Konvertieren Sie JSON in ein Sequelize-Schema (TypeScript)!

Geben Sie JSON ein und konvertieren Sie es in ein Sequelize-Schema (TypeScript)! Unterstützt sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Ergebnis
 

Konvertieren Sie JSON in ein Sequelize-Schema (TypeScript)!

Wandelt JSON in ein decorator-basiertes Modell für die Bibliothek sequelize-typescript um: eine Klasse, die von Model erbt, mit @Table und @Column({ type: DataType.*, allowNull }), TypeScript-Property-Typen und class-validator-Decorators zur Validierung.

Ziel ist sequelize-typescript (die Bibliothek hinter @nestjs/sequelize von NestJS) statt des reinen sequelize, daher unterscheiden sich der Importpfad und die Schreibweise DataType (ohne abschließendes s) von der JavaScript-Version.

So funktioniert es

  1. Füge ein JSON-Objekt für eine Tabellenzeile oder ein Array von Zeilen ein.
  2. Gib den Klassennamen in Modellname ein (Standard MyModel); in Upper Snake Case wird er außerdem zum tableName in @Table.
  3. Speichere das Ergebnis als invoice.model.ts und registriere es mit new Sequelize({ ..., models: [Invoice] }) oder mit SequelizeModule.forFeature([Invoice]) von NestJS.

Beispiel

Eingabe (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Ausgabe (sequelize-typescript)
import { Table, Column, Model, DataType } from 'sequelize-typescript';
import { IsNotEmpty, IsOptional } from 'class-validator';

@Table({ tableName: 'INVOICE', timestamps: false })
export class Invoice extends Model<Invoice> {
  @Column({ type: DataType.INTEGER, primaryKey: true, autoIncrement: true })
  id: number;

  @Column({ type: DataType.STRING, allowNull: false, field: 'invoice_no' })
  @IsNotEmpty()
  invoiceNo: string;

  @Column({ type: DataType.DOUBLE, allowNull: false })
  @IsNotEmpty()
  amount: number;

  @Column({ type: DataType.STRING, allowNull: false })
  @IsNotEmpty()
  currency: string;

  @Column({ type: DataType.BOOLEAN, allowNull: false })
  @IsNotEmpty()
  paid: boolean;

  @Column({ type: DataType.DATEONLY, allowNull: false, field: 'due_date' })
  @IsNotEmpty()
  dueDate: string;

  @Column({ type: DataType.STRING, allowNull: false })
  @IsOptional()
  memo: string;
}

memo ist ein leerer String: Er ist nicht NULL, die Spalte behält also allowNull: false, bekommt aber @IsOptional() statt @IsNotEmpty(). amount wird zu DataType.DOUBLE, und due_date wird zu DataType.DATEONLY mit dem Typ string, weil Sequelize reine Datumswerte als Text zurückgibt.

Unterstützte Funktionen

  • Importiert { Table, Column, Model, DataType } aus sequelize-typescript und deklariert die Klasse als extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), passend zum JavaScript-Generator, es werden also keine Spalten createdAt/updatedAt angenommen.
  • Jede @Column gibt type und allowNull an; nullable Spalten werden als string | null usw. typisiert.
  • Typpaare: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> oder ein typisiertes Array wie string[].
  • Properties sind camelCase, wobei field: 'invoice_no' auf die ursprüngliche Spalte zeigt; ein Key id im JSON wird als Primärschlüssel verwendet statt doppelt angelegt.
  • Felder mit nicht leerem Wert in jeder Zeile bekommen @IsNotEmpty(), die übrigen @IsOptional().

Anwendungsfälle

Modelle für NestJS mit `@nestjs/sequelize`

Musst du Daten speichern, die ein externes Abrechnungs- oder Settlement-System als JSON sendet, baue die Modellklasse aus diesem Payload und verwende sie über @InjectModel(Invoice).

JavaScript-Sequelize-Modelle in typisierten Code überführen

Exportiere vorhandene Tabellendaten als JSON und füge sie ein, um einen typisierten Modellentwurf zu bekommen, statt ein define()-Objekt von Hand in eine Klasse umzuschreiben.

Hinweise und Einschränkungen

  • Für Geldbeträge und andere exakte Dezimalzahlen ist DataType.DECIMAL(12, 2) sicherer als DataType.DOUBLE.
  • experimentalDecorators und emitDecoratorMetadata müssen in der tsconfig aktiviert sein, damit die Decorators funktionieren.
  • Mit useDefineForClassFields (Standard ab target ES2022) verdecken einfache Property-Deklarationen die Getter von Sequelize. Schalte diese Option ab oder setze declare vor die Properties.

Häufige Fragen

Müsste es nicht Model<InvoiceAttributes, InvoiceCreationAttributes> statt Model<Invoice> heißen?

sequelize-typescript v2 akzeptiert zwei Generics; der erzeugte Code übergibt einfach die Klasse selbst. Soll Invoice.create({...}) ohne automatisch erzeugte Felder wie id typgeprüft werden, deklariere ein Interface für die Erstellungsattribute und übergib es als zweites Generic.

Warum DataType und nicht DataTypes?

DataType ist der Name, den sequelize-typescript exportiert. DataTypes aus sequelize zu importieren funktioniert genauso, aber pro Datei bei einem Namen zu bleiben liest sich besser.

Werden die class-validator-Decorators am Modell automatisch geprüft?

Nein. Validiert wird nur, wenn du selbst validate(invoice) aufrufst oder die Decorators an einem DTO sitzen, das die ValidationPipe von NestJS verarbeitet. Für Validierung auf Sequelize-Ebene verwende @Column({ validate: { notEmpty: true } }) oder Decorators von sequelize-typescript wie @NotEmpty.