Monarch Database API - v1.0.0
Preparing search index...
GraphOperations
Interface GraphOperations
interface
GraphOperations
{
gcreateEdge
(
graphKey
:
string
,
from
:
string
,
to
:
string
,
type
?:
string
,
properties
?:
Record
<
string
,
any
>
,
)
:
Promise
<
string
>
;
gcreateNode
(
graphKey
:
string
,
label
?:
string
,
properties
?:
Record
<
string
,
any
>
,
)
:
Promise
<
string
>
;
gdeleteEdge
(
graphKey
:
string
,
edgeId
:
string
)
:
Promise
<
boolean
>
;
gdeleteNode
(
graphKey
:
string
,
nodeId
:
string
)
:
Promise
<
boolean
>
;
gfindByLabel
(
graphKey
:
string
,
label
:
string
)
:
Promise
<
any
[]
>
;
gfindByProperty
(
graphKey
:
string
,
field
:
string
,
value
:
any
,
)
:
Promise
<
any
[]
>
;
ggetEdge
(
graphKey
:
string
,
edgeId
:
string
)
:
Promise
<
any
>
;
ggetNeighbors
(
graphKey
:
string
,
nodeId
:
string
,
direction
?:
"outgoing"
|
"incoming"
|
"both"
,
)
:
Promise
<
any
[]
>
;
ggetNode
(
graphKey
:
string
,
nodeId
:
string
)
:
Promise
<
any
>
;
ggetStats
(
graphKey
:
string
)
:
Promise
<
any
>
;
gtraverse
(
graphKey
:
string
,
startNodeId
:
string
,
options
?:
any
,
)
:
Promise
<
any
>
;
gupdateEdge
(
graphKey
:
string
,
edgeId
:
string
,
properties
:
Record
<
string
,
any
>
,
)
:
Promise
<
boolean
>
;
gupdateNode
(
graphKey
:
string
,
nodeId
:
string
,
properties
:
Record
<
string
,
any
>
,
)
:
Promise
<
boolean
>
;
}
Implemented by
DataStructures
Index
Methods
gcreate
Edge
gcreate
Node
gdelete
Edge
gdelete
Node
gfind
By
Label
gfind
By
Property
gget
Edge
gget
Neighbors
gget
Node
gget
Stats
gtraverse
gupdate
Edge
gupdate
Node
Methods
gcreate
Edge
gcreateEdge
(
graphKey
:
string
,
from
:
string
,
to
:
string
,
type
?:
string
,
properties
?:
Record
<
string
,
any
>
,
)
:
Promise
<
string
>
Parameters
graphKey
:
string
from
:
string
to
:
string
Optional
type
:
string
Optional
properties
:
Record
<
string
,
any
>
Returns
Promise
<
string
>
gcreate
Node
gcreateNode
(
graphKey
:
string
,
label
?:
string
,
properties
?:
Record
<
string
,
any
>
,
)
:
Promise
<
string
>
Parameters
graphKey
:
string
Optional
label
:
string
Optional
properties
:
Record
<
string
,
any
>
Returns
Promise
<
string
>
gdelete
Edge
gdeleteEdge
(
graphKey
:
string
,
edgeId
:
string
)
:
Promise
<
boolean
>
Parameters
graphKey
:
string
edgeId
:
string
Returns
Promise
<
boolean
>
gdelete
Node
gdeleteNode
(
graphKey
:
string
,
nodeId
:
string
)
:
Promise
<
boolean
>
Parameters
graphKey
:
string
nodeId
:
string
Returns
Promise
<
boolean
>
gfind
By
Label
gfindByLabel
(
graphKey
:
string
,
label
:
string
)
:
Promise
<
any
[]
>
Parameters
graphKey
:
string
label
:
string
Returns
Promise
<
any
[]
>
gfind
By
Property
gfindByProperty
(
graphKey
:
string
,
field
:
string
,
value
:
any
)
:
Promise
<
any
[]
>
Parameters
graphKey
:
string
field
:
string
value
:
any
Returns
Promise
<
any
[]
>
gget
Edge
ggetEdge
(
graphKey
:
string
,
edgeId
:
string
)
:
Promise
<
any
>
Parameters
graphKey
:
string
edgeId
:
string
Returns
Promise
<
any
>
gget
Neighbors
ggetNeighbors
(
graphKey
:
string
,
nodeId
:
string
,
direction
?:
"outgoing"
|
"incoming"
|
"both"
,
)
:
Promise
<
any
[]
>
Parameters
graphKey
:
string
nodeId
:
string
Optional
direction
:
"outgoing"
|
"incoming"
|
"both"
Returns
Promise
<
any
[]
>
gget
Node
ggetNode
(
graphKey
:
string
,
nodeId
:
string
)
:
Promise
<
any
>
Parameters
graphKey
:
string
nodeId
:
string
Returns
Promise
<
any
>
gget
Stats
ggetStats
(
graphKey
:
string
)
:
Promise
<
any
>
Parameters
graphKey
:
string
Returns
Promise
<
any
>
gtraverse
gtraverse
(
graphKey
:
string
,
startNodeId
:
string
,
options
?:
any
)
:
Promise
<
any
>
Parameters
graphKey
:
string
startNodeId
:
string
Optional
options
:
any
Returns
Promise
<
any
>
gupdate
Edge
gupdateEdge
(
graphKey
:
string
,
edgeId
:
string
,
properties
:
Record
<
string
,
any
>
,
)
:
Promise
<
boolean
>
Parameters
graphKey
:
string
edgeId
:
string
properties
:
Record
<
string
,
any
>
Returns
Promise
<
boolean
>
gupdate
Node
gupdateNode
(
graphKey
:
string
,
nodeId
:
string
,
properties
:
Record
<
string
,
any
>
,
)
:
Promise
<
boolean
>
Parameters
graphKey
:
string
nodeId
:
string
properties
:
Record
<
string
,
any
>
Returns
Promise
<
boolean
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
gcreate
Edge
gcreate
Node
gdelete
Edge
gdelete
Node
gfind
By
Label
gfind
By
Property
gget
Edge
gget
Neighbors
gget
Node
gget
Stats
gtraverse
gupdate
Edge
gupdate
Node
Monarch Database API - v1.0.0
Loading...