SDK
SDK Dart Null Safety v3.x
2

refresh #

When writing or deleting documents in Kuzzle, it can take up to 1 second for search indexes to be updated, making the changes available in search results.

This API route forces an immediate refresh of search indexes.

A refresh operation comes with some performance costs.

From the 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."


Future<bool> refresh(String index, String collection)

ArgumentsTypeDescription
index
String
Index name
collection
String
Collection name

Returns #

Returns a Future<bool>.

Usage #

kuzzle
  .collection
  .refresh('nyc-open-data', 'yellow-taxi');