Class RelationalDdbBackend<TMetadata>

DynamoDB-backed relational edge store with directional queries.

Type Parameters

TMetadata extends EdgeMetadata = EdgeMetadata

Index

Constructors

Methods

getIncoming getOutgoing putEdge removeEdge

Constructors

constructor

new RelationalDdbBackend<TMetadata extends EdgeMetadata = EdgeMetadata>(
dependencies: RelationEdgesDdbDependencies<TMetadata>,
): RelationalDdbBackend<TMetadata>
Type Parameters
- TMetadata extends EdgeMetadata = EdgeMetadata
Parameters
- dependencies: RelationEdgesDdbDependencies<TMetadata>
  DynamoDB query/write dependencies.
Returns RelationalDdbBackend<TMetadata>
- Defined in api/Indexing/rel/RelationalDdb.ts:323

Methods

getIncoming

getIncoming(
    toId: string,
    relation: string,
    options?: RelationalQueryOptions,
): Promise<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 Promise<EdgePage<TMetadata>>
Page of incoming edges.
- Defined in api/Indexing/rel/RelationalDdb.ts:408

getOutgoing

getOutgoing(
    fromId: string,
    relation: string,
    options?: RelationalQueryOptions,
): Promise<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 Promise<EdgePage<TMetadata>>
Page of outgoing edges.
- Defined in api/Indexing/rel/RelationalDdb.ts:372

putEdge

putEdge(edge: Edge<TMetadata>): Promise<void>
Insert or update an edge.
Parameters
- edge: Edge<TMetadata>
  Edge to store.
Returns Promise<void>
Promise resolved once stored.
- Defined in api/Indexing/rel/RelationalDdb.ts:332

removeEdge

removeEdge(key: EdgeKey): Promise<void>
Remove an edge by key.
Parameters
- key: EdgeKey
  Edge key to remove.
Returns Promise<void>
Promise resolved once removed.
- Defined in api/Indexing/rel/RelationalDdb.ts:357