Class RelationalInMemoryBackend<TMetadata>

In-memory relational backend for tests and local runs.

Type Parameters

TMetadata extends EdgeMetadata = EdgeMetadata

Index

Methods

getIncoming getOutgoing putEdge removeEdge

Methods

getIncoming

getIncoming(
    toId: string,
    relation: string,
    options?: RelationalQueryOptions,
): EdgePage<TMetadata>
Query incoming edges for an entity and relation.
Parameters
- toId: string
  Target entity id.
- relation: string
  Relation name.
- options: RelationalQueryOptions = {}
  Optional paging options.
Returns EdgePage<TMetadata>
Page of incoming edges.
- Defined in api/Indexing/rel/RelationalInMemoryBackend.ts:154

getOutgoing

getOutgoing(
    fromId: string,
    relation: string,
    options?: RelationalQueryOptions,
): EdgePage<TMetadata>
Query outgoing edges for an entity and relation.
Parameters
- fromId: string
  Source entity id.
- relation: string
  Relation name.
- options: RelationalQueryOptions = {}
  Optional paging options.
Returns EdgePage<TMetadata>
Page of outgoing edges.
- Defined in api/Indexing/rel/RelationalInMemoryBackend.ts:130

putEdge

putEdge(edge: Edge<TMetadata>): void
Insert or update an edge.
Parameters
- edge: Edge<TMetadata>
  Edge to store.
Returns void
Nothing.
- Defined in api/Indexing/rel/RelationalInMemoryBackend.ts:86

removeEdge

removeEdge(key: EdgeKey): void
Remove an edge by key.
Parameters
- key: EdgeKey
  Edge key to remove.
Returns void
Nothing.
- Defined in api/Indexing/rel/RelationalInMemoryBackend.ts:105