Преобразуйте JSON в схему TypeORM!

Введите JSON и преобразуйте его в схему TypeORM! Поддержка: TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Результат
 

Преобразуйте JSON в схему TypeORM!

Преобразует данные JSON в класс сущности TypeORM: класс @Entity() с первичным ключом, где каждый остальной ключ становится свойством @Column() с типом TypeScript, признаком nullable и декоратором class-validator.

Используйте, чтобы создать первую сущность для TypeOrmModule.forFeature([...]) в приложении на NestJS + TypeORM или когда добавляете DataSource TypeORM в проект на Express и нужны сущности, совпадающие с уже имеющимися данными.

Как пользоваться

  1. Вставьте сохраняемую запись как объект или несколько записей массивом. Поля, отсутствующие в части записей, становятся nullable-колонками.
  2. Введите имя класса сущности в Имя модели (по умолчанию MyModel); support ticket превращается в SupportTicket.
  3. Сохраните как support-ticket.entity.ts и добавьте в массив entities вашего DataSource или в TypeOrmModule.forFeature([SupportTicket]) в модуле NestJS.

Пример

Вход (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" }
]
Результат (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;
}

У второго тикета нет assignee, поэтому эта колонка — @Column({ nullable: true }) с типом string | null. opened_at стал свойством openedAt типа Date, а name: 'opened_at' сохраняет исходное имя колонки.

Возможности

  • Первичный ключ по вашим данным: нет ключа id или целочисленный id → @PrimaryGeneratedColumn() id: number; id за пределами 32-битного диапазона → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; строковый id, например UUID → @PrimaryColumn() id: string.
  • Типы колонок: целые используют @Column() по умолчанию, дробные получают type: 'double precision', чтобы дробная часть не обрезалась, колонки bigint и date (только дата) типизируются как string (TypeORM возвращает их текстом), дата-время — Date.
  • Объекты и массивы становятся колонками simple-json с типом Record<string, unknown> или типизированным массивом вроде string[].
  • Цифры в кавычках вроде "007" остаются колонками string.
  • Свойства в camelCase; @Column({ name: 'opened_at' }) добавляется всякий раз, когда ключ JSON отличается.
  • Поля, которые были null или отсутствовали, получают nullable: true, | null и @IsOptional(); остальные — @IsNotEmpty().

Сценарии использования

Заполнение сущности сразу после `nest g resource`

Замените пустой ticket.entity.ts, созданный nest g resource tickets, этим выводом; тогда сущность совпадёт с mock-данными, которые фронтенд уже использовал, и Repository<SupportTicket> готов к работе.

Отправная точка для генерируемых миграций

После создания сущности typeorm migration:generate сравнивает её с базой данных и пишет миграцию CREATE TABLE, включая имена колонок и nullability.

Примечания и ограничения

  • simple-json хранит JSON как текст, поэтому фильтровать по значениям внутри нельзя. Если нужны запросы по ним, переключитесь на type: 'jsonb' в PostgreSQL или на type: 'json' в MySQL.
  • double precision — тип с плавающей точкой; для цен используйте @Column('decimal', { precision: 10, scale: 2 }), который TypeORM возвращает строкой.
  • Связи не выводятся. Вложенные объекты, которые на самом деле являются другими сущностями, стоит превратить в связи @ManyToOne или @OneToMany.

Частые вопросы

На какую таблицу отображается сущность?

У @Entity() нет имени, поэтому стратегия именования TypeORM по умолчанию переводит имя класса в snake_case: support_ticket. Для существующей таблицы передайте имя, например @Entity('tickets').

Что если emitDecoratorMetadata выключен?

@Column() без опций читает тип из reflection-метаданных, так что TypeORM упадёт с ошибкой типа данных. Включите опцию в tsconfig или укажите каждый тип явно, например @Column('varchar').

Какой тип в базе получает свойство Date?

datetime в MySQL и timestamp without time zone в PostgreSQL. Если в PostgreSQL важны часовые пояса, переключитесь на @Column('timestamptz').