refreshInternal

When writing or deleting security and internal documents (users, roles, profiles, configuration, etc.) in Kuzzle, the update needs to be indexed before being reflected in the search index.

The refreshInternal action forces a refresh, on the internal index, making the documents available to search immediately.

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

Arguments

Copied to clipboard!
refreshInternal([options]);

Arguments Type Description
options
object
Query options

options

The options arguments can contain the following option properties:

Property Type
(default)
Description
queuable
boolean

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

Resolves

Resolves to a boolean containing the refresh status.

Usage

Copied to clipboard!
try {
  const success = await kuzzle.index.refreshInternal();

  if (success) {
    console.log('Internal index successfully refreshed');
  }
} catch (error) {
  console.error(error.message);
}