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.

list #

Get the complete list of indexes handled by Kuzzle.

Signature #

Copied to clipboard!
std::vector<std::string> list();

std::vector<std::string> list(const kuzzleio::query_options& options);

Arguments #

Arguments Type Description
options
kuzzleio::query_options*
Query options

options #

Additional query options

Option Type
(default)
Description
queuable
bool

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

Return #

A vector of string containing the list of indexes present in Kuzzle

Exceptions #

Throws a kuzzleio::KuzzleException if there is an error. See how to handle error.

Usage #

Copied to clipboard!
try {
std::vector<std::string> indexes = kuzzle->index->list();
std::cout << "Kuzzle contains " << indexes.size() << " indexes" << std::endl;
} catch (kuzzleio::KuzzleException &e) {
  std::cerr << e.what() << std::endl;
}