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

Type Parameters

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

Hierarchy

default<PGDBType, QueryResult | null, K, T, P, C, X>
- PGCon

Implements

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

Constructors

constructor

new PGCon<K, T, P, C, X>(module: ICoreKernelModule<any, any, any, any, any>, dbversion: string): PGCon<K, T, P, C, X>
Type Parameters
- K extends ICoreKernel<any, ICoreAnyModule, K> = 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
Returns PGCon<K, T, P, C, X>
Overrides CoreDBCon<PGDBType, QueryResult | null, K, T, P, C, X>.constructor
- Defined in src/class/PGCon.ts:42

Properties

`Protected` channel

channel: string

db

db: null | Client

dbVersion

dbVersion: string

logger

logger: null | default

schemaName

schemaName: string

updater

updater: null | IBaseDBUpdate

Methods

canUpdate

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

Inherited from CoreDBCon.canUpdate
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:23

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:319

connect

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

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

createEntity

createEntity<E>(config: EntityConfig<E>, entity: EProperties<E>): Promise<E>
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- entity: EProperties<E>
Returns Promise<E>
Implementation of IDataBase.createEntity

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

debug

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

Inherited from CoreDBCon.debug
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:9

deleteEntityById

deleteEntityById(className: string, e_id: string): Promise<boolean>
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
Implementation of IDataBase.deleteEntityById

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

disconnect

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

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

error

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

Inherited from CoreDBCon.error
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:11

execScripts

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

Overrides CoreDBCon.execScripts
- Defined in src/class/PGCon.ts:363

findEntity

findEntity<E>(config: EntityConfig<E>, search: { [ D in string | number | symbol]?: E[D] }): Promise<null | E>
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- search: { [ D in string | number | symbol]?: E[D] }
Returns Promise<null | E>
Implementation of IDataBase.findEntity

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

getCClient

getCClient<X>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from CoreDBCon.getCClient
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:9

getCache

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

Inherited from CoreDBCon.getCache
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:82

getConfig

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

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

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from CoreDBCon.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:8

getCurrenDBVersion

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

Inherited from CoreDBCon.getCurrenDBVersion
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:24

getEntityById

getEntityById<E>(config: EntityConfig<E>, e_id: string): Promise<null | E>
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- e_id: string
Returns Promise<null | E>
Implementation of IDataBase.getEntityById

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

getEntityList

getEntityList<E>(q: QueryInterface<E>): Promise<E[]>
Type Parameters
- E extends default<E>
Parameters
- q: QueryInterface<E>
Returns Promise<E[]>
Implementation of IDataBase.getEntityList

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

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/mjs/classes/CoreDBCon.d.ts:18

getEntityWrapper

getEntityWrapper<E>(className: string): undefined | default<E>
Type Parameters
- E extends default<E>
Parameters
- className: string
Returns undefined | default<E>
Inherited from CoreDBCon.getEntityWrapper
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:17

getKernel

getKernel(): K
Returns K
Inherited from CoreDBCon.getKernel
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:6

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/mjs/classes/CoreElement.d.ts:7

getName

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

Inherited from CoreDBCon.getName
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:15

getNew

getNew(): boolean
get the db trigger value

Returns boolean
Inherited from CoreDBCon.getNew
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:86

getRawDBObject

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

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

info

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

Inherited from CoreDBCon.info
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:10

initEntity

initEntity<E>(className: string, entity: E): Promise<boolean>
Type Parameters
- E extends default<E>
Parameters
- className: string
- entity: E
Returns Promise<boolean>
Implementation of IDataBase.initEntity

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

initNewDB

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

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

isConnected

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

Inherited from CoreDBCon.isConnected
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:26

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/mjs/classes/CoreLogChannel.d.ts:14

log

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

Inherited from CoreDBCon.log
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:8

registerEntity

registerEntity<E>(ent: E): default<E>
Type Parameters
- E extends default<E>
Parameters
- ent: E
Returns default<E>
Inherited from CoreDBCon.registerEntity
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:16

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:232

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:331

setConnected

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

Inherited from CoreDBCon.setConnected
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:27

setEntityCache

setEntityCache(status: boolean): void
Parameters
- status: boolean
Returns void
Inherited from CoreDBCon.setEntityCache
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:15

setLogger

setLogger(logger: default): void
Parameters
- logger: default
Returns void
Inherited from CoreDBCon.setLogger
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:7

`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/mjs/classes/CoreDBCon.d.ts:90

setUpdateChain

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

Inherited from CoreDBCon.setUpdateChain
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:22

start

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

Inherited from CoreDBCon.start
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:28

transformEntityKeys

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

update

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

Inherited from CoreDBCon.update
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreDBCon.d.ts:25

updateEntity

updateEntity<E>(config: EntityConfig<E>, e_id: string, entity: Partial<EProperties<E>>): Promise<boolean>
Type Parameters
- E extends default<E>
Parameters
- config: EntityConfig<E>
- e_id: string
- entity: Partial<EProperties<E>>
Returns Promise<boolean>
Implementation of IDataBase.updateEntity

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

verbose

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

Inherited from CoreDBCon.verbose
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:13

warn

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

Inherited from CoreDBCon.warn
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:12

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

Type Parameters

K extends ICoreKernel<any> = ICoreKernel<any>

T extends IDataBase<any, any> | null = any

P extends ICoreClient | null = any

C extends ICoreCache | null = any

X extends ICorePresenter<any> | null = any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

K extends ICoreKernel<any, ICoreAnyModule, K> = 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

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

Properties

Protected channel

db

dbVersion

logger

schemaName

updater

Methods

canUpdate

Returns Promise<boolean>

configExist

Parameters

key: string

Returns Promise<boolean>

connect

Returns Promise<boolean>

createEntity

Type Parameters

E extends default<E>

Parameters

config: EntityConfig<E>

entity: EProperties<E>

Returns Promise<E>

debug

Parameters

Rest ...ags: unknown[]

Returns void

deleteEntityById

Parameters

className: string

e_id: string

Returns Promise<boolean>

disconnect

Returns Promise<boolean>

error

Parameters

Rest ...ags: unknown[]

Returns void

execScripts

Parameters

list: RawQuery[]

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

findEntity

Type Parameters

E extends default<E>

Parameters

config: EntityConfig<E>

search: { [ D in string | number | symbol]?: E[D] }

Returns Promise<null | E>

getCClient

Type Parameters

X extends ICoreCClient

Returns X

getCache

Returns null | C

`Protected` channel

`Rest` ...ags: unknown[]

`Rest` ...ags: unknown[]

Returns {
key: string;
meta: ColumnPropMap<any>;
}[]

`Rest` ...ags: unknown[]

`Rest` ...ags: unknown[]