Class CoreDb

CoreDb handles the storage, retrieval, and deletion of cryptographic keys (GKey entities) within the underlying database.

Implements

ICoreDb

Param: db

The CoreDBCon instance that this CoreDb wraps.

Method

initPrefabDB

Returns

Description

Generates a seed and a unique identifier, then stores them in the configuration. This method is called to initialize the prefab database.

Method

deleteKey

Param: e_id

The identifier of the GKey to delete.

Returns

Description

Removes the GKey identified by e_id from the database.

Method

getKey

Param: e_id

The identifier of the GKey to retrieve.

Returns

Description

Retrieves a GKey object by its identifier. Returns null if no matching key is found.

Method

setKey

Param: secret

The secret key value.

Param: iv

The initialization vector.

Param: auth

The authentication data.

Returns

Description

Creates a new GKey entry with the provided parameters and returns the newly generated identifier.

Hierarchy (View Summary)

CoreDBPrefab<any>
- CoreDb

Implements

ICoreDb

Constructors

constructor

new CoreDb(db: CoreDBCon<any, any>): CoreDb
Parameters
- db: CoreDBCon<any, any>
Returns CoreDb
Overrides CoreDBPrefab.constructor
- Defined in database/CoreDb.ts:47

Properties

`Protected`channel

channel: string

db

db: any

logger

logger: CoreLogger | null

Methods

canUpdate

canUpdate(): Promise<boolean>
Returns Promise<boolean>
Implementation of ICoreDb.canUpdate
Inherited from CoreDBPrefab.canUpdate
- Defined in classes/CoreDBPrefab.ts:72

configExist

configExist(key: string): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Implementation of ICoreDb.configExist
Inherited from CoreDBPrefab.configExist
- Defined in classes/CoreDBPrefab.ts:119

connect

connect(): Promise<boolean>
Returns Promise<boolean>
Implementation of ICoreDb.connect
Inherited from CoreDBPrefab.connect
- Defined in classes/CoreDBPrefab.ts:103

createEntity

createEntity<E extends CoreEntity>(
config: EntityConfig<E>,
entity: E,
): Promise<E>
Create new Entity object
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- entity: E
Returns Promise<E>
Implementation of ICoreDb.createEntity
Inherited from CoreDBPrefab.createEntity
- Defined in classes/CoreDBPrefab.ts:141

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of ICoreDb.debug
Inherited from CoreDBPrefab.debug
- Defined in classes/CoreLogChannel.ts:41

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 ICoreDb.deleteEntityBulkById
Inherited from CoreDBPrefab.deleteEntityBulkById
- Defined in classes/CoreDBPrefab.ts:214

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 ICoreDb.deleteEntityById
Inherited from CoreDBPrefab.deleteEntityById
- Defined in classes/CoreDBPrefab.ts:205

deleteKey

deleteKey(e_id: string): Promise<void>
Parameters
- e_id: string
Returns Promise<void>
Implementation of ICoreDb.deleteKey
- Defined in database/CoreDb.ts:58

disconnect

disconnect(): Promise<boolean>
Returns Promise<boolean>
Implementation of ICoreDb.disconnect
Inherited from CoreDBPrefab.disconnect
- Defined in classes/CoreDBPrefab.ts:99

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of ICoreDb.error
Inherited from CoreDBPrefab.error
- Defined in classes/CoreLogChannel.ts:53

execScripts

execScripts(list: RawQuery[]): Promise<any[]>
Parameters
- list: RawQuery[]
Returns Promise<any[]>
Implementation of ICoreDb.execScripts
Inherited from CoreDBPrefab.execScripts
- Defined in classes/CoreDBPrefab.ts:107

findEntity

findEntity<E extends CoreEntity>(
config: EntityConfig<E>,
search: { [P in string | number | symbol]?: E[P] },
): Promise<E | null>
Get Entity object list
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- search: { [P in string | number | symbol]?: E[P] }
Returns Promise<E | null>
Implementation of ICoreDb.findEntity
Inherited from CoreDBPrefab.findEntity
- Defined in classes/CoreDBPrefab.ts:233

getCache

getCache(): any
Returns any
Implementation of ICoreDb.getCache
Inherited from CoreDBPrefab.getCache
- Defined in classes/CoreDBPrefab.ts:254

getCClient

getCClient<X extends ICoreCClient>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from CoreDBPrefab.getCClient
- Defined in classes/CoreElement.ts:61

getConfig

getConfig(key: string): Promise<ConfigType | undefined>
Parameters
- key: string
Returns Promise<ConfigType | undefined>
Implementation of ICoreDb.getConfig
Inherited from CoreDBPrefab.getConfig
- Defined in classes/CoreDBPrefab.ts:111

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from CoreDBPrefab.getConfigStore
- Defined in classes/CoreElement.ts:57

getCurrenDBVersion

getCurrenDBVersion(): Promise<string>
Returns Promise<string>
Implementation of ICoreDb.getCurrenDBVersion
Inherited from CoreDBPrefab.getCurrenDBVersion
- Defined in classes/CoreDBPrefab.ts:76

getEntityBulkById

getEntityBulkById<E extends CoreEntity>(
config: EntityConfig<E>,
id: string[],
): Promise<E[]>
Get Entity objects by ID
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- id: string[]
Returns Promise<E[]>
Implementation of ICoreDb.getEntityBulkById
Inherited from CoreDBPrefab.getEntityBulkById
- Defined in classes/CoreDBPrefab.ts:193

getEntityById

getEntityById<E extends CoreEntity>(
config: EntityConfig<E>,
id: string,
): Promise<E | null>
Get Entity object by ID
Type Parameters
- E extends CoreEntity
Parameters
- config: EntityConfig<E>
- id: string
Returns Promise<E | null>
Implementation of ICoreDb.getEntityById
Inherited from CoreDBPrefab.getEntityById
- Defined in classes/CoreDBPrefab.ts:181

getEntityList

getEntityList<E extends CoreEntity>(query: QueryInterface<E>): Promise<E[]>
Get Entity object list
Type Parameters
- E extends CoreEntity
Parameters
- query: QueryInterface<E>
Returns Promise<E[]>
Implementation of ICoreDb.getEntityList
Inherited from CoreDBPrefab.getEntityList
- Defined in classes/CoreDBPrefab.ts:222

getEntityMeta

getEntityMeta(): { key: string; meta: ColumnPropMap<any> }[]
Returns { key: string; meta: ColumnPropMap<any> }[]
Implementation of ICoreDb.getEntityMeta
Inherited from CoreDBPrefab.getEntityMeta
- Defined in classes/CoreDBPrefab.ts:46

getEntityWrapper

getEntityWrapper<E extends CoreEntity>(
className: string,
): CoreEntityWrapper<E> | undefined
Type Parameters
- E extends CoreEntity
Parameters
- className: string
Returns CoreEntityWrapper<E> | undefined
Inherited from CoreDBPrefab.getEntityWrapper
- Defined in classes/CoreDBPrefab.ts:62

getKernel

getKernel(): ICoreKernel
Returns ICoreKernel
Inherited from CoreDBPrefab.getKernel
- Defined in classes/CoreElement.ts:49

getKey

getKey(e_id: string): Promise<GKey | null>
Parameters
- e_id: string
Returns Promise<GKey | null>
Implementation of ICoreDb.getKey
- Defined in database/CoreDb.ts:62

getModule

getModule(): ICoreKernelModule<
    ICoreKernel<any, ICoreAnyModule>,
    any,
    any,
    any,
    any,
>
Returns ICoreKernelModule<ICoreKernel<any, ICoreAnyModule>, any, any, any, any>
Inherited from CoreDBPrefab.getModule
- Defined in classes/CoreElement.ts:53

getName

getName(): string
Returns string
Implementation of ICoreDb.getName
Inherited from CoreDBPrefab.getName
- Defined in classes/CoreLogChannel.ts:75

getPrefabDB

getPrefabDB(): any
Returns any
Inherited from CoreDBPrefab.getPrefabDB
- Defined in classes/CoreDBPrefab.ts:50

getRawDBObject

getRawDBObject(): Promise<unknown>
Returns Promise<unknown>
Implementation of ICoreDb.getRawDBObject
Inherited from CoreDBPrefab.getRawDBObject
- Defined in classes/CoreDBPrefab.ts:127

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of ICoreDb.info
Inherited from CoreDBPrefab.info
- Defined in classes/CoreLogChannel.ts:47

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 ICoreDb.initEntity
Inherited from CoreDBPrefab.initEntity
- Defined in classes/CoreDBPrefab.ts:247

initNewDB

initNewDB(): Promise<void>
Returns Promise<void>
Implementation of ICoreDb.initNewDB
Inherited from CoreDBPrefab.initNewDB
- Defined in classes/CoreDBPrefab.ts:131

initPrefabDB

initPrefabDB(): Promise<void>
Returns Promise<void>
Overrides CoreDBPrefab.initPrefabDB
- Defined in database/CoreDb.ts:52

isConnected

isConnected(): boolean
Returns boolean
Implementation of ICoreDb.isConnected
Inherited from CoreDBPrefab.isConnected
- Defined in classes/CoreDBPrefab.ts:84

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Implementation of ICoreDb.lError
Inherited from CoreDBPrefab.lError
- Defined in classes/CoreLogChannel.ts:71

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of ICoreDb.log
Inherited from CoreDBPrefab.log
- Defined in classes/CoreLogChannel.ts:35

registerEntity

registerEntity<E extends CoreEntity>(ent: E): CoreEntityWrapper<E>
Type Parameters
- E extends CoreEntity
Parameters
- ent: E
Returns CoreEntityWrapper<E>
Inherited from CoreDBPrefab.registerEntity
- Defined in classes/CoreDBPrefab.ts:58

removeConfig

removeConfig(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
Implementation of ICoreDb.removeConfig
Inherited from CoreDBPrefab.removeConfig
- Defined in classes/CoreDBPrefab.ts:123

setConfig

setConfig(key: string, value: string): Promise<boolean>
Parameters
- key: string
- value: string
Returns Promise<boolean>
Implementation of ICoreDb.setConfig
Inherited from CoreDBPrefab.setConfig
- Defined in classes/CoreDBPrefab.ts:115

setConnected

setConnected(): void
Returns void
Implementation of ICoreDb.setConnected
Inherited from CoreDBPrefab.setConnected
- Defined in classes/CoreDBPrefab.ts:88

setEntityCache

setEntityCache(status: boolean): void
Parameters
- status: boolean
Returns void
Inherited from CoreDBPrefab.setEntityCache
- Defined in classes/CoreDBPrefab.ts:54

setKey

setKey(secret: string, iv: Buffer, auth: Buffer): Promise<string>
Parameters
- secret: string
- iv: Buffer
- auth: Buffer
Returns Promise<string>
Implementation of ICoreDb.setKey
- Defined in database/CoreDb.ts:66

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from CoreDBPrefab.setLogger
- Defined in classes/CoreLogChannel.ts:31

setUpdateChain

setUpdateChain(...chain: IBaseDBUpdate[]): void
Parameters
- ...chain: IBaseDBUpdate[]
Returns void
Implementation of ICoreDb.setUpdateChain
Inherited from CoreDBPrefab.setUpdateChain
- Defined in classes/CoreDBPrefab.ts:68

start

start(): Promise<void>
Returns Promise<void>
Implementation of ICoreDb.start
Inherited from CoreDBPrefab.start
- Defined in classes/CoreDBPrefab.ts:92

update

update(): Promise<boolean>
Returns Promise<boolean>
Implementation of ICoreDb.update
Inherited from CoreDBPrefab.update
- Defined in classes/CoreDBPrefab.ts:80

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 ICoreDb.updateBulkEntity
Inherited from CoreDBPrefab.updateBulkEntity
- Defined in classes/CoreDBPrefab.ts:168

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 ICoreDb.updateEntity
Inherited from CoreDBPrefab.updateEntity
- Defined in classes/CoreDBPrefab.ts:154

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of ICoreDb.verbose
Inherited from CoreDBPrefab.verbose
- Defined in classes/CoreLogChannel.ts:65

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of ICoreDb.warn
Inherited from CoreDBPrefab.warn
- Defined in classes/CoreLogChannel.ts:59

Class CoreDb

Implements

Param: db

Method

Returns

Description

Method

Param: e_id

Returns

Description

Method

Param: e_id

Returns

Description

Method

Param: secret

Param: iv

Param: auth

Returns

Description

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CoreDb

Properties

Protectedchannel

db

logger

Methods

canUpdate

Returns Promise<boolean>

configExist

Parameters

Returns Promise<boolean>

connect

Returns Promise<boolean>

createEntity

Type Parameters

Parameters

Returns Promise<E>

debug

Parameters

Returns void

deleteEntityBulkById

Parameters

Returns Promise<boolean>

deleteEntityById

Parameters

Returns Promise<boolean>

deleteKey

Parameters

Returns Promise<void>

disconnect

Returns Promise<boolean>

error

Parameters

Returns void

execScripts

Parameters

Returns Promise<any[]>

findEntity

Type Parameters

Parameters

Returns Promise<E | null>

getCache

Returns any

getCClient

Type Parameters

Returns X

getConfig

Parameters

Returns Promise<ConfigType | undefined>

getConfigStore

Returns IStore

`Protected`channel