1
0
Fork 0
arangodb/Documentation/DocuBlocks/Rest/Collections/put_api_collection_recalcul...

850 B

@startDocuBlock put_api_collection_recalculate_count @brief recalculates the document count of a collection

@RESTHEADER{PUT /_api/collection/{collection-name}/recalculateCount, Recalculate count of a collection, handleCommandPut:recalculateCount}

@RESTURLPARAMETERS

@RESTURLPARAM{collection-name,string,required} The name of the collection.

@RESTDESCRIPTION Recalculates the document count of a collection, if it ever becomes inconsistent.

It returns an object with the attributes

  • result: will be true if recalculating the document count succeeded.

Note: this method is specific for the RocksDB storage engine

@RESTRETURNCODES

@RESTRETURNCODE{200} If the document count was recalculated successfully, HTTP 200 is returned.

@RESTRETURNCODE{404} If the collection-name is unknown, then a HTTP 404 is returned. @endDocuBlock