JSON کو TypeORM منصوبے میں تبدیل کریں!

JSON درج کریں اور اسے TypeORM منصوبے میں تبدیل کریں! TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS سپورٹ۔
JSON
نتیجہ
 

JSON کو TypeORM منصوبے میں تبدیل کریں!

JSON ڈیٹا کو TypeORM entity کلاس میں بدلتا ہے: primary key والی @Entity() کلاس، اور باقی ہر key ایک @Column() property کی صورت میں، TypeScript type، nullability اور class-validator decorator کے ساتھ۔

اسے NestJS + TypeORM ایپ میں TypeOrmModule.forFeature([...]) کے لیے پہلی entity بنانے کے لیے استعمال کریں، یا جب Express پروجیکٹ میں TypeORM کا DataSource شامل کرتے وقت آپ کو پہلے سے موجود ڈیٹا سے میل کھانے والی entities چاہئیں۔

استعمال کا طریقہ

  1. محفوظ کرنے والا record آبجیکٹ کی صورت میں، یا کئی records array کی صورت میں پیسٹ کریں۔ جو فیلڈز کچھ records میں نہ ہوں وہ nullable کالمز بنتے ہیں۔
  2. ماڈل کا نام میں entity کلاس کا نام لکھیں (ڈیفالٹ MyModel)؛ support ticket بنتا ہے SupportTicket۔
  3. اسے support-ticket.entity.ts کے طور پر محفوظ کریں اور اپنے DataSource کی entities array میں یا کسی NestJS module میں 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;
}

دوسرے ticket میں assignee نہیں، اس لیے وہ کالم string | null type کے ساتھ @Column({ nullable: true }) ہے۔ opened_at بدل کر Date type والی openedAt property بن گیا، اور name: 'opened_at' اصل کالم نام برقرار رکھتا ہے۔

معاون خصوصیات

  • primary key آپ کے ڈیٹا سے: id key نہ ہو یا integer id ہو → @PrimaryGeneratedColumn() id: number؛ 32-bit حد سے بڑا id → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string؛ UUID جیسا string id → @PrimaryColumn() id: string۔
  • کالم types: integers ڈیفالٹ @Column() استعمال کرتے ہیں، decimals کو type: 'double precision' ملتا ہے تاکہ کسر نہ کٹے، bigint اور صرف تاریخ والے date کالمز کی type string ہوتی ہے (TypeORM انہیں ٹیکسٹ کے طور پر لوٹاتا ہے)، date-times کی type Date ہوتی ہے۔
  • objects اور arrays، Record<string, unknown> یا string[] جیسی typed array والے simple-json کالمز بنتے ہیں۔
  • "007" جیسے quotes والے ہندسے string کالمز رہتے ہیں۔
  • properties camelCase ہوتی ہیں؛ جب بھی JSON key مختلف ہو، @Column({ name: 'opened_at' }) شامل کیا جاتا ہے۔
  • جو فیلڈز null تھے یا غائب تھے انہیں nullable: true، | null اور @IsOptional() ملتا ہے؛ باقی کو @IsNotEmpty() ملتا ہے۔

استعمال کے کیس

`nest g resource` کے فوراً بعد entity بھرنا

nest g resource tickets سے بنی خالی ticket.entity.ts کو اس آؤٹ پٹ سے بدلیں؛ پھر entity اس mock ڈیٹا سے میل کھاتی ہے جو فرنٹ اینڈ پہلے سے استعمال کر رہا تھا، اور Repository<SupportTicket> استعمال کے لیے تیار ہے۔

generated migrations کے لیے نقطۂ آغاز

entity بنانے کے بعد typeorm migration:generate اسے ڈیٹا بیس سے موازنہ کر کے کالم ناموں اور nullability سمیت CREATE TABLE migration لکھ دیتا ہے۔

نوٹس اور حدود

  • simple-json، JSON کو ٹیکسٹ کے طور پر محفوظ کرتا ہے، اس لیے آپ اس کے اندر کی values پر filter نہیں کر سکتے۔ اگر ان پر query کرنی ہو تو PostgreSQL پر type: 'jsonb' اور MySQL پر type: 'json' استعمال کریں۔
  • double precision ایک floating-point type ہے؛ قیمتوں کے لیے @Column('decimal', { precision: 10, scale: 2 }) استعمال کریں، جسے TypeORM string کے طور پر لوٹاتا ہے۔
  • relations کا اندازہ نہیں لگایا جاتا۔ جو nested objects اصل میں دوسری entities ہیں انہیں @ManyToOne یا @OneToMany relations بنانا چاہیے۔

عام سوالات

entity کس table نام سے map ہوتی ہے؟

@Entity() میں کوئی نام نہیں، اس لیے TypeORM کی ڈیفالٹ naming کلاس نام کو snake_case میں بدل دیتی ہے: support_ticket۔ موجودہ table کے لیے نام دیں، مثلاً @Entity('tickets')۔

اگر emitDecoratorMetadata بند ہو تو کیا ہوگا؟

بغیر options کا @Column() اپنی type reflection metadata سے پڑھتا ہے، اس لیے TypeORM data type error کے ساتھ ناکام ہوتا ہے۔ اسے tsconfig میں فعال کریں یا ہر type واضح لکھیں، مثلاً @Column('varchar')۔

Date property کو کون سی ڈیٹا بیس type ملتی ہے؟

MySQL پر datetime اور PostgreSQL پر timestamp without time zone۔ اگر PostgreSQL پر time zones اہم ہوں تو @Column('timestamptz') استعمال کریں۔