Click or drag to resize

ICollectionApiClient Methods

The ICollectionApiClient type exposes the following members.

Methods
  NameDescription
Public methodDeleteCollectionAsync
Public methodGetChecksumAsync
Get the checksum for a specific collection. GET /_api/collection/{collection-name}/checksum
Public methodGetCollectionAsync
Gets the requested collection. GET/_api/collection/{collection-name}
Public methodGetCollectionCountAsync
Gets count of documents in a collection. GET/_api/collection/{collection-name}/count
Public methodGetCollectionFiguresAsync
Contains the number of documents and additional statistical information about the collection. GET/_api/collection/{collection-name}/figures
Public methodGetCollectionPropertiesAsync
Read properties of a collection. GET /_api/collection/{collection-name}/properties
Public methodGetCollectionRevisionAsync
Get a revision of the collection. GET /_api/collection/{collection-name}/revision
Public methodGetCollectionsAsync
Get all collections. GET/_api/collection
Public methodGetCollectionShardsAsync
Returns the shard ids of a collection. This method is only available in a cluster Coordinator. GET /_api/collection/{collection-name}/shards
Public methodGetCollectionShardsWithDetailsAsync
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
Public methodPostCollectionAsync
Public methodPutCollectionPropertyAsync
Changes the properties of a collection PUT /_api/collection/{collection-name}/properties
Public methodPutCompactCollectionDataAsync
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
Public methodPutDocumentShardAsync
Returns the responsible shard for a document. PUT /_api/collection/{collection-name}/responsibleShard
Public methodPutLoadIndexesIntoMemoryAsync
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
Public methodPutRecalculateCountAsync
Recalculates the document count of a collection. PUT /_api/collection/{collection-name}/recalculateCount
Public methodRenameCollectionAsync
Rename a collection. PUT /_api/collection/{collection-name}/rename
Public methodTruncateCollectionAsync
Truncates a collection, i.e. removes all documents in the collection. PUT/_api/collection/{collection-name}/truncate
Top
See Also