Class CoreDb

db

logger

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>

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>

debug

• debug(...ags: unknown[]): void

  Parameters

  • ...ags: unknown[]

  Returns void

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>

error

• error(...ags: unknown[]): void

  Parameters

  • ...ags: unknown[]

  Returns void

execScripts

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

  Parameters

  • list: RawQuery[]

  Returns Promise<any[]>

findEntity

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

  Get Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

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

  Returns Promise<null | E>

getCache

• getCache(): any

  Returns any

getCClient

• getCClient<X extends ICoreCClient>(): X

  Type Parameters

  • X extends ICoreCClient

  Returns X

getConfig

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

  Parameters

  • key: string

  Returns Promise<undefined | ConfigType>

getConfigStore

• getConfigStore(): IStore

  Returns IStore

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<null | E>

  Get Entity object by ID

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • id: string

  Returns Promise<null | E>

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,
  ): undefined | CoreEntityWrapper<E>

  Type Parameters

  • E extends CoreEntity

  Parameters

  • className: string

  Returns undefined | CoreEntityWrapper<E>

getKernel

• getKernel(): ICoreKernel

  Returns ICoreKernel

getModule

• getModule(): ICoreKernelModule<
      ICoreKernel<any, ICoreAnyModule>,
      any,
      any,
      any,
      any,
  >

  Returns ICoreKernelModule<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>

getName

• getName(): string

  Returns string

getPrefabDB

• getPrefabDB(): any

  Returns any

getRawDBObject

• getRawDBObject(): Promise<unknown>

  Returns Promise<unknown>

info

• info(...ags: unknown[]): void

  Parameters

  • ...ags: unknown[]

  Returns void

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>

isConnected

• isConnected(): boolean

  Returns boolean

lError

• lError(message: string): Error

  Parameters

  • message: string

  Returns Error

log

• log(...ags: unknown[]): void

  Parameters

  • ...ags: unknown[]

  Returns void

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>

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

setLogger

• setLogger(logger: CoreLogger): void

  Parameters

  • logger: CoreLogger

  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>

verbose

• verbose(...ags: unknown[]): void

  Parameters

  • ...ags: unknown[]

  Returns void

warn

• warn(...ags: unknown[]): void

  Parameters

  • ...ags: unknown[]

  Returns void