Interface ICoreDb

Don't use this interface use {IDataBase} instead

See

IDataBase

Hierarchy

IDataBase<any, any>
- ICoreDb

Implemented by

CoreDb

Methods

canUpdate

canUpdate(): Promise<boolean>
Returns Promise<boolean>
Inherited from IDataBase.canUpdate
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:191

configExist

configExist(key): Promise<boolean>
Parameters
- key: string
Returns Promise<boolean>
Inherited from IDataBase.configExist
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:186

connect

connect(): Promise<boolean>
Returns Promise<boolean>
Inherited from IDataBase.connect
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:205

createEntity

createEntity<E>(config, entity): Promise<E>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- entity: EProperties<E>
Returns Promise<E>
Inherited from IDataBase.createEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:19

debug

debug(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from IDataBase.debug
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:158

deleteEntityById

deleteEntityById(className, e_id): Promise<boolean>
Parameters
- className: string
- e_id: string
Returns Promise<boolean>
Inherited from IDataBase.deleteEntityById
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:22

deleteKey

deleteKey(e_id): Promise<void>
Parameters
- e_id: string
Returns Promise<void>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:10

disconnect

disconnect(): Promise<boolean>
Returns Promise<boolean>
Inherited from IDataBase.disconnect
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:203

error

error(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from IDataBase.error
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:160

execScripts

execScripts(list): Promise<null | any[]>
Parameters
- list: RawQuery[]
Returns Promise<null | any[]>
Inherited from IDataBase.execScripts
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:190

findEntity

findEntity<E>(config, search): Promise<null | E>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- search: {
  [P in string | number | symbol]?: E[P]
  }
Returns Promise<null | E>
Inherited from IDataBase.findEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:24

getCache

getCache(): any
Returns any
Inherited from IDataBase.getCache
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:18

getConfig

getConfig(key): Promise<undefined | ConfigType>
Parameters
- key: string
Returns Promise<undefined | ConfigType>
Inherited from IDataBase.getConfig
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:189

getCurrenDBVersion

getCurrenDBVersion(): Promise<string>
Returns Promise<string>
Inherited from IDataBase.getCurrenDBVersion
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:192

getEntityById

getEntityById<E>(config, e_id): Promise<null | E>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- e_id: string
Returns Promise<null | E>
Inherited from IDataBase.getEntityById
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:21

getEntityList

getEntityList<E>(query): Promise<E[]>
Type Parameters
- E extends IEntity
Parameters
- query: QueryInterface<E>
Returns Promise<E[]>
Inherited from IDataBase.getEntityList
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:23

getEntityMeta

getEntityMeta(): ICoreEntityMetaInterface[]
Returns ICoreEntityMetaInterface[]
Inherited from IDataBase.getEntityMeta
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:17

getKey

getKey(e_id): Promise<null | GKey>
Parameters
- e_id: string
Returns Promise<null | GKey>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:8

getName

getName(): string
Returns string
Inherited from IDataBase.getName
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:164

getRawDBObject

getRawDBObject(): any
Returns any
Inherited from IDataBase.getRawDBObject
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:185

info

info(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from IDataBase.info
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:159

initEntity

initEntity<E>(className, entity): Promise<boolean>
Type Parameters
- E extends IEntity
Parameters
- className: string
- entity: E
Returns Promise<boolean>
Inherited from IDataBase.initEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:27

initNewDB

initNewDB(): Promise<void>
Returns Promise<void>
Inherited from IDataBase.initNewDB
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:184

isConnected

isConnected(): boolean
Returns boolean
Inherited from IDataBase.isConnected
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:202

lError

lError(message): Error
Parameters
- message: string
Returns Error
Inherited from IDataBase.lError
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:163

log

log(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from IDataBase.log
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:157

removeConfig

removeConfig(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Inherited from IDataBase.removeConfig
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:188

setConfig

setConfig(key, value): Promise<boolean>
Parameters
- key: string
- value: string
Returns Promise<boolean>
Inherited from IDataBase.setConfig
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:187

setConnected

setConnected(): void
Returns void
Inherited from IDataBase.setConnected
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:204

setKey

setKey(secret, iv, auth): Promise<string>
Parameters
- secret: string
- iv: Buffer
- auth: Buffer
Returns Promise<string>
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:9

setUpdateChain

setUpdateChain(chain): void
Parameters
- chain: IBaseDBUpdate
Returns void
Inherited from IDataBase.setUpdateChain
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:200

start

start(): Promise<void>
Returns Promise<void>
Inherited from IDataBase.start
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:201

update

update(): Promise<boolean>
Returns Promise<boolean>
Inherited from IDataBase.update
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:193

updateEntity

updateEntity<E>(config, e_id, entity): Promise<boolean>
Type Parameters
- E extends IEntity
Parameters
- config: EntityConfig<E>
- e_id: string
- entity: Partial<EProperties<E>>
Returns Promise<boolean>
Inherited from IDataBase.updateEntity
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:20

verbose

verbose(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from IDataBase.verbose
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:162

warn

warn(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Inherited from IDataBase.warn
- Defined in node_modules/@grandlinex/core/dist/cjs/lib/index.d.ts:161

Generated using TypeDoc