refresh

When writing or deleting documents in Kuzzle, the update needs to be indexed before being available in search results.

A refresh operation comes with some performance costs.

From Elasticsearch documentation:

"While a refresh is much lighter than a commit, it still has a performance cost. A manual refresh can be useful when writing tests, but don’t do a manual refresh every time you index a document in production; it will hurt your performance. Instead, your application needs to be aware of the near real-time nature of Elasticsearch and make allowances for it."

Signature

Copied to clipboard!
void refresh(const std::string& index);

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

Arguments

Arguments Type Description
index
const std::string&
Index name
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

Exceptions

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

Usage

Copied to clipboard!
try {
  kuzzle->index->refresh("nyc-open-data");

  std::cout << "Index successfully refreshed" << std::endl;
} catch (kuzzleio::KuzzleException &e) {
  std::cerr << e.what() << std::endl;
}