Class KnowledgeGraphAPI

Constructors

constructor

new KnowledgeGraphAPI(graphId?: string): KnowledgeGraphAPI
Parameters
- OptionalgraphId: string
Returns KnowledgeGraphAPI
- Defined in graph/dist/api.d.ts:21

Accessors

graphId

get graphId(): string
Returns string
- Defined in graph/dist/api.d.ts:23

state

get state(): RuntimeState
Returns RuntimeState
- Defined in graph/dist/api.d.ts:22

Methods

activate

activate(): GraphResult<void>
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:25

addEdge

addEdge(participantId: string, params: AddEdgeParams): GraphResult<Edge>
Parameters
- participantId: string
- params: AddEdgeParams
Returns GraphResult<Edge>
- Defined in graph/dist/api.d.ts:34

addEdgeLabel

addEdgeLabel(
    participantId: string,
    edgeId: string,
    label: string,
): GraphResult<Edge>
Parameters
- participantId: string
- edgeId: string
- label: string
Returns GraphResult<Edge>
- Defined in graph/dist/api.d.ts:39

addNode

addNode(participantId: string, params: AddNodeParams): GraphResult<Node>
Parameters
- participantId: string
- params: AddNodeParams
Returns GraphResult<Node>
- Defined in graph/dist/api.d.ts:33

addNodeLabel

addNodeLabel(
    participantId: string,
    nodeId: string,
    label: string,
): GraphResult<Node>
Parameters
- participantId: string
- nodeId: string
- label: string
Returns GraphResult<Node>
- Defined in graph/dist/api.d.ts:37

beginTransaction

beginTransaction(participantId: string): GraphResult<string>
Parameters
- participantId: string
Returns GraphResult<string>
- Defined in graph/dist/api.d.ts:30

commit

commit(participantId: string): GraphResult<void>
Parameters
- participantId: string
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:31

deregisterParticipant

deregisterParticipant(participantId: string): GraphResult<void>
Parameters
- participantId: string
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:29

getEdge

getEdge(id: string): GraphResult<Edge | undefined>
Parameters
- id: string
Returns GraphResult<Edge | undefined>
- Defined in graph/dist/api.d.ts:47

getEdges

getEdges(): GraphResult<Edge[]>
Returns GraphResult<Edge[]>
- Defined in graph/dist/api.d.ts:49

getEdgesForNode

getEdgesForNode(nodeId: string, direction?: Direction): GraphResult<Edge[]>
Parameters
- nodeId: string
- Optionaldirection: Direction
Returns GraphResult<Edge[]>
- Defined in graph/dist/api.d.ts:50

getNeighbors

getNeighbors(nodeId: string, direction?: Direction): GraphResult<Node[]>
Parameters
- nodeId: string
- Optionaldirection: Direction
Returns GraphResult<Node[]>
- Defined in graph/dist/api.d.ts:51

getNode

getNode(id: string): GraphResult<Node | undefined>
Parameters
- id: string
Returns GraphResult<Node | undefined>
- Defined in graph/dist/api.d.ts:46

getNodes

getNodes(): GraphResult<Node[]>
Returns GraphResult<Node[]>
- Defined in graph/dist/api.d.ts:48

init

init(): GraphResult<void>
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:24

lookup

lookup(id: string): GraphResult<Node | undefined>
Parameters
- id: string
Returns GraphResult<Node | undefined>
- Defined in graph/dist/api.d.ts:52

neighborhood

neighborhood(
query: NeighborhoodQuery,
filter?: Filter,
): GraphResult<NeighborhoodResult>
Parameters
- query: NeighborhoodQuery
- Optionalfilter: Filter
Returns GraphResult<NeighborhoodResult>
- Defined in graph/dist/api.d.ts:54

path

path(query: PathQuery): GraphResult<PathResult>
Parameters
- query: PathQuery
Returns GraphResult<PathResult>
- Defined in graph/dist/api.d.ts:55

registerParticipant

registerParticipant(
participantId: string,
metadata?: Record<string, unknown>,
): GraphResult<void>
Parameters
- participantId: string
- Optionalmetadata: Record<string, unknown>
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:28

removeEdge

removeEdge(participantId: string, edgeId: string): GraphResult<Edge>
Parameters
- participantId: string
- edgeId: string
Returns GraphResult<Edge>
- Defined in graph/dist/api.d.ts:45

removeEdgeLabel

removeEdgeLabel(
    participantId: string,
    edgeId: string,
    label: string,
): GraphResult<Edge>
Parameters
- participantId: string
- edgeId: string
- label: string
Returns GraphResult<Edge>
- Defined in graph/dist/api.d.ts:40

removeNode

removeNode(
participantId: string,
nodeId: string,
): GraphResult<{ cascadeEdges: string[]; node: Node }>
Parameters
- participantId: string
- nodeId: string
Returns GraphResult<{ cascadeEdges: string[]; node: Node }>
- Defined in graph/dist/api.d.ts:41

removeNodeLabel

removeNodeLabel(
    participantId: string,
    nodeId: string,
    label: string,
): GraphResult<Node>
Parameters
- participantId: string
- nodeId: string
- label: string
Returns GraphResult<Node>
- Defined in graph/dist/api.d.ts:38

rollback

rollback(participantId: string): GraphResult<void>
Parameters
- participantId: string
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:32

shutdown

shutdown(): GraphResult<void>
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:27

subscribe(type: string, handler: (event: GraphEvent) => void): () => void
Parameters
- type: string
- handler: (event: GraphEvent) => void
Returns () => void
- Defined in graph/dist/api.d.ts:56

subscribeAll

subscribeAll(handler: (event: GraphEvent) => void): () => void
Parameters
- handler: (event: GraphEvent) => void
Returns () => void
- Defined in graph/dist/api.d.ts:57

suspend

suspend(): GraphResult<void>
Returns GraphResult<void>
- Defined in graph/dist/api.d.ts:26

traversal

traversal(query: TraversalQuery, filter?: Filter): GraphResult<TraversalResult>
Parameters
- query: TraversalQuery
- Optionalfilter: Filter
Returns GraphResult<TraversalResult>
- Defined in graph/dist/api.d.ts:53

updateEdgeProperties

updateEdgeProperties(
    participantId: string,
    edgeId: string,
    params: UpdatePropertiesParams,
): GraphResult<Edge>
Parameters
- participantId: string
- edgeId: string
- params: UpdatePropertiesParams
Returns GraphResult<Edge>
- Defined in graph/dist/api.d.ts:36

updateNodeProperties

updateNodeProperties(
    participantId: string,
    nodeId: string,
    params: UpdatePropertiesParams,
): GraphResult<Node>
Parameters
- participantId: string
- nodeId: string
- params: UpdatePropertiesParams
Returns GraphResult<Node>
- Defined in graph/dist/api.d.ts:35