CollectionApiClient Methods

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Gets an ApiErrorException from the provided error response.

Get the checksum for a specific collection. GET /_api/collection/{collection-name}/checksum

Return information about the requested collection. GET/_api/collection/{collection-name}

Gets count of documents in a collection. GET/_api/collection/{collection-name}/count

Contains the number of documents and additional statistical information about the collection. GET/_api/collection/{collection-name}/figures

Read properties of a collection. GET /_api/collection/{collection-name}/properties

Get a revision of the collection. GET /_api/collection/{collection-name}/revision

Get all collections. GET/_api/collection

Returns the shard ids of a collection. This method is only available in a cluster Coordinator. GET /_api/collection/{collection-name}/shards

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

Serves as the default hash function.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Changes the properties of a collection PUT /_api/collection/{collection-name}/properties

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

Returns the responsible shard for a document. This method is only available in a cluster. PUT /_api/collection/{collection-name}/responsibleShard

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

Recalculates the document count of a collection. PUT /_api/collection/{collection-name}/recalculateCount

Rename a collection. PUT /_api/collection/{collection-name}/rename

Returns a string that represents the current object.

Truncates a collection, i.e. removes all documents in the collection. PUT/_api/collection/{collection-name}/truncate

Checks whether the provided document ID is in the correct form of "{collection}/{key}".