Class CoreDb

db

logger

canUpdate

• canUpdate(): Promise<boolean>

• Returns Promise<boolean>

configExist

• configExist(key): Promise<boolean>

• Parameters

  • key: string

  Returns Promise<boolean>

connect

• connect(): Promise<boolean>

• Returns Promise<boolean>

createEntity

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

• Create new Entity object

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>

  • entity: E

  Returns Promise<E>

debug

• debug(...ags): void

• Parameters

  • Rest ...ags: unknown[]

  Returns void

deleteEntityById

• deleteEntityById(className, e_id): 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): void

• Parameters

  • Rest ...ags: unknown[]

  Returns void

execScripts

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

• Parameters

  • list: RawQuery[]

  Returns Promise<any[]>

findEntity

• findEntity<E>(config, search): 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>

getCClient

• getCClient<X>(): X

• Type Parameters

  • X extends ICoreCClient

  Returns X

getCache

• getCache(): any

• Returns any

getConfig

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

• Parameters

  • key: string

  Returns Promise<undefined | ConfigType>

getConfigStore

• getConfigStore(): IStore

• Returns IStore

getCurrenDBVersion

• getCurrenDBVersion(): Promise<string>

• Returns Promise<string>

getEntityById

• getEntityById<E>(config, id): 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>(query): 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>(className): undefined | CoreEntityWrapper<E>

• Type Parameters

  • E extends CoreEntity

  Parameters

  • className: string

  Returns undefined | CoreEntityWrapper<E>

getKernel

• getKernel(): ICoreKernel<any, ICoreAnyModule>

• Returns ICoreKernel<any, ICoreAnyModule>

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): void

• Parameters

  • Rest ...ags: unknown[]

  Returns void

initEntity

• initEntity<E>(className, entity): 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): Error

• Parameters

  • message: string

  Returns Error

log

• log(...ags): void

• Parameters

  • Rest ...ags: unknown[]

  Returns void

registerEntity

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

• Type Parameters

  • E extends CoreEntity

  Parameters

  • ent: E

  Returns CoreEntityWrapper<E>

removeConfig

• removeConfig(key): Promise<void>

• Parameters

  • key: string

  Returns Promise<void>

setConfig

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

• Parameters

  • key: string

  • value: string

  Returns Promise<boolean>

setConnected

• setConnected(): void

• Returns void

setEntityCache

• setEntityCache(status): void

• Parameters

  • status: boolean

  Returns void

setLogger

• setLogger(logger): void

• Parameters

  • logger: CoreLogger

  Returns void

setUpdateChain

• setUpdateChain(...chain): void

• Parameters

  • Rest ...chain: IBaseDBUpdate[]

  Returns void

start

• start(): Promise<void>

• Returns Promise<void>

update

• update(): Promise<boolean>

• Returns Promise<boolean>

updateEntity

• updateEntity<E>(config, e_id, entity): Promise<boolean>

• Update Entity object

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>

  • e_id: string

  • entity: Partial<EProperties<E>>

  Returns Promise<boolean>

verbose

• verbose(...ags): void

• Parameters

  • Rest ...ags: unknown[]

  Returns void

warn

• warn(...ags): void

• Parameters

  • Rest ...ags: unknown[]

  Returns void