JSONをTypeORMスキーマに変換!

JSONを入力し、TypeORMスキーマに変換します!TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS 対応。
JSON
結果
 

JSONをTypeORMスキーマに変換!

JSON データを TypeORM のエンティティクラスに変換します。主キーを持つ @Entity() クラスを作り、それ以外のキーはすべて、TypeScript の型、NULL 許可、class-validator のデコレーター付きの @Column() プロパティにします。

NestJS + TypeORM のアプリで TypeOrmModule.forFeature([...]) に渡す最初のエンティティを作るときや、Express のプロジェクトに TypeORM の DataSource を追加して、手元のデータに合うエンティティが必要なときに使ってください。

使い方

  1. 保存するレコードをオブジェクトで、複数ならレコードの配列で貼り付けます。一部のレコードにないフィールドは NULL 許可のカラムになります。
  2. モデル名 にエンティティのクラス名を入力します(既定は MyModel)。support ticket と入力すると SupportTicket になります。
  3. support-ticket.entity.ts として保存し、DataSource の entities 配列か、NestJS モジュールの TypeOrmModule.forFeature([SupportTicket]) に追加します。

例

入力 (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;
}

2つ目のチケットには assignee がないので、そのカラムは string | null 型の @Column({ nullable: true }) になります。opened_at は Date 型の openedAt プロパティになり、name: 'opened_at' で元のカラム名を保っています。

対応機能

  • 主キーはデータに従います: id キーがないか整数の id → @PrimaryGeneratedColumn() id: number、32 ビットの範囲を超える id → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string、UUID のような文字列の id → @PrimaryColumn() id: string。
  • カラムの型: 整数は既定の @Column()、小数は小数部が切り捨てられないよう type: 'double precision'、bigint と日付だけの date カラムは(TypeORM がテキストで返すため)string 型、日時は Date です。
  • オブジェクトと配列は、Record<string, unknown> または string[] のような型付き配列の simple-json カラムになります。
  • "007" のように引用符で囲まれた数字は string のカラムのままです。
  • プロパティは camelCase で、JSON のキーと異なる場合は必ず @Column({ name: 'opened_at' }) を追加します。
  • null だったり欠けていたりしたフィールドには nullable: true、| null、@IsOptional() が付き、それ以外には @IsNotEmpty() が付きます。

利用シーン

`nest g resource` 直後のエンティティを埋める

nest g resource tickets が作った空の ticket.entity.ts をこの出力に置き換えれば、エンティティがフロントエンドですでに使っていたモックデータと一致し、Repository<SupportTicket> をすぐに使えます。

マイグレーション生成の出発点

エンティティを作ったあと typeorm migration:generate を実行すると、データベースと比較して、カラム名や NULL 許可も含めた CREATE TABLE のマイグレーションを書き出します。

注意点と制限

  • simple-json は JSON をテキストとして保存するため、中の値で絞り込むことはできません。検索が必要なら、PostgreSQL では type: 'jsonb'、MySQL では type: 'json' に切り替えてください。
  • double precision は浮動小数点型です。価格には @Column('decimal', { precision: 10, scale: 2 }) を使ってください(TypeORM は文字列で返します)。
  • リレーションは推論しません。実は別のエンティティであるネストしたオブジェクトは、@ManyToOne や @OneToMany のリレーションにすべきです。

よくある質問

エンティティはどのテーブル名に対応しますか?

@Entity() に名前がないので、TypeORM の既定の命名でクラス名が snake_case の support_ticket になります。既存のテーブルなら @Entity('tickets') のように名前を渡してください。

emitDecoratorMetadata がオフだとどうなりますか?

オプションなしの @Column() はリフレクションのメタデータから型を読むため、TypeORM がデータ型のエラーで失敗します。tsconfig で有効にするか、@Column('varchar') のように各型を明記してください。

Date のプロパティはデータベースでどの型になりますか?

MySQL では datetime、PostgreSQL では timestamp without time zone です。PostgreSQL でタイムゾーンが重要なら @Column('timestamptz') に切り替えてください。