Class AstraiosGraphClient

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

Implements

GraphClient

Index

Constructors

Properties

_accessToken _userId _userPrimaryKey

Methods

create deleteGraphById getGraphById getGraphListMetaDataByUserId saveOrUpdate toGraph update

Constructors

constructor

new AstraiosGraphClient(userId, userPrimaryKey, accessToken): AstraiosGraphClient
Parameters
- userId: string
- userPrimaryKey: number
- accessToken: string
Returns AstraiosGraphClient
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:48

Properties

`Private` _accessToken

_accessToken: string

`Private` _userId

_userId: string

`Private` _userPrimaryKey

_userPrimaryKey: number

Methods

`Private` create

create(graph): Promise<Graph>
Parameters
- graph: Graph
Returns Promise<Graph>
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:170

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
Implementation of GraphClient.deleteGraphById
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:120

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
Implementation of GraphClient.getGraphById
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:62

getGraphListMetaDataByUserId

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

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>
Implementation of GraphClient.saveOrUpdate
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:58

`Private` toGraph

toGraph(response): Graph
Parameters
- response: any
Returns Graph
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:338

`Private` update

update(graph): Promise<Graph>
Parameters
- graph: Graph
Returns Promise<Graph>
- Defined in packages/nexusgraph-db/src/graph/astraios/AstraiosGraphClient.ts:256

Generated using TypeDoc