Documentation
¶
Overview ¶
Get index recovery information. Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices.
Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.
Recovery automatically occurs during the following processes:
* When creating an index for the first time. * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. * Creation of new replica shard copies from the primary. * Relocation of a shard copy to a different node in the same cluster. * A snapshot restore operation. * A clone, shrink, or split operation.
You can determine the cause of a shard recovery using the recovery or cat recovery APIs.
The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.
Index ¶
- Variables
- type NewRecovery
- type Recovery
- func (r *Recovery) ActiveOnly(activeonly bool) *Recovery
- func (r *Recovery) Detailed(detailed bool) *Recovery
- func (r Recovery) Do(providedCtx context.Context) (Response, error)
- func (r *Recovery) ErrorTrace(errortrace bool) *Recovery
- func (r *Recovery) FilterPath(filterpaths ...string) *Recovery
- func (r *Recovery) Header(key, value string) *Recovery
- func (r *Recovery) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Recovery) Human(human bool) *Recovery
- func (r *Recovery) Index(index string) *Recovery
- func (r Recovery) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Recovery) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Recovery) Pretty(pretty bool) *Recovery
- type Response
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type NewRecovery ¶
type NewRecovery func() *Recovery
NewRecovery type alias for index.
func NewRecoveryFunc ¶
func NewRecoveryFunc(tp elastictransport.Interface) NewRecovery
NewRecoveryFunc returns a new instance of Recovery with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Recovery ¶
type Recovery struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Recovery
Get index recovery information. Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices.
Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.
Recovery automatically occurs during the following processes:
* When creating an index for the first time. * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. * Creation of new replica shard copies from the primary. * Relocation of a shard copy to a different node in the same cluster. * A snapshot restore operation. * A clone, shrink, or split operation.
You can determine the cause of a shard recovery using the recovery or cat recovery APIs.
The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
func (*Recovery) ActiveOnly ¶
ActiveOnly If `true`, the response only includes ongoing shard recoveries. API name: active_only
func (*Recovery) Detailed ¶
Detailed If `true`, the response includes detailed information about shard recoveries. API name: detailed
func (Recovery) Do ¶
Do runs the request through the transport, handle the response and returns a recovery.Response
func (*Recovery) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Recovery) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Recovery) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Recovery) Human ¶ added in v8.14.0
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (*Recovery) Index ¶
Index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
func (Recovery) IsSuccess ¶
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
type Response ¶ added in v8.7.0
type Response map[string]types.RecoveryStatus
Source Files