Prometheus Entity Management API
Preparing search index...
@prometheus-ags/entity-graph-core
SyncAdapter
Interface SyncAdapter
interface
SyncAdapter
{
name
:
string
;
onStatusChange
?:
(
cb
:
(
status
:
AdapterStatus
)
=>
void
)
=>
UnsubscribeFn
;
execute
(
sql
:
string
,
params
?:
unknown
[]
)
:
Promise
<
void
>
;
isSynced
()
:
boolean
;
onSyncComplete
(
cb
:
()
=>
void
)
:
UnsubscribeFn
;
query
<
T
=
Record
<
string
,
unknown
>
>
(
sql
:
string
,
params
?:
unknown
[]
,
)
:
Promise
<
SyncQueryResult
<
T
>
>
;
subscribe
(
config
:
SubscriptionConfig
,
handler
:
(
changeset
:
ChangeSet
)
=>
void
,
)
:
UnsubscribeFn
;
}
Hierarchy (
View Summary
)
RealtimeAdapter
SyncAdapter
Index
Properties
name
on
Status
Change?
Methods
execute
is
Synced
on
Sync
Complete
query
subscribe
Properties
Readonly
name
name
:
string
Optional
on
Status
Change
onStatusChange
?:
(
cb
:
(
status
:
AdapterStatus
)
=>
void
)
=>
UnsubscribeFn
Methods
execute
execute
(
sql
:
string
,
params
?:
unknown
[]
)
:
Promise
<
void
>
Parameters
sql
:
string
Optional
params
:
unknown
[]
Returns
Promise
<
void
>
is
Synced
isSynced
()
:
boolean
Returns
boolean
on
Sync
Complete
onSyncComplete
(
cb
:
()
=>
void
)
:
UnsubscribeFn
Parameters
cb
:
()
=>
void
Returns
UnsubscribeFn
query
query
<
T
=
Record
<
string
,
unknown
>
>
(
sql
:
string
,
params
?:
unknown
[]
,
)
:
Promise
<
SyncQueryResult
<
T
>
>
Type Parameters
T
=
Record
<
string
,
unknown
>
Parameters
sql
:
string
Optional
params
:
unknown
[]
Returns
Promise
<
SyncQueryResult
<
T
>
>
subscribe
subscribe
(
config
:
SubscriptionConfig
,
handler
:
(
changeset
:
ChangeSet
)
=>
void
,
)
:
UnsubscribeFn
Parameters
config
:
SubscriptionConfig
handler
:
(
changeset
:
ChangeSet
)
=>
void
Returns
UnsubscribeFn
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
name
on
Status
Change
Methods
execute
is
Synced
on
Sync
Complete
query
subscribe
Prometheus Entity Management API
Loading...