@grandlinex/kernel
Preparing search index...
ICoreDb
Interface ICoreDb
Don't use this interface use {IDataBase} instead
See
IDataBase
interface
ICoreDb
{
canUpdate
()
:
Promise
<
boolean
>
;
configExist
(
key
:
string
)
:
Promise
<
boolean
>
;
connect
()
:
Promise
<
boolean
>
;
createEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
entity
:
EProperties
<
E
>
,
)
:
Promise
<
E
>
;
debug
(
...
ags
:
unknown
[]
)
:
void
;
deleteEntityBulkById
(
className
:
string
,
e_id
:
string
[]
)
:
Promise
<
boolean
>
;
deleteEntityById
(
className
:
string
,
e_id
:
string
)
:
Promise
<
boolean
>
;
deleteKey
(
e_id
:
string
)
:
Promise
<
void
>
;
disconnect
()
:
Promise
<
boolean
>
;
error
(
...
ags
:
unknown
[]
)
:
void
;
execScripts
(
list
:
RawQuery
[]
)
:
Promise
<
null
|
any
[]
>
;
findEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
search
:
QInterfaceSearch
<
E
>
,
)
:
Promise
<
null
|
E
>
;
getCache
()
:
any
;
getConfig
(
key
:
string
)
:
Promise
<
undefined
|
ConfigType
>
;
getCurrenDBVersion
()
:
Promise
<
string
>
;
getEntityBulkById
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
[]
,
)
:
Promise
<
E
[]
>
;
getEntityById
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
,
)
:
Promise
<
null
|
E
>
;
getEntityList
<
E
extends
IEntity
>
(
query
:
QueryInterface
<
E
>
)
:
Promise
<
E
[]
>
;
getEntityMeta
()
:
ICoreEntityMetaInterface
[]
;
getKey
(
e_id
:
string
)
:
Promise
<
null
|
GKey
>
;
getName
()
:
string
;
getRawDBObject
()
:
any
;
info
(
...
ags
:
unknown
[]
)
:
void
;
initEntity
<
E
extends
IEntity
>
(
className
:
string
,
entity
:
E
,
)
:
Promise
<
boolean
>
;
initNewDB
()
:
Promise
<
void
>
;
isConnected
()
:
boolean
;
lError
(
message
:
string
)
:
Error
;
log
(
...
ags
:
unknown
[]
)
:
void
;
removeConfig
(
key
:
string
)
:
Promise
<
void
>
;
setConfig
(
key
:
string
,
value
:
string
)
:
Promise
<
boolean
>
;
setConnected
()
:
void
;
setKey
(
secret
:
string
,
iv
:
Buffer
,
auth
:
Buffer
)
:
Promise
<
string
>
;
setUpdateChain
(
chain
:
IBaseDBUpdate
)
:
void
;
start
()
:
Promise
<
void
>
;
update
()
:
Promise
<
boolean
>
;
updateBulkEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
[]
,
entity
:
EUpDateProperties
<
E
>
,
)
:
Promise
<
boolean
>
;
updateEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
,
entity
:
EUpDateProperties
<
E
>
,
)
:
Promise
<
boolean
>
;
verbose
(
...
ags
:
unknown
[]
)
:
void
;
warn
(
...
ags
:
unknown
[]
)
:
void
;
}
Hierarchy (
View Summary
)
IDataBase
<
any
,
any
>
ICoreDb
Implemented by
CoreDb
Index
Methods
can
Update
config
Exist
connect
create
Entity
debug
delete
Entity
Bulk
By
Id
delete
Entity
By
Id
delete
Key
disconnect
error
exec
Scripts
find
Entity
get
Cache
get
Config
get
Curren
DB
Version
get
Entity
Bulk
By
Id
get
Entity
By
Id
get
Entity
List
get
Entity
Meta
get
Key
get
Name
get
Raw
DB
Object
info
init
Entity
init
New
DB
is
Connected
l
Error
log
remove
Config
set
Config
set
Connected
set
Key
set
Update
Chain
start
update
update
Bulk
Entity
update
Entity
verbose
warn
Methods
can
Update
canUpdate
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
config
Exist
configExist
(
key
:
string
)
:
Promise
<
boolean
>
Parameters
key
:
string
Returns
Promise
<
boolean
>
connect
connect
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
create
Entity
createEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
entity
:
EProperties
<
E
>
,
)
:
Promise
<
E
>
Type Parameters
E
extends
IEntity
Parameters
config
:
EntityConfig
<
E
>
entity
:
EProperties
<
E
>
Returns
Promise
<
E
>
debug
debug
(
...
ags
:
unknown
[]
)
:
void
Parameters
...
ags
:
unknown
[]
Returns
void
delete
Entity
Bulk
By
Id
deleteEntityBulkById
(
className
:
string
,
e_id
:
string
[]
)
:
Promise
<
boolean
>
Parameters
className
:
string
e_id
:
string
[]
Returns
Promise
<
boolean
>
delete
Entity
By
Id
deleteEntityById
(
className
:
string
,
e_id
:
string
)
:
Promise
<
boolean
>
Parameters
className
:
string
e_id
:
string
Returns
Promise
<
boolean
>
delete
Key
deleteKey
(
e_id
:
string
)
:
Promise
<
void
>
Parameters
e_id
:
string
Returns
Promise
<
void
>
disconnect
disconnect
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
error
error
(
...
ags
:
unknown
[]
)
:
void
Parameters
...
ags
:
unknown
[]
Returns
void
exec
Scripts
execScripts
(
list
:
RawQuery
[]
)
:
Promise
<
null
|
any
[]
>
Parameters
list
:
RawQuery
[]
Returns
Promise
<
null
|
any
[]
>
find
Entity
findEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
search
:
QInterfaceSearch
<
E
>
,
)
:
Promise
<
null
|
E
>
Type Parameters
E
extends
IEntity
Parameters
config
:
EntityConfig
<
E
>
search
:
QInterfaceSearch
<
E
>
Returns
Promise
<
null
|
E
>
get
Cache
getCache
()
:
any
Returns
any
get
Config
getConfig
(
key
:
string
)
:
Promise
<
undefined
|
ConfigType
>
Parameters
key
:
string
Returns
Promise
<
undefined
|
ConfigType
>
get
Curren
DB
Version
getCurrenDBVersion
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Entity
Bulk
By
Id
getEntityBulkById
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
[]
,
)
:
Promise
<
E
[]
>
Type Parameters
E
extends
IEntity
Parameters
config
:
EntityConfig
<
E
>
e_id
:
string
[]
Returns
Promise
<
E
[]
>
get
Entity
By
Id
getEntityById
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
,
)
:
Promise
<
null
|
E
>
Type Parameters
E
extends
IEntity
Parameters
config
:
EntityConfig
<
E
>
e_id
:
string
Returns
Promise
<
null
|
E
>
get
Entity
List
getEntityList
<
E
extends
IEntity
>
(
query
:
QueryInterface
<
E
>
)
:
Promise
<
E
[]
>
Type Parameters
E
extends
IEntity
Parameters
query
:
QueryInterface
<
E
>
Returns
Promise
<
E
[]
>
get
Entity
Meta
getEntityMeta
()
:
ICoreEntityMetaInterface
[]
Returns
ICoreEntityMetaInterface
[]
get
Key
getKey
(
e_id
:
string
)
:
Promise
<
null
|
GKey
>
Parameters
e_id
:
string
Returns
Promise
<
null
|
GKey
>
get
Name
getName
()
:
string
Returns
string
get
Raw
DB
Object
getRawDBObject
()
:
any
Returns
any
info
info
(
...
ags
:
unknown
[]
)
:
void
Parameters
...
ags
:
unknown
[]
Returns
void
init
Entity
initEntity
<
E
extends
IEntity
>
(
className
:
string
,
entity
:
E
)
:
Promise
<
boolean
>
Type Parameters
E
extends
IEntity
Parameters
className
:
string
entity
:
E
Returns
Promise
<
boolean
>
init
New
DB
initNewDB
()
:
Promise
<
void
>
Returns
Promise
<
void
>
is
Connected
isConnected
()
:
boolean
Returns
boolean
l
Error
lError
(
message
:
string
)
:
Error
Parameters
message
:
string
Returns
Error
log
log
(
...
ags
:
unknown
[]
)
:
void
Parameters
...
ags
:
unknown
[]
Returns
void
remove
Config
removeConfig
(
key
:
string
)
:
Promise
<
void
>
Parameters
key
:
string
Returns
Promise
<
void
>
set
Config
setConfig
(
key
:
string
,
value
:
string
)
:
Promise
<
boolean
>
Parameters
key
:
string
value
:
string
Returns
Promise
<
boolean
>
set
Connected
setConnected
()
:
void
Returns
void
set
Key
setKey
(
secret
:
string
,
iv
:
Buffer
,
auth
:
Buffer
)
:
Promise
<
string
>
Parameters
secret
:
string
iv
:
Buffer
auth
:
Buffer
Returns
Promise
<
string
>
set
Update
Chain
setUpdateChain
(
chain
:
IBaseDBUpdate
)
:
void
Parameters
chain
:
IBaseDBUpdate
Returns
void
start
start
()
:
Promise
<
void
>
Returns
Promise
<
void
>
update
update
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
update
Bulk
Entity
updateBulkEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
[]
,
entity
:
EUpDateProperties
<
E
>
,
)
:
Promise
<
boolean
>
Type Parameters
E
extends
IEntity
Parameters
config
:
EntityConfig
<
E
>
e_id
:
string
[]
entity
:
EUpDateProperties
<
E
>
Returns
Promise
<
boolean
>
update
Entity
updateEntity
<
E
extends
IEntity
>
(
config
:
EntityConfig
<
E
>
,
e_id
:
string
,
entity
:
EUpDateProperties
<
E
>
,
)
:
Promise
<
boolean
>
Type Parameters
E
extends
IEntity
Parameters
config
:
EntityConfig
<
E
>
e_id
:
string
entity
:
EUpDateProperties
<
E
>
Returns
Promise
<
boolean
>
verbose
verbose
(
...
ags
:
unknown
[]
)
:
void
Parameters
...
ags
:
unknown
[]
Returns
void
warn
warn
(
...
ags
:
unknown
[]
)
:
void
Parameters
...
ags
:
unknown
[]
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
can
Update
config
Exist
connect
create
Entity
debug
delete
Entity
Bulk
By
Id
delete
Entity
By
Id
delete
Key
disconnect
error
exec
Scripts
find
Entity
get
Cache
get
Config
get
Curren
DB
Version
get
Entity
Bulk
By
Id
get
Entity
By
Id
get
Entity
List
get
Entity
Meta
get
Key
get
Name
get
Raw
DB
Object
info
init
Entity
init
New
DB
is
Connected
l
Error
log
remove
Config
set
Config
set
Connected
set
Key
set
Update
Chain
start
update
update
Bulk
Entity
update
Entity
verbose
warn
@grandlinex/kernel
Loading...
Don't use this interface use {IDataBase} instead
See
IDataBase