Class PGCon<K, T, P, C, X>

constructor

• new PGCon<
      K extends
          ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>,
      T extends
          | null
          | IDataBase<
              any,
              any,
              ICoreKernel<any, ICoreAnyModule>,
              any,
              any,
              any,
              any,
          > = any,
      P extends null
      | ICoreClient = any,
      C extends
          null | ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any,
      X extends
          | null
          | ICorePresenter<
              any,
              ICoreKernel<any, ICoreAnyModule>,
              any,
              any,
              any,
              any,
          > = any,
  >(
      module: ICoreKernelModule<any, any, any, any, any>,
      dbversion: string,
      printLog?: boolean,
  ): PGCon<K, T, P, C, X>

  Type Parameters

  • K extends ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>
  • T extends null | IDataBase<any, any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any
  • P extends null | ICoreClient = any
  • C extends null | ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any
  • X extends null | ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any

  Parameters

  • module: ICoreKernelModule<any, any, any, any, any>
  • dbversion: string
  • printLog: boolean = false

  Returns PGCon<K, T, P, C, X>

db

printLog

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: EProperties<E>,
  ): Promise<E>

  Create new Entity object

  Type Parameters

  • E extends CoreEntity

  Parameters

  • config: EntityConfig<E>
  • entity: EProperties<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>

execScripts

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

  Parameters

  • list: RawQuery[]

  Returns Promise<(null | QueryResult<any>)[]>

findEntity

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

getConfig

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

  Parameters

  • key: string

  Returns Promise<undefined | ConfigType>

getEntityBulkById

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

getEntityById

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

getEntityList

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

  Get Entity object list

  Type Parameters

  • E extends CoreEntity

  Parameters

  • q: QueryInterface<E>

  Returns Promise<E[]>

getRawDBObject

• getRawDBObject(): null | Client

  Returns null | Client

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>

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>

transformEntityKeys

• transformEntityKeys<E extends CoreEntity>(entity: E): string

  Type Parameters

  • E extends CoreEntity

  Parameters

  • entity: E

  Returns string

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>