Type Alias RelationalBackend<TMetadata>

Relational backend interface for relationship edge operations.

type RelationalBackend<TMetadata extends EdgeMetadata = EdgeMetadata> = {
    getIncoming(
        toId: string,
        relation: string,
        options?: RelationalQueryOptions,
    ): EdgePage<TMetadata> | Promise<EdgePage<TMetadata>>;
    getOutgoing(
        fromId: string,
        relation: string,
        options?: RelationalQueryOptions,
    ): EdgePage<TMetadata> | Promise<EdgePage<TMetadata>>;
    putEdge(edge: Edge<TMetadata>): void | Promise<void>;
    removeEdge(key: EdgeKey): void | Promise<void>;
}

Type Parameters

TMetadata extends EdgeMetadata = EdgeMetadata

Index

Methods

getIncoming getOutgoing putEdge removeEdge

Methods

getIncoming

getIncoming(
    toId: string,
    relation: string,
    options?: RelationalQueryOptions,
): EdgePage<TMetadata> | Promise<EdgePage<TMetadata>>
Query incoming edges for an entity and relation.
Parameters
- toId: string
  Target entity id.
- relation: string
  Relation name.
- Optionaloptions: RelationalQueryOptions
  Optional paging options.
Returns EdgePage<TMetadata> | Promise<EdgePage<TMetadata>>
Page of incoming edges.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:62

getOutgoing

getOutgoing(
    fromId: string,
    relation: string,
    options?: RelationalQueryOptions,
): EdgePage<TMetadata> | Promise<EdgePage<TMetadata>>
Query outgoing edges for an entity and relation.
Parameters
- fromId: string
  Source entity id.
- relation: string
  Relation name.
- Optionaloptions: RelationalQueryOptions
  Optional paging options.
Returns EdgePage<TMetadata> | Promise<EdgePage<TMetadata>>
Page of outgoing edges.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:50

putEdge

putEdge(edge: Edge<TMetadata>): void | Promise<void>
Insert or update an edge.
Parameters
- edge: Edge<TMetadata>
  Edge to store.
Returns void | Promise<void>
Promise resolved once stored.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:36

removeEdge

removeEdge(key: EdgeKey): void | Promise<void>
Remove an edge by key.
Parameters
- key: EdgeKey
  Edge key to remove.
Returns void | Promise<void>
Promise resolved once removed.
- Defined in api/ORM/drivers/IndexingRelationshipDriver.ts:42