WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« indices.updateAliases indices.validateQuery »

› ›

indices.upgrade

edit

indices.upgrade

edit

client.indices.upgrade({
  index: string | string[],
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all',
  ignore_unavailable: boolean,
  wait_for_completion: boolean,
  only_ancient_segments: boolean
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`allow_no_indices` or `allowNoIndices`	`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `open`
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`wait_for_completion` or `waitForCompletion`	`boolean` - Specify whether the request should block until the all segments are upgraded (default: false)
`only_ancient_segments` or `onlyAncientSegments`	`boolean` - If true, only ancient (an older Lucene major release) segments will be upgraded

« indices.updateAliases indices.validateQuery »