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

PGCon is a PostgreSQL database connection implementation that extends CoreDBCon and implements IDataBase.

Implements

IDataBase<PGDBType, QueryResult | null, K, T, P, C, X>

Type Parameters

K extends ICoreKernel<any> = ICoreKernel<any>
Core kernel type extending ICoreKernel
T extends IDataBase<any, any> | null = any
Data base type extending IDataBase<any, any> or null
P extends ICoreClient | null = any
Core client type extending ICoreClient or null
C extends ICoreCache | null = any
Core cache type extending ICoreCache or null
X extends ICorePresenter<any> | null = any
Core presenter type extending ICorePresenter or null

Hierarchy

CoreDBCon<PGDBType, QueryResult, QueryResultBase, K, T, P, C, X>
- PGCon

Implements

IDataBase<PGDBType, QueryResult, QueryResultBase, K, T, P, C, X>

Constructors

constructor

new PGCon<
    K extends
        ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>,
    T extends
        | IDataBase<
            any,
            any,
            any,
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >
        | null = any,
    P extends ICoreClient
    | null = any,
    C extends
        ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any,
    X extends
        | ICorePresenter<
            any,
            ICoreKernel<any, ICoreAnyModule>,
            any,
            any,
            any,
            any,
        >
        | null = 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>
  Core kernel type extending ICoreKernel
- T extends
      | IDataBase<
          any,
          any,
          any,
          ICoreKernel<any, ICoreAnyModule>,
          any,
          any,
          any,
          any,
      >
      | null = any
  Data base type extending IDataBase<any, any> or null
- P extends ICoreClient | null = any
  Core client type extending ICoreClient or null
- C extends ICoreCache<ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any
  Core cache type extending ICoreCache or null
- X extends ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> | null = any
  Core presenter type extending ICorePresenter or null
Parameters
- module: ICoreKernelModule<any, any, any, any, any>
- dbversion: string
- printLog: boolean = false
Returns PGCon<K, T, P, C, X>
Overrides CoreDBCon<PGDBType, QueryResult, QueryResultBase, K, T, P, C, X>.constructor
- Defined in src/class/PGCon.ts:58

Properties

`Protected`channel

channel: string

db

db: Pool | null

dbVersion

dbVersion: string

logger

logger: CoreLogger | null

printLog

printLog: boolean

schemaName

schemaName: string

updater

updater: IBaseDBUpdate | null

Methods

canUpdate

canUpdate(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.canUpdate

Inherited from CoreDBCon.canUpdate
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:693

configExist

configExist(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Implementation of IDataBase.configExist

Overrides CoreDBCon.configExist
- Defined in src/class/PGCon.ts:394

connect

connect(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.connect

Overrides CoreDBCon.connect
- Defined in src/class/PGCon.ts:328

countEntity

countEntity<E extends IEntity>(
config: EntityConfig<E>,
search?: QInterfaceSearch<E>,
): Promise<number>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- Optionalsearch: QInterfaceSearch<E>
Returns Promise<number>
Implementation of IDataBase.countEntity

Overrides CoreDBCon.countEntity
- Defined in src/class/PGCon.ts:250

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>
Implementation of IDataBase.createEntity

Overrides CoreDBCon.createEntity
- Defined in src/class/PGCon.ts:70

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IDataBase.debug

Inherited from CoreDBCon.debug
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:221

deleteEntityBulkById

deleteEntityBulkById(className: string, e_id: string[]): Promise<boolean>
Delete Entity objects by ID
Parameters
- className: string
- e_id: string[]
Returns Promise<boolean>
Implementation of IDataBase.deleteEntityBulkById

Overrides CoreDBCon.deleteEntityBulkById
- Defined in src/class/PGCon.ts:176

deleteEntityById

deleteEntityById(className: string, e_id: string): Promise<boolean>
Delete Entity object by ID
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
Implementation of IDataBase.deleteEntityById

Overrides CoreDBCon.deleteEntityById
- Defined in src/class/PGCon.ts:166

disconnect

disconnect(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.disconnect

Overrides CoreDBCon.disconnect
- Defined in src/class/PGCon.ts:468

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IDataBase.error

Inherited from CoreDBCon.error
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:223

findEntity

findEntity<E extends CoreEntity>(
config: EntityConfig<E>,
search: QInterfaceSearch<E>,
): Promise<E | null>
Get Entity object list
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- search: QInterfaceSearch<E>
Returns Promise<E | null>
Implementation of IDataBase.findEntity

Overrides CoreDBCon.findEntity
- Defined in src/class/PGCon.ts:192

getCache

getCache(): C | null
Returns C | null
Implementation of IDataBase.getCache

Inherited from CoreDBCon.getCache
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:773

getCClient

getCClient<X extends ICoreCClient>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from CoreDBCon.getCClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:255

getConfig

getConfig(key: string): Promise<ConfigType | undefined>
Parameters
- key: string
Returns Promise<ConfigType | undefined>
Implementation of IDataBase.getConfig

Overrides CoreDBCon.getConfig
- Defined in src/class/PGCon.ts:418

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from CoreDBCon.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:254

getCurrenDBVersion

getCurrenDBVersion(): Promise<string>
Returns Promise<string>
Implementation of IDataBase.getCurrenDBVersion

Inherited from CoreDBCon.getCurrenDBVersion
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:694

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[]>
Implementation of IDataBase.getEntityBulkById

Overrides CoreDBCon.getEntityBulkById
- Defined in src/class/PGCon.ts:145

getEntityById

getEntityById<E extends CoreEntity>(
config: EntityConfig<E>,
e_id: string,
): Promise<E | null>
Get Entity object by ID
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- e_id: string
Returns Promise<E | null>
Implementation of IDataBase.getEntityById

Overrides CoreDBCon.getEntityById
- Defined in src/class/PGCon.ts:127

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[]>
Implementation of IDataBase.getEntityList

Overrides CoreDBCon.getEntityList
- Defined in src/class/PGCon.ts:213

getEntityMeta

getEntityMeta(): { key: string; meta: ColumnPropMap<any> }[]
Returns { key: string; meta: ColumnPropMap<any> }[]
Implementation of IDataBase.getEntityMeta

Inherited from CoreDBCon.getEntityMeta
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:688

getEntityWrapper

getEntityWrapper<E extends CoreEntity>(className: string): CoreEntityWrapper<E>
Type Parameters
- E extends CoreEntity
Parameters
- className: string
Returns CoreEntityWrapper<E>
Inherited from CoreDBCon.getEntityWrapper
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:687

getKernel

getKernel(): K
Returns K
Inherited from CoreDBCon.getKernel
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:252

getModule

getModule(): ICoreKernelModule<K, T, P, C, X>
Returns ICoreKernelModule<K, T, P, C, X>
Inherited from CoreDBCon.getModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:253

getName

getName(): string
Returns string
Implementation of IDataBase.getName

Inherited from CoreDBCon.getName
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:227

getNew

getNew(): boolean
get the db trigger value

Returns boolean
Inherited from CoreDBCon.getNew
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:777

getRawDBObject

getRawDBObject(): Pool | null
Returns Pool | null
Implementation of IDataBase.getRawDBObject

Overrides CoreDBCon.getRawDBObject
- Defined in src/class/PGCon.ts:390

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IDataBase.info

Inherited from CoreDBCon.info
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:222

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>
Implementation of IDataBase.initEntity

Overrides CoreDBCon.initEntity
- Defined in src/class/PGCon.ts:266

initNewDB

initNewDB(): Promise<void>
Returns Promise<void>
Implementation of IDataBase.initNewDB

Overrides CoreDBCon.initNewDB
- Defined in src/class/PGCon.ts:324

isConnected

isConnected(): boolean
Returns boolean
Implementation of IDataBase.isConnected

Inherited from CoreDBCon.isConnected
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:696

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Implementation of IDataBase.lError

Inherited from CoreDBCon.lError
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:226

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IDataBase.log

Inherited from CoreDBCon.log
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:220

populate

populate<
    E extends CoreEntity,
    EK extends string | number | symbol,
    Z extends CoreEntity,
>(
    entity: E,
    field: EK,
): Promise<PopulatedResult<E, EK, Z>>
Type Parameters
- E extends CoreEntity
- EK extends string | number | symbol
- Z extends CoreEntity
Parameters
- entity: E
- field: EK
Returns Promise<PopulatedResult<E, EK, Z>>
Implementation of IDataBase.populate

Inherited from CoreDBCon.populate
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:771

populateMany

populateMany<
    E extends CoreEntity,
    EK extends string | number | symbol,
    Z extends CoreEntity,
>(
    entity: E[],
    field: EK,
): Promise<PopulatedResult<E, EK, Z>[]>
Type Parameters
- E extends CoreEntity
- EK extends string | number | symbol
- Z extends CoreEntity
Parameters
- entity: E[]
- field: EK
Returns Promise<PopulatedResult<E, EK, Z>[]>
Implementation of IDataBase.populateMany

Inherited from CoreDBCon.populateMany
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:772

queryScript

queryScript<E>(query: RawQuery): Promise<RawQueryResult<E, QueryResultBase>>
Type Parameters
- E
Parameters
- query: RawQuery
Returns Promise<RawQueryResult<E, QueryResultBase>>
Implementation of IDataBase.queryScript

Overrides CoreDBCon.queryScript
- Defined in src/class/PGCon.ts:446

registerEntity

registerEntity<E extends CoreEntity>(
ent: E,
noCache?: boolean,
): CoreEntityWrapper<E>
Type Parameters
- E extends CoreEntity
Parameters
- ent: E
- OptionalnoCache: boolean
Returns CoreEntityWrapper<E>
Implementation of IDataBase.registerEntity

Inherited from CoreDBCon.registerEntity
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:686

removeConfig

removeConfig(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
Implementation of IDataBase.removeConfig

Overrides CoreDBCon.removeConfig
- Defined in src/class/PGCon.ts:307

runScripts

runScripts(...list: RawQuery[]): Promise<QueryResult<any>[]>
Parameters
- ...list: RawQuery[]
Returns Promise<QueryResult<any>[]>
Implementation of IDataBase.runScripts

Overrides CoreDBCon.runScripts
- Defined in src/class/PGCon.ts:430

setConfig

setConfig(key: string, value: string): Promise<boolean>
Parameters
- key: string
- value: string
Returns Promise<boolean>
Implementation of IDataBase.setConfig

Overrides CoreDBCon.setConfig
- Defined in src/class/PGCon.ts:404

setConnected

setConnected(): void
Returns void
Implementation of IDataBase.setConnected

Inherited from CoreDBCon.setConnected
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:697

setEntityCache

setEntityCache(status: boolean): void
Parameters
- status: boolean
Returns void
Inherited from CoreDBCon.setEntityCache
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:685

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from CoreDBCon.setLogger
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:219

`Protected`setNew

setNew(val: boolean): void
trigger the db init
Parameters
- val: boolean
Returns void
Inherited from CoreDBCon.setNew
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:781

setUpdateChain

setUpdateChain(...chain: IBaseDBUpdate[]): void
Parameters
- ...chain: IBaseDBUpdate[]
Returns void
Implementation of IDataBase.setUpdateChain

Inherited from CoreDBCon.setUpdateChain
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:692

start

start(): Promise<void>
Returns Promise<void>
Implementation of IDataBase.start

Inherited from CoreDBCon.start
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:698

transformEntityKeys

transformEntityKeys<E extends CoreEntity>(entity: E): string
Type Parameters
- E extends CoreEntity
Parameters
- entity: E
Returns string
- Defined in src/class/PGCon.ts:280

update

update(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.update

Inherited from CoreDBCon.update
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:695

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>
Implementation of IDataBase.updateBulkEntity

Overrides CoreDBCon.updateBulkEntity
- Defined in src/class/PGCon.ts:108

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>
Implementation of IDataBase.updateEntity

Overrides CoreDBCon.updateEntity
- Defined in src/class/PGCon.ts:91

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IDataBase.verbose

Inherited from CoreDBCon.verbose
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:225

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IDataBase.warn

Inherited from CoreDBCon.warn
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:224

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

Implements

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Protectedchannel

db

dbVersion

logger

printLog

schemaName

updater

Methods

canUpdate

Returns Promise<boolean>

configExist

Parameters

Returns Promise<boolean>

connect

Returns Promise<boolean>

countEntity

Type Parameters

Parameters

Returns Promise<number>

createEntity

Type Parameters

Parameters

Returns Promise<E>

debug

Parameters

Returns void

deleteEntityBulkById

Parameters

Returns Promise<boolean>

deleteEntityById

Parameters

Returns Promise<boolean>

disconnect

Returns Promise<boolean>

error

Parameters

Returns void

findEntity

Type Parameters

Parameters

Returns Promise<E | null>

getCache

Returns C | null

getCClient

Type Parameters

Returns X

getConfig

Parameters

Returns Promise<ConfigType | undefined>

getConfigStore

Returns IStore

getCurrenDBVersion

Returns Promise<string>

getEntityBulkById

Type Parameters

Parameters

Returns Promise<E[]>

getEntityById

Type Parameters

Parameters

Returns Promise<E | null>

getEntityList

Type Parameters

Parameters

Returns Promise<E[]>

`Protected`channel

`Protected`setNew