GraphApiClient Class |
A client for interacting with ArangoDB Graphs endpoints,
implementing IGraphApiClient.
Inheritance HierarchyNamespace: ArangoDBNetStandard.GraphApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe GraphApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GraphApiClient(IApiClientTransport) |
Create an instance of GraphApiClient
using the provided transport layer and the default JSON serialization.
|
| GraphApiClient(IApiClientTransport, IApiClientSerialization) |
Create an instance of GraphApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteEdgeAsyncT(String, String, DeleteEdgeQuery) |
Removes an edge based on its document ID.
|
| DeleteEdgeAsyncT(String, String, String, DeleteEdgeQuery) |
Removes an edge from the collection.
DELETE /_api/gharial/{graph}/edge/{collection}/{edge}
|
| DeleteEdgeDefinitionAsync |
Remove one edge definition from the graph. This will only remove the
edge collection, the vertex collections remain untouched and can still
be used in your queries.
DELETE/_api/gharial/{graph}/edge/{definition}
|
| DeleteGraphAsync |
Deletes an existing graph object by name.
Optionally all collections not used by other
graphs can be deleted as well, using DeleteGraphQuery.
DELETE /_api/gharial/{graph-name}
|
| DeleteVertexAsyncT(String, String, DeleteVertexQuery) |
Removes a vertex based on its document ID.
|
| DeleteVertexAsyncT(String, String, String, DeleteVertexQuery) |
Removes a vertex from the collection.
DELETE/_api/gharial/{graph}/vertex/{collection}/{vertex}
|
| DeleteVertexCollectionAsync |
Removes a vertex collection from the graph and optionally deletes the collection,
if it is not used in any other graph.
It can only remove vertex collections that are no longer part of edge definitions,
if they are used in edge definitions you are required to modify those first.
DELETE/_api/gharial/{graph}/vertex/{collection}
|
 | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetEdgeAsyncT(String, String, GetEdgeQuery) |
Gets an edge from the given graph using the edge's document-handle.
GET /_api/gharial/{graph}/edge/{collection}/{edge}
|
| GetEdgeAsyncT(String, String, String, GetEdgeQuery) |
Gets an edge from the given graph using the edge collection and _key attribute.
|
| GetEdgeCollectionsAsync |
Lists all edge collections within this graph.
GET /_api/gharial/{graph}/edge
|
| GetGraphAsync |
Selects information for a given graph.
Will return the edge definitions as well as the orphan collections.
GET /_api/gharial/{graph}
|
| GetGraphsAsync |
Lists all graphs stored in this database.
GET /_api/gharial
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVertexAsyncT(String, String, GetVertexQuery) |
Gets a vertex based on its document ID.
|
| GetVertexAsyncT(String, String, String, GetVertexQuery) |
Gets a vertex from the given collection.
GET/_api/gharial/{graph}/vertex/{collection}/{vertex}
|
| GetVertexCollectionsAsync |
Lists all vertex collections within the given graph.
GET /_api/gharial/{graph}/vertex
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PatchEdgeAsyncT, U(String, String, T, PatchEdgeQuery) |
Updates the data of the specific edge based on its document ID.
|
| PatchEdgeAsyncT, U(String, String, String, T, PatchEdgeQuery) |
Updates the data of the specific edge in the collection.
PATCH/_api/gharial/{graph}/edge/{collection}/{edge}
|
| PatchVertexAsyncT, U(String, String, T, PatchVertexQuery) |
Updates the data of the specific vertex based on its document ID.
|
| PatchVertexAsyncT, U(String, String, String, T, PatchVertexQuery) |
Updates the data of the specific vertex in the collection.
PATCH/_api/gharial/{graph}/vertex/{collection}/{vertex}
|
| PostEdgeAsyncT |
Creates an edge in an existing graph.
The edge must contain a _from and _to value
referencing valid vertices in the graph.
The edge has to conform to the definition of the edge collection it is added to.
POST /_api/gharial/{graph}/edge/{collection}
|
| PostEdgeDefinitionAsync |
Adds an additional edge definition to the graph.
This edge definition has to contain a collection and an array of
each from and to vertex collections. An edge definition can only
be added if this definition is either not used in any other graph, or
it is used with exactly the same definition. It is not possible to
store a definition “e” from “v1” to “v2” in the one graph, and “e”
from “v2” to “v1” in the other graph.
POST /_api/gharial/{graph}/edge
|
| PostGraphAsync |
Creates a new graph in the graph module.
POST /_api/gharial
|
| PostVertexAsyncT |
Adds a vertex to the given collection.
POST/_api/gharial/{graph}/vertex/{collection}
|
| PostVertexCollectionAsync |
Adds a vertex collection to the set of orphan collections of the graph.
If the collection does not exist, it will be created.
POST /_api/gharial/{graph}/vertex
|
| PutEdgeAsyncT(String, String, T, PutEdgeQuery) |
Replaces the data of an edge based on its document ID.
|
| PutEdgeAsyncT(String, String, String, T, PutEdgeQuery) |
Replaces the data of an edge in the collection.
PUT /_api/gharial/{graph}/edge/{collection}/{edge}
|
| PutEdgeDefinitionAsync |
Change one specific edge definition.
This will modify all occurrences of this definition in all graphs known to your database.
PUT/_api/gharial/{graph}/edge/{definition}
|
| PutVertexAsyncT(String, String, T, PutVertexQuery) |
Replaces the data of a vertex based on its document ID.
|
| PutVertexAsyncT(String, String, String, T, PutVertexQuery) |
Replaces the data of a vertex in the collection.
PUT/_api/gharial/{graph}/vertex/{collection}/{vertex}
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _graphApiPath |
The root path of the API.
|
| _transport |
The transport client used to communicate with the ArangoDB host.
|
See Also