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

Arguments

Copied to clipboard!
Refresh(index string, options types.QueryOptions) error
Arguments Type Description
index
string
Index name
options
QueryOptions
Query options

Options

Additional query options

Option Type Description Default
queuable
bool
Make this request queuable or not true

Return

Return an error or nil if index successfully refreshed.

Usage

Copied to clipboard!
err := kuzzle.Index.Refresh("nyc-open-data", nil)
if err != nil {
  log.Fatal(err)
} else {
  fmt.Println("0 shards fail to refresh")
}