Class CoreDBCon<D, T, K, X, P, C, Y>Abstract

dbVersion

schemaName

updater

canUpdate

• canUpdate(): Promise<boolean>

  Returns Promise<boolean>

AbstractconfigExist

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

  Parameters

  • key: string

  Returns Promise<boolean>

Abstractconnect

• connect(): Promise<boolean>

  Returns Promise<boolean>

AbstractcreateEntity

• 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>

AbstractdeleteEntityBulkById

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

  Delete Entity objects by ID

  Parameters

  • className: string
  • e_id: string[]

  Returns Promise<boolean>

AbstractdeleteEntityById

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

  Delete Entity object by ID

  Parameters

  • className: string
  • e_id: string

  Returns Promise<boolean>

Abstractdisconnect

• disconnect(): Promise<boolean>

  Returns Promise<boolean>

AbstractexecScripts

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

  Parameters

  • list: RawQuery[]

  Returns Promise<T[]>

AbstractfindEntity

• findEntity<E extends CoreEntity>(
      config: EntityConfig<E>,
      search: QInterfaceSearch<E>,
  ): Promise<null | E>

  Get Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

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

  Returns Promise<null | E>

getCache

• getCache(): null | C

  Returns null | C

AbstractgetConfig

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

  Parameters

  • key: string

  Returns Promise<undefined | ConfigType>

getCurrenDBVersion

• getCurrenDBVersion(): Promise<string>

  Returns Promise<string>

AbstractgetEntityBulkById

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

  Get Entity object by ID

  Type Parameters

  • E extends CoreEntity

  Parameters

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

  Returns Promise<E[]>

AbstractgetEntityById

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

  Get Entity object by ID

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • e_id: string

  Returns Promise<null | E>

AbstractgetEntityList

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

  Get Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

  • query: QueryInterface<E>

    search query config

  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>

getNew

• getNew(): boolean

  get the db trigger value

  Returns boolean

AbstractgetRawDBObject

• getRawDBObject(): null | D

  Returns null | D

AbstractinitEntity

• 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>

AbstractinitNewDB

• initNewDB(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

registerEntity

• registerEntity<E extends CoreEntity>(
      ent: E,
      noCache?: boolean,
  ): CoreEntityWrapper<E>

  Type Parameters

  • E extends CoreEntity

  Parameters

  • ent: E
  • OptionalnoCache: boolean

  Returns CoreEntityWrapper<E>

AbstractremoveConfig

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

  Parameters

  • key: string

  Returns Promise<void>

AbstractsetConfig

• 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>

AbstractupdateBulkEntity

• 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>

AbstractupdateEntity

• 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>