restore

package
v8.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 17, 2025 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Restore a snapshot. Restore a snapshot of a cluster or data streams and indices.

You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible.

To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.

Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:

``` GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream ```

If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.

If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.

Index

Constants

This section is empty.

Variables

View Source 
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 NewRestore 

type NewRestore func(repository, snapshot string) *Restore

NewRestore type alias for index.

func NewRestoreFunc 

func NewRestoreFunc(tp elastictransport.Interface) NewRestore

NewRestoreFunc returns a new instance of Restore with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request 

type Request struct {
	FeatureStates       []string             `json:"feature_states,omitempty"`
	IgnoreIndexSettings []string             `json:"ignore_index_settings,omitempty"`
	IgnoreUnavailable   *bool                `json:"ignore_unavailable,omitempty"`
	IncludeAliases      *bool                `json:"include_aliases,omitempty"`
	IncludeGlobalState  *bool                `json:"include_global_state,omitempty"`
	IndexSettings       *types.IndexSettings `json:"index_settings,omitempty"`
	Indices             []string             `json:"indices,omitempty"`
	Partial             *bool                `json:"partial,omitempty"`
	RenamePattern       *string              `json:"rename_pattern,omitempty"`
	RenameReplacement   *string              `json:"rename_replacement,omitempty"`
}

Request holds the request body struct for the package restore

https://github.com/elastic/elasticsearch-specification/blob/f6a370d0fba975752c644fc730f7c45610e28f36/specification/snapshot/restore/SnapshotRestoreRequest.ts#L25-L78

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON added in v8.12.1 

func (s *Request) UnmarshalJSON(data []byte) error

type Response added in v8.7.0 

type Response struct {
	Accepted *bool                  `json:"accepted,omitempty"`
	Snapshot *types.SnapshotRestore `json:"snapshot,omitempty"`
}

Response holds the response body struct for the package restore

https://github.com/elastic/elasticsearch-specification/blob/f6a370d0fba975752c644fc730f7c45610e28f36/specification/snapshot/restore/SnapshotRestoreResponse.ts#L23-L28

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

type Restore 

type Restore struct {
	// contains filtered or unexported fields
}

func New 

func New(tp elastictransport.Interface) *Restore

Restore a snapshot. Restore a snapshot of a cluster or data streams and indices.

You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible.

To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.

Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:

``` GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream ```

If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.

If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/current/restore-snapshot-api.html

func (Restore) Do 

func (r Restore) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a restore.Response

func (*Restore) ErrorTrace added in v8.14.0 

func (r *Restore) ErrorTrace(errortrace bool) *Restore

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Restore) FeatureStates added in v8.9.0 

func (r *Restore) FeatureStates(featurestates ...string) *Restore

API name: feature_states

func (*Restore) FilterPath added in v8.14.0 

func (r *Restore) FilterPath(filterpaths ...string) *Restore

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Restore) Header 

func (r *Restore) Header(key, value string) *Restore

Header set a key, value pair in the Restore headers map.

func (*Restore) HttpRequest 

func (r *Restore) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Restore) Human added in v8.14.0 

func (r *Restore) Human(human bool) *Restore

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 (*Restore) IgnoreIndexSettings added in v8.9.0 

func (r *Restore) IgnoreIndexSettings(ignoreindexsettings ...string) *Restore

API name: ignore_index_settings

func (*Restore) IgnoreUnavailable added in v8.9.0 

func (r *Restore) IgnoreUnavailable(ignoreunavailable bool) *Restore

API name: ignore_unavailable

func (*Restore) IncludeAliases added in v8.9.0 

func (r *Restore) IncludeAliases(includealiases bool) *Restore

API name: include_aliases

func (*Restore) IncludeGlobalState added in v8.9.0 

func (r *Restore) IncludeGlobalState(includeglobalstate bool) *Restore

API name: include_global_state

func (*Restore) IndexSettings added in v8.9.0 

func (r *Restore) IndexSettings(indexsettings types.IndexSettingsVariant) *Restore

API name: index_settings

func (*Restore) Indices added in v8.9.0 

func (r *Restore) Indices(indices ...string) *Restore

API name: indices

func (*Restore) MasterTimeout 

func (r *Restore) MasterTimeout(duration string) *Restore

MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout

func (*Restore) Partial added in v8.9.0 

func (r *Restore) Partial(partial bool) *Restore

API name: partial

func (Restore) Perform added in v8.7.0 

func (r Restore) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Restore) Pretty added in v8.14.0 

func (r *Restore) Pretty(pretty bool) *Restore

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*Restore) Raw 

func (r *Restore) Raw(raw io.Reader) *Restore

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Restore) RenamePattern added in v8.9.0 

func (r *Restore) RenamePattern(renamepattern string) *Restore

API name: rename_pattern

func (*Restore) RenameReplacement added in v8.9.0 

func (r *Restore) RenameReplacement(renamereplacement string) *Restore

API name: rename_replacement

func (*Restore) Request 

func (r *Restore) Request(req *Request) *Restore

Request allows to set the request property with the appropriate payload.

func (*Restore) WaitForCompletion 

func (r *Restore) WaitForCompletion(waitforcompletion bool) *Restore

WaitForCompletion Should this request wait until the operation has completed before returning API name: wait_for_completion

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.