Database

Quark ERP သည် PostgreSQL ပေါ်တွင် TypeORM ကို အသုံးပြုပါသည်။ အများအားဖြင့် shared default DataSource ကို အသုံးပြုရပါသည်။ Plugin တစ်ခုသည် @Database ဖြင့် connection တစ်ခု သို့မဟုတ် အများအပြား ဖွင့်နိုင်ပြီး၊ အခြား plugin များက owner plugin name (နှင့် optional connection name) ဖြင့် ထို connection ကို inject လုပ်သုံးနိုင်ပါသည်။

Stack

PostgreSQL — အဓိက persistent store (PluginEnv / base .env မှ env)
TypeORM — entities၊ repositories၊ QueryRunner၊ migrations
Default datasource — shared core; plugin: "default" ဖြင့် merge
Custom datasource — root @Module ပေါ်တွင် @Database; named connection အများအပြား ဖွင့်နိုင်ပါသည်
Cross-plugin — @InjectDatabaseSource("other-plugin", "connection-name?")

@InjectDatabaseSource

Service property ပေါ်တွင် TypeORM DataSource ကို inject လုပ်ရပါသည် (constructor injection မထောက်ပံ့ပါ)။ ပထမ arg သည် connection ပိုင်သော plugin; ဒုတိယ arg သည် optional connection name ဖြစ်ပါသည်။

DataSourceManager.DEFAULT_PLUGIN — အဓိက core datasource
metadata.name — ဤ plugin ပိုင် default custom connection
"other-plugin" — အခြား plugin က ဖန်တီးထားသော connection
ဒုတိယ arg name — owner plugin တွင် @Database အများအပြား ရှိလျှင် (ဥပမာ "analytics")

TSXinject

import { DataSource } from "typeorm";
import {
  InjectDatabaseSource,
  DataSourceManager,
  Service,
} from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { OrderEntity } from "./order.entity.js";

@Service()
export class OrderService {
  // Shared core Postgres
  @InjectDatabaseSource(DataSourceManager.DEFAULT_PLUGIN)
  source: DataSource;

  // This plugin’s own connection (default name)
  @InjectDatabaseSource(metadata.name)
  pluginSource: DataSource;

  // This plugin’s named connection
  @InjectDatabaseSource(metadata.name, "analytics")
  analyticsSource: DataSource;

  // Connection owned by another plugin
  @InjectDatabaseSource("warehouse", "replica")
  warehouseReplica: DataSource;

  private get repo() {
    return this.source.getRepository(OrderEntity);
  }
}

Entity သတ်မှတ်ခြင်း

ဇယားအမည်များသည် plugin name ဖြင့် စရပါမည်။ Template literal တွင် metadata.name ကို အသုံးပြုရပါသည်။ create/update/soft-delete ကော်လံများအတွက် BaseEntity ကို အမြဲ extend လုပ်ရပါသည်။

TSXentity

import { BaseEntity } from "@quan-erp/shared-backend-core";
import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";
import metadata from "../../../../module.metadata.json" with { type: "json" };

@Entity(`${metadata.name}_driver_document`)
export class DriverDocumentEntity extends BaseEntity {
  @PrimaryGeneratedColumn("increment")
  id: number;

  @Column()
  documentName: string;
}

Module တွင် မှတ်ပုံတင်ခြင်း

Entity များကို datasource အလိုက် အုပ်စုဖွဲ့ရပါသည်။ Primary shared connection အတွက် plugin: "default"။ Custom @Database အတွက် plugin (နှင့် optional name) ကို ထို connection နှင့် ကိုက်အောင် သတ်မှတ်ရပါသည်။

TSXdefault datasource

import { Module } from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { OrderController } from "./order.controller.js";
import { OrderService } from "./order.service.js";
import { DriverDocumentEntity } from "./driver-document.entity.js";

@Module({
  name: metadata.name,
  providers: [OrderService],
  controllers: [OrderController],
  entities: [
    {
      plugin: "default",
      entities: [DriverDocumentEntity],
    },
  ],
})
export class MyPluginModule {}

Custom datasource (@Database)

Root module ပေါ်တွင် @Database တစ်ခု သို့မဟုတ် အများအပြားဖြင့် TypeORM connection ကြေညာရပါသည်။ သီးခြား host/schema၊ reporting DB၊ replica စသည် တကယ်လိုမှသာ အသုံးပြုရပါသည်။ Credentials ကို env မှ ယူရပါသည်။

@Database({ name?, options }) — root @Module class ပေါ်တွင်
name — plugin တစ်ခုတွင် DB အများအပြား ဖွင့်လျှင် လိုအပ်ပါသည်
options — TypeORM DataSourceOptions
Entities — plugin + name ကိုက်အောင် မှတ်ပုံတင်ရပါသည်
Module class တစ်ခုပေါ်တွင် @Database အများအပြား = connection အများအပြား

TSXmultiple connections in one plugin

import {
  Database,
  Module,
} from "@quan-erp/shared-backend-core";
import metadata from "../../module.metadata.json" with { type: "json" };
import { AnalyticsEntity } from "./analytics.entity.js";
import { WarehouseEntity } from "./warehouse.entity.js";
import { AnalyticsService } from "./analytics.service.js";

@Database({
  name: "analytics",
  options: {
    type: "postgres",
    host: process.env.ANALYTICS_DB_HOST,
    port: Number(process.env.ANALYTICS_DB_PORT ?? 5432),
    username: process.env.ANALYTICS_DB_USERNAME,
    password: process.env.ANALYTICS_DB_PASSWORD,
    database: process.env.ANALYTICS_DB_SCHEMA,
    synchronize: process.env.ANALYTICS_DB_SYNC === "true",
  },
})
@Database({
  name: "replica",
  options: {
    type: "postgres",
    host: process.env.REPLICA_DB_HOST,
    port: Number(process.env.REPLICA_DB_PORT ?? 5432),
    username: process.env.REPLICA_DB_USERNAME,
    password: process.env.REPLICA_DB_PASSWORD,
    database: process.env.REPLICA_DB_SCHEMA,
    synchronize: false,
  },
})
@Module({
  name: metadata.name,
  providers: [AnalyticsService],
  controllers: [],
  entities: [
    {
      plugin: metadata.name,
      name: "analytics",
      entities: [AnalyticsEntity],
    },
    {
      plugin: metadata.name,
      name: "replica",
      entities: [WarehouseEntity],
    },
  ],
})
export class MyPluginModule {}

အခြား plugin ၏ connection သုံးခြင်း

Connection များသည် owner plugin (+ optional name) ဖြင့် process-wide registry တွင် ရှိပါသည်။ Consumer plugin သည် ထို DB အတွက် @Database ပြန်မကြေညာဘဲ owner ၏ connection ကို inject လုပ်သုံးပါသည်။

Owner plugin — @Database ကြေညာပြီး အရင် boot လုပ်ရပါသည် (pluginDependencies တွင် ထည့်ရပါသည်)
Consumer — @InjectDatabaseSource("owner-plugin", "connection-name")
Foreign connection ပေါ်ရှိ entities — plugin: "owner-plugin", name: "connection-name"
Consumer တိုင်းတွင် တူညီသော @Database ကို ထပ်မကြေညာရပါ
Owner plugin install / load ပြီးမှ consumer က DataSource inject လုပ်ရပါမည်

TSXconsumer plugin service

import { DataSource } from "typeorm";
import { InjectDatabaseSource, Service } from "@quan-erp/shared-backend-core";

@Service()
export class ReportService {
  // "warehouse" plugin declared @Database({ name: "replica", ... })
  @InjectDatabaseSource("warehouse", "replica")
  warehouseReplica: DataSource;
}

TSXconsumer module entities on foreign connection

@Module({
  name: metadata.name,
  providers: [ReportService],
  controllers: [],
  entities: [
    {
      plugin: "warehouse",
      name: "replica",
      entities: [ReportSnapshotEntity],
    },
  ],
})
export class ReportPluginModule {}

CRUD patterns

Create: repo.insert(...) → identifiers မှ { id } ပြန်ပေးရပါသည်
Update: repo.update + affected စစ်ဆေးရပါသည်
Delete: repo.softDelete + affected ကို ဦးစားပေးရပါသည်