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

Don't use this interface use {IDataBase} instead

See

IDataBase

Type Parameters

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

Hierarchy

BaseElement<K, X, P, C, Y>
- CoreDBCon
  - InMemDB

Implements

IDataBase<D, T>

Constructors

`Protected` constructor

new CoreDBCon<D, T, K, X, P, C, Y>(dbVersion, schemaName, module): CoreDBCon<D, T, K, X, P, C, Y>
Type Parameters
- D
- T
- K extends ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>
- X 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
- Y extends null | ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any
Parameters
- dbVersion: string
- schemaName: string
- module: ICoreKernelModule<K, X, P, C, Y>
Returns CoreDBCon<D, T, K, X, P, C, Y>
Overrides BaseElement.constructor
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:14

Properties

`Private` cacheEnabled

cacheEnabled: any

`Protected` channel

channel: string

`Private` connected

connected: any

dbVersion

dbVersion: string

`Private` isNew

isNew: any

logger

logger: null | CoreLogger

schemaName

schemaName: string

updater

updater: null | IBaseDBUpdate

`Private` wrapperMap

wrapperMap: any

Methods

canUpdate

canUpdate(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.canUpdate
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:23

`Abstract` configExist

configExist(key): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Implementation of IDataBase.configExist
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:34

`Abstract` connect

connect(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.connect
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:30

`Abstract` 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>
Implementation of IDataBase.createEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:43

debug

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

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

`Abstract` deleteEntityById

deleteEntityById(className, e_id): Promise<boolean>
Delete Entity object by ID
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
Implementation of IDataBase.deleteEntityById
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:62

`Abstract` disconnect

disconnect(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.disconnect
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:29

error

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

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

`Abstract` execScripts

execScripts(list): Promise<T[]>
Parameters
- list: RawQuery[]
Returns Promise<T[]>
Implementation of IDataBase.execScripts
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:31

`Abstract` findEntity

findEntity<E>(config, search): Promise<null | E>
Get Entity object list
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- search: {
  [B in string | number | symbol]?: E[B]
  }
Returns Promise<null | E>
Implementation of IDataBase.findEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:73

getCClient

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

getCache

getCache(): null | C
Returns null | C
Implementation of IDataBase.getCache
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:82

`Abstract` getConfig

getConfig(key): Promise<undefined | ConfigType>
Parameters
- key: string
Returns Promise<undefined | ConfigType>
Implementation of IDataBase.getConfig
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:32

getConfigStore

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

getCurrenDBVersion

getCurrenDBVersion(): Promise<string>
Returns Promise<string>
Implementation of IDataBase.getCurrenDBVersion
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:24

`Abstract` getEntityById

getEntityById<E>(config, e_id): Promise<null | E>
Get Entity object by ID
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- e_id: string
Returns Promise<null | E>
Implementation of IDataBase.getEntityById
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:56

`Abstract` getEntityList

getEntityList<E>(query): Promise<E[]>
Get Entity object list
Type Parameters
- E extends CoreEntity
Parameters
- query: QueryInterface<E>
  
  search query config
Returns Promise<E[]>
Implementation of IDataBase.getEntityList
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:67

getEntityMeta

getEntityMeta(): {
key: string;
meta: ColumnPropMap<any>;
}[]
Returns {
key: string;
meta: ColumnPropMap<any>;
}[]
Implementation of IDataBase.getEntityMeta
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:18

getEntityWrapper

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

getKernel

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

getModule

getModule(): ICoreKernelModule<K, X, P, C, Y>
Returns ICoreKernelModule<K, X, P, C, Y>
Inherited from BaseElement.getModule
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreElement.d.ts:7

getName

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

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

getNew

getNew(): boolean
get the db trigger value

Returns boolean
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:86

`Abstract` getRawDBObject

getRawDBObject(): null | D
Returns null | D
Implementation of IDataBase.getRawDBObject
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:36

info

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

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

`Abstract` initEntity

initEntity<E>(className, entity): Promise<boolean>
Init Entity object list
Type Parameters
- E extends CoreEntity
Parameters
- className: string
- entity: E
Returns Promise<boolean>
Implementation of IDataBase.initEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:81

`Abstract` initNewDB

initNewDB(): Promise<void>
Returns Promise<void>
Implementation of IDataBase.initNewDB
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:37

isConnected

isConnected(): boolean
Returns boolean
Implementation of IDataBase.isConnected
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:26

lError

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

Inherited from BaseElement.lError
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreLogChannel.d.ts:14

log

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

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

registerEntity

registerEntity<E>(ent): CoreEntityWrapper<E>
Type Parameters
- E extends CoreEntity
Parameters
- ent: E
Returns CoreEntityWrapper<E>
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:16

`Abstract` removeConfig

removeConfig(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Implementation of IDataBase.removeConfig
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:35

`Abstract` setConfig

setConfig(key, value): Promise<boolean>
Parameters
- key: string
- value: string
Returns Promise<boolean>
Implementation of IDataBase.setConfig
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:33

setConnected

setConnected(): void
Returns void
Implementation of IDataBase.setConnected
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:27

setEntityCache

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

setLogger

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

`Protected` setNew

setNew(val): void
trigger the db init
Parameters
- val: boolean
Returns void
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:90

setUpdateChain

setUpdateChain(...chain): void
Parameters
- Rest ...chain: IBaseDBUpdate[]
Returns void
Implementation of IDataBase.setUpdateChain
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:22

start

start(): Promise<void>
Returns Promise<void>
Implementation of IDataBase.start
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:28

update

update(): Promise<boolean>
Returns Promise<boolean>
Implementation of IDataBase.update
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:25

`Abstract` 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>
Implementation of IDataBase.updateEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/classes/CoreDBCon.d.ts:50

verbose

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

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

warn

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

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

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

See

Type Parameters

D

T

K extends ICoreKernel<any> = ICoreKernel<any>

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

P extends ICoreClient | null = any

C extends ICoreCache | null = any

Y extends ICorePresenter<any> | null = any

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

D

T

K extends ICoreKernel<any, ICoreAnyModule> = ICoreKernel<any, ICoreAnyModule>

X 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

Y extends null | ICorePresenter<any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any

Parameters

dbVersion: string

schemaName: string

module: ICoreKernelModule<K, X, P, C, Y>

Returns CoreDBCon<D, T, K, X, P, C, Y>

Properties

Private cacheEnabled

Protected channel

Private connected

dbVersion

Private isNew

logger

schemaName

updater

Private wrapperMap

Methods

canUpdate

Returns Promise<boolean>

Abstract configExist

Parameters

key: string

Returns Promise<boolean>

Abstract connect

Returns Promise<boolean>

Abstract createEntity

Type Parameters

E extends CoreEntity

Parameters

config: EntityConfig<E>

entity: E

Returns Promise<E>

debug

Parameters

Rest ...ags: unknown[]

Returns void

Abstract deleteEntityById

Parameters

className: string

e_id: string

Returns Promise<boolean>

Abstract disconnect

Returns Promise<boolean>

error

Parameters

Rest ...ags: unknown[]

Returns void

Abstract execScripts

Parameters

list: RawQuery[]

Returns Promise<T[]>

Abstract findEntity

Type Parameters

E extends CoreEntity

Parameters

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

`Protected` constructor

`Private` cacheEnabled

`Protected` channel

`Private` connected

`Private` isNew

`Private` wrapperMap

`Abstract` configExist

`Abstract` connect

`Abstract` createEntity

`Rest` ...ags: unknown[]

`Abstract` deleteEntityById

`Abstract` disconnect

`Rest` ...ags: unknown[]

`Abstract` execScripts

`Abstract` findEntity

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

`Abstract` getConfig

`Abstract` getEntityById

`Abstract` getEntityList

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

`Abstract` getRawDBObject

`Rest` ...ags: unknown[]

`Abstract` initEntity

`Abstract` initNewDB

`Rest` ...ags: unknown[]