Interface GraphClient

GraphClient is an GraphQL abstraction layer between Nexus Graph and database that store graph data.

interface GraphClient {
    deleteGraphById(graphId): Promise<Graph>;
    getGraphById(graphId): Promise<Graph>;
    getGraphListMetaDataByUserId(userId): Promise<GraphMetaData[]>;
    saveOrUpdate(graph): Promise<Graph>;
}

Implemented by

Index

Methods

deleteGraphById getGraphById getGraphListMetaDataByUserId saveOrUpdate

Methods

deleteGraphById

deleteGraphById(graphId): Promise<Graph>
Deletes a graph by Graph.id.
Parameters
- graphId: number
  The provided ID to match the to-be deleted graph
Returns Promise<Graph>
the graph info that has been deleted
- Defined in packages/nexusgraph-db/src/graph/GraphClient.ts:46

getGraphById

getGraphById(graphId): Promise<Graph>
Searches for a graph by Graph.id.
Parameters
- graphId: number
  The provided ID to search for
Returns Promise<Graph>
the graph in database that matches the given ID
- Defined in packages/nexusgraph-db/src/graph/GraphClient.ts:37

getGraphListMetaDataByUserId

getGraphListMetaDataByUserId(userId): Promise<GraphMetaData[]>
Returns a list of un-paginated graph metadata associated with a given OAuth user.
Parameters
- userId: string
  The specified OAuthState.userInfo.sub | OIDC ID of a user
Returns Promise<GraphMetaData[]>
- Defined in packages/nexusgraph-db/src/graph/GraphClient.ts:53

saveOrUpdate

saveOrUpdate(graph): Promise<Graph>
Either save or update the given graph instance, depending on whether the Graph.id is undefined
Parameters
- graph: Graph
  The object to be persisted into database
Returns Promise<Graph>
- Defined in packages/nexusgraph-db/src/graph/GraphClient.ts:28

Generated using TypeDoc