Konvertieren Sie JSON in TypeORM-Schema!

Geben Sie JSON ein und konvertieren Sie es in ein TypeORM-Schema! Unterstützt TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Ergebnis
 

Konvertieren Sie JSON in TypeORM-Schema!

Wandelt JSON-Daten in eine TypeORM-Entity-Klasse um: eine @Entity()-Klasse mit Primärschlüssel, in der jeder andere Key zu einer @Column()-Property mit TypeScript-Typ, Nullbarkeit und einem class-validator-Decorator wird.

Verwende es, um die erste Entity für TypeOrmModule.forFeature([...]) in einer NestJS-+-TypeORM-App anzulegen, oder wenn du einem Express-Projekt eine TypeORM-DataSource hinzufügst und Entities brauchst, die zu bereits vorhandenen Daten passen.

So funktioniert es

  1. Füge den zu speichernden Datensatz als Objekt oder mehrere Datensätze als Array ein. Felder, die in manchen Datensätzen fehlen, werden zu nullable Spalten.
  2. Gib den Namen der Entity-Klasse in Modellname ein (Standard MyModel); aus support ticket wird SupportTicket.
  3. Speichere sie als support-ticket.entity.ts und füge sie dem entities-Array deiner DataSource oder TypeOrmModule.forFeature([SupportTicket]) in einem NestJS-Modul hinzu.

Beispiel

Eingabe (JSON)
[
  { "subject": "Login fails on Safari", "priority": 2, "assignee": "jdoe", "closed": false, "opened_at": "2024-06-03T08:12:00Z" },
  { "subject": "Export CSV is empty", "priority": 1, "closed": true, "opened_at": "2024-06-04T14:40:00Z" }
]
Ausgabe (TypeORM)
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
import { IsNotEmpty, IsOptional } from 'class-validator';

@Entity()
export class SupportTicket {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  @IsNotEmpty()
  subject: string;

  @Column()
  @IsNotEmpty()
  priority: number;

  @Column({ nullable: true })
  @IsOptional()
  assignee: string | null;

  @Column()
  @IsNotEmpty()
  closed: boolean;

  @Column({ name: 'opened_at' })
  @IsNotEmpty()
  openedAt: Date;
}

Das zweite Ticket hat kein assignee, daher ist diese Spalte @Column({ nullable: true }) mit dem Typ string | null. opened_at wurde zur Property openedAt vom Typ Date, wobei name: 'opened_at' den ursprünglichen Spaltennamen behält.

Unterstützte Funktionen

  • Primärschlüssel aus deinen Daten: kein Key id oder eine ganzzahlige id → @PrimaryGeneratedColumn() id: number; eine id über dem 32-Bit-Bereich → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; eine String-id wie eine UUID → @PrimaryColumn() id: string.
  • Spaltentypen: Ganzzahlen verwenden das Standard-@Column(), Dezimalzahlen bekommen type: 'double precision', damit Nachkommastellen nicht abgeschnitten werden, bigint- und reine date-Spalten werden als string typisiert (TypeORM gibt sie als Text zurück), Datum mit Uhrzeit ist Date.
  • Objekte und Arrays werden zu simple-json-Spalten mit dem Typ Record<string, unknown> oder einem typisierten Array wie string[].
  • Ziffern in Anführungszeichen wie "007" bleiben string-Spalten.
  • Properties sind camelCase; @Column({ name: 'opened_at' }) wird immer dann ergänzt, wenn der JSON-Key abweicht.
  • Felder, die null waren oder fehlten, bekommen nullable: true, | null und @IsOptional(); der Rest bekommt @IsNotEmpty().

Anwendungsfälle

Eine Entity direkt nach `nest g resource` befüllen

Ersetze die leere ticket.entity.ts, die nest g resource tickets anlegt, durch diese Ausgabe; dann passt die Entity zu den Mock-Daten, die das Frontend schon verwendet hat, und Repository<SupportTicket> ist einsatzbereit.

Ein Ausgangspunkt für generierte Migrationen

Nach dem Anlegen der Entity vergleicht typeorm migration:generate sie mit der Datenbank und schreibt die CREATE TABLE-Migration, inklusive Spaltennamen und Nullbarkeit.

Hinweise und Einschränkungen

  • simple-json speichert JSON als Text, nach Werten darin kannst du also nicht filtern. Musst du sie abfragen, wechsle auf PostgreSQL zu type: 'jsonb' und auf MySQL zu type: 'json'.
  • double precision ist ein Gleitkommatyp; verwende für Preise @Column('decimal', { precision: 10, scale: 2 }), das TypeORM als String zurückgibt.
  • Relationen werden nicht abgeleitet. Verschachtelte Objekte, die eigentlich andere Entities sind, sollten zu @ManyToOne- oder @OneToMany-Relationen werden.

Häufige Fragen

Auf welchen Tabellennamen wird die Entity abgebildet?

@Entity() hat keinen Namen, daher macht die Standardbenennung von TypeORM aus dem Klassennamen snake_case: support_ticket. Bei einer bestehenden Tabelle übergibst du den Namen, z. B. @Entity('tickets').

Was, wenn emitDecoratorMetadata deaktiviert ist?

Ein @Column() ohne Optionen liest seinen Typ aus Reflection-Metadaten, daher scheitert TypeORM mit einem Datentypfehler. Aktiviere die Option in der tsconfig oder gib jeden Typ an, z. B. @Column('varchar').

Welchen Datenbanktyp bekommt eine Date-Property?

datetime auf MySQL und timestamp without time zone auf PostgreSQL. Spielen Zeitzonen auf PostgreSQL eine Rolle, wechsle zu @Column('timestamptz').