SDK
SDK Golang v3.x
2

refresh #

Refreshes a collection to reindex the written and deleted documents so they are available in search results.

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 #

Refresh(index string, collection string, options types.QueryOptions) error
ArgumentsTypeDescription
index
string
Index name
collection
string
Collection name
options
QueryOptions
Query options

Resolves #

Resolves when the refresh has been done.

Usage #

err := kuzzle.Collection.Refresh("nyc-open-data", "yellow-taxi", nil)
if err != nil {
  log.Fatal(err)
} else {
  fmt.Println("Success")
}