SDK
SDK C++ v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

This SDK has been deprecated because of stability issues. It is not advised to use it in a production environment.

truncate #

Remove all documents from a collection while keeping the associated mapping.
It is faster than deleting all documents from a collection.

Signature #

void truncate(const std::string& index, const std::string& collection);

void truncate(
    const std::string& index,
    const std::string& collection,
    const kuzzleio::query_options& options);

Arguments #

ArgumentsTypeDescription
index
const std::string&
Index name
collection
const std::string&
Collection name
options
kuzzleio::query_options*
Query options

options #

Additional query options

PropertyType
(default)
Description
queuable
bool

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Usage #

try {
  kuzzle->collection->truncate("nyc-open-data", "yellow-taxi");
  std::cout << "Collection successfully truncated" << std::endl;
} catch (kuzzleio::KuzzleException &e) {
  std::cerr << e.what() << std::endl;
}