Class CoreDBPrefab<T>Abstract

constructor

• new CoreDBPrefab<T extends CoreDBCon<any, any, any, any, any, any, any, any>>(
      db: T,
  ): CoreDBPrefab<T>

  Type Parameters

  • T extends CoreDBCon<any, any, any, any, any, any, any, any>

    The concrete CoreDBCon type that the prefab operates on.

  Parameters

  • db: T

  Returns CoreDBPrefab<T>

db

canUpdate

• canUpdate(): Promise<boolean>

  Returns Promise<boolean>

configExist

• configExist(key: string): Promise<boolean>

  Parameters

  • key: string

  Returns Promise<boolean>

connect

• connect(): Promise<boolean>

  Returns Promise<boolean>

countEntity

• countEntity<E extends IEntity>(
      config: EntityConfig<E>,
      search: QInterfaceSearch<E>,
  ): Promise<number>

  Type Parameters

  • E extends IEntity

  Parameters

  • config: EntityConfig<E>
  • search: QInterfaceSearch<E>

  Returns Promise<number>

createEntity

• createEntity<E extends CoreEntity>(
      config: EntityConfig<E>,
      entity: E,
  ): Promise<E>

  Create new Entity object

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • entity: E

  Returns Promise<E>

deleteEntityBulkById

• deleteEntityBulkById(className: string, e_id: string[]): Promise<boolean>

  Delete Entity objects by ID

  Parameters

  • className: string
  • e_id: string[]

  Returns Promise<boolean>

deleteEntityById

• deleteEntityById(className: string, e_id: string): Promise<boolean>

  Delete Entity object by ID

  Parameters

  • className: string
  • e_id: string

  Returns Promise<boolean>

disconnect

• disconnect(): Promise<boolean>

  Returns Promise<boolean>

findEntity

• findEntity<E extends CoreEntity>(
      config: EntityConfig<E>,
      search: { [P in string | number | symbol]?: E[P] },
  ): Promise<E | null>

  Get Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • search: { [P in string | number | symbol]?: E[P] }

  Returns Promise<E | null>

getCache

• getCache(): any

  Returns any

getConfig

• getConfig(key: string): Promise<ConfigType | undefined>

  Parameters

  • key: string

  Returns Promise<ConfigType | undefined>

getCurrenDBVersion

• getCurrenDBVersion(): Promise<string>

  Returns Promise<string>

getEntityBulkById

• getEntityBulkById<E extends CoreEntity>(
      config: EntityConfig<E>,
      id: string[],
  ): Promise<E[]>

  Get Entity objects by ID

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • id: string[]

  Returns Promise<E[]>

getEntityById

• getEntityById<E extends CoreEntity>(
      config: EntityConfig<E>,
      id: string,
  ): Promise<E | null>

  Get Entity object by ID

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • id: string

  Returns Promise<E | null>

getEntityList

• getEntityList<E extends CoreEntity>(query: QueryInterface<E>): Promise<E[]>

  Get Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

  • query: QueryInterface<E>

  Returns Promise<E[]>

getEntityMeta

• getEntityMeta(): { key: string; meta: ColumnPropMap<any> }[]

  Returns { key: string; meta: ColumnPropMap<any> }[]

getEntityWrapper

• getEntityWrapper<E extends CoreEntity>(className: string): CoreEntityWrapper<E>

  Type Parameters

  • E extends CoreEntity

  Parameters

  • className: string

  Returns CoreEntityWrapper<E>

getPrefabDB

• getPrefabDB(): T

  Returns T

getRawDBObject

• getRawDBObject(): Promise<unknown>

  Returns Promise<unknown>

initEntity

• initEntity<E extends CoreEntity>(className: string, entity: E): Promise<boolean>

  Init Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

  • className: string
  • entity: E

  Returns Promise<boolean>

initNewDB

• initNewDB(): Promise<void>

  Returns Promise<void>

AbstractinitPrefabDB

• initPrefabDB(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

populate

• populate<
      E extends CoreEntity,
      EK extends string | number | symbol,
      R extends CoreEntity,
  >(
      entity: E,
      field: EK,
  ): Promise<PopulatedResult<E, EK, R>>

  Type Parameters

  • E extends CoreEntity
  • EK extends string | number | symbol
  • R extends CoreEntity

  Parameters

  • entity: E
  • field: EK

  Returns Promise<PopulatedResult<E, EK, R>>

populateMany

• populateMany<
      E extends CoreEntity,
      EK extends string | number | symbol,
      R extends CoreEntity,
  >(
      entity: E[],
      field: EK,
  ): Promise<PopulatedResult<E, EK, R>[]>

  Type Parameters

  • E extends CoreEntity
  • EK extends string | number | symbol
  • R extends CoreEntity

  Parameters

  • entity: E[]
  • field: EK

  Returns Promise<PopulatedResult<E, EK, R>[]>

queryScript

• queryScript<E>(query: RawQuery): Promise<RawQueryResult<E, any>>

  Type Parameters

  • E

  Parameters

  • query: RawQuery

  Returns Promise<RawQueryResult<E, any>>

registerEntity

• registerEntity<E extends CoreEntity>(ent: E): CoreEntityWrapper<E>

  Type Parameters

  • E extends CoreEntity

  Parameters

  • ent: E

  Returns CoreEntityWrapper<E>

removeConfig

• removeConfig(key: string): Promise<void>

  Parameters

  • key: string

  Returns Promise<void>

runScripts

• runScripts(...list: RawQuery[]): Promise<any[]>

  Parameters

  • ...list: RawQuery[]

  Returns Promise<any[]>

setConfig

• setConfig(key: string, value: string): Promise<boolean>

  Parameters

  • key: string
  • value: string

  Returns Promise<boolean>

setConnected

• setConnected(): void

  Returns void

setEntityCache

• setEntityCache(status: boolean): void

  Parameters

  • status: boolean

  Returns void

setUpdateChain

• setUpdateChain(...chain: IBaseDBUpdate[]): void

  Parameters

  • ...chain: IBaseDBUpdate[]

  Returns void

start

• start(): Promise<void>

  Returns Promise<void>

update

• update(): Promise<boolean>

  Returns Promise<boolean>

updateBulkEntity

• updateBulkEntity<E extends IEntity>(
      config: EntityConfig<E>,
      e_id: string[],
      entity: EUpDateProperties<E>,
  ): Promise<boolean>

  Update Entity objects

  Type Parameters

  • E extends IEntity

  Parameters

  • config: EntityConfig<E>
  • e_id: string[]
  • entity: EUpDateProperties<E>

  Returns Promise<boolean>

updateEntity

• updateEntity<E extends CoreEntity>(
      config: EntityConfig<E>,
      e_id: string,
      entity: EUpDateProperties<E>,
  ): Promise<boolean>

  Update Entity object

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • e_id: string
  • entity: EUpDateProperties<E>

  Returns Promise<boolean>