CollectionApiClient Class |
A client for interacting with ArangoDB Collections endpoints,
implementing ICollectionApiClient.
Inheritance HierarchyNamespace: ArangoDBNetStandard.CollectionApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe CollectionApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CollectionApiClient(IApiClientTransport) |
Creates an instance of CollectionApiClient
using the provided transport layer and the default JSON serialization.
|
| CollectionApiClient(IApiClientTransport, IApiClientSerialization) |
Creates an instance of CollectionApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteCollectionAsync | |
 | 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.) |
| GetChecksumAsync |
Get the checksum for a specific collection.
GET /_api/collection/{collection-name}/checksum
|
| GetCollectionAsync |
Return information about the requested collection.
GET/_api/collection/{collection-name}
|
| GetCollectionCountAsync |
Gets count of documents in a collection.
GET/_api/collection/{collection-name}/count
|
| GetCollectionFiguresAsync |
Contains the number of documents and additional statistical information about the collection.
GET/_api/collection/{collection-name}/figures
|
| GetCollectionPropertiesAsync |
Read properties of a collection.
GET /_api/collection/{collection-name}/properties
|
| GetCollectionRevisionAsync |
Get a revision of the collection.
GET /_api/collection/{collection-name}/revision
|
| GetCollectionsAsync |
Get all collections.
GET/_api/collection
|
| GetCollectionShardsAsync |
Returns the shard ids of a collection.
This method is only available in a cluster Coordinator.
GET /_api/collection/{collection-name}/shards
|
| GetCollectionShardsWithDetailsAsync |
Returns the shard ids of a collection.
This method is only available in a cluster Coordinator.
The response also contains shard IDs as object attribute
keys, and the responsible servers for each shard mapped
to them. The leader shards will be first in the arrays.
GET /_api/collection/{collection-name}/shards?details=true
|
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PostCollectionAsync | |
| PutCollectionPropertyAsync |
Changes the properties of a collection
PUT /_api/collection/{collection-name}/properties
|
| PutCompactCollectionDataAsync |
Compacts the data of a collection in order to reclaim disk space.
The operation will compact the document and index data by rewriting
the underlying .sst files and only keeping the relevant entries.
PUT /_api/collection/{collection-name}/compact
|
| PutDocumentShardAsync |
Returns the responsible shard for a document.
This method is only available in a cluster.
PUT /_api/collection/{collection-name}/responsibleShard
|
| PutLoadIndexesIntoMemoryAsync |
Load Indexes into Memory.
Caches all index entries of this collection into the main memory.
Therefore it iterates over all indexes of the collection and
stores the indexed values, not the entire document data,
in memory.
PUT /_api/collection/{collection-name}/loadIndexesIntoMemory
|
| PutRecalculateCountAsync |
Recalculates the document count of a collection.
PUT /_api/collection/{collection-name}/recalculateCount
|
| RenameCollectionAsync |
Rename a collection.
PUT /_api/collection/{collection-name}/rename
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TruncateCollectionAsync |
Truncates a collection, i.e. removes all documents in the collection.
PUT/_api/collection/{collection-name}/truncate
|
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _collectionApiPath |
The root path of the API.
|
| _transport |
The transport client used to communicate with the ArangoDB host.
|
See Also