Type Alias RelationEdgesDdbDependencies<TMetadata>

DynamoDB dependencies required for relation edge storage.

type RelationEdgesDdbDependencies<TMetadata extends EdgeMetadata = EdgeMetadata> = {
    deleteEdges(keys: RelationEdgesDdbKey[]): Promise<void>;
    putEdges(items: RelationEdgesDdbItem<TMetadata>[]): Promise<void>;
    queryEdges(
        request: RelationEdgesQueryRequest,
    ): Promise<RelationEdgesQueryResult<TMetadata>>;
}

Type Parameters

TMetadata extends EdgeMetadata = EdgeMetadata

Index

Methods

deleteEdges putEdges queryEdges

Methods

deleteEdges

deleteEdges(keys: RelationEdgesDdbKey[]): Promise<void>
Batch delete relation edge keys.
Parameters
- keys: RelationEdgesDdbKey[]
  Edge keys to delete.
Returns Promise<void>
Promise resolved once deleted.
- Defined in api/Indexing/rel/RelationalDdb.ts:269

putEdges

putEdges(items: RelationEdgesDdbItem<TMetadata>[]): Promise<void>
Batch put relation edge items.
Parameters
- items: RelationEdgesDdbItem<TMetadata>[]
  Edge items to store.
Returns Promise<void>
Promise resolved once stored.
- Defined in api/Indexing/rel/RelationalDdb.ts:263

queryEdges

queryEdges(
request: RelationEdgesQueryRequest,
): Promise<RelationEdgesQueryResult<TMetadata>>
Query relation edges by key.
Parameters
- request: RelationEdgesQueryRequest
  Query request parameters.
Returns Promise<RelationEdgesQueryResult<TMetadata>>
Query results and pagination key.
- Defined in api/Indexing/rel/RelationalDdb.ts:275