split

Documentation

Overview

Splits an existing index into a new index with more primary shards.

Index

• Variables
• type NewSplit
  • func NewSplitFunc(tp elastictransport.Interface) NewSplit
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type Split
  • func New(tp elastictransport.Interface) *Split
  • func (r *Split) Aliases(aliases map[string]types.Alias) *Split
  • func (r Split) Do(providedCtx context.Context) (*Response, error)
  • func (r *Split) ErrorTrace(errortrace bool) *Split
  • func (r *Split) FilterPath(filterpaths ...string) *Split
  • func (r *Split) Header(key, value string) *Split
  • func (r *Split) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Split) Human(human bool) *Split
  • func (r *Split) MasterTimeout(duration string) *Split
  • func (r Split) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Split) Pretty(pretty bool) *Split
  • func (r *Split) Raw(raw io.Reader) *Split
  • func (r *Split) Request(req *Request) *Split
  • func (r *Split) Settings(settings map[string]json.RawMessage) *Split
  • func (r *Split) Timeout(duration string) *Split
  • func (r *Split) WaitForActiveShards(waitforactiveshards string) *Split

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.

Types

type NewSplit

type NewSplit func(index, target string) *Split

NewSplit type alias for index.

func NewSplitFunc

func NewSplitFunc(tp elastictransport.Interface) NewSplit

NewSplitFunc returns a new instance of Split 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 {

	// Aliases Aliases for the resulting index.
	Aliases map[string]types.Alias `json:"aliases,omitempty"`
	// Settings Configuration options for the target index.
	Settings map[string]json.RawMessage `json:"settings,omitempty"`
}

Request holds the request body struct for the package split

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/indices/split/IndicesSplitRequest.ts#L27-L74

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Acknowledged       bool   `json:"acknowledged"`
	Index              string `json:"index"`
	ShardsAcknowledged bool   `json:"shards_acknowledged"`
}

Response holds the response body struct for the package split

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/indices/split/IndicesSplitResponse.ts#L22-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Split

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

func New

func New(tp elastictransport.Interface) *Split

Splits an existing index into a new index with more primary shards.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html

func (*Split) Aliases

func (r *Split) Aliases(aliases map[string]types.Alias) *Split

Aliases Aliases for the resulting index. API name: aliases

func (Split) Do

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

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

func (*Split) ErrorTrace

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

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

func (*Split) FilterPath

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

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

func (*Split) Header

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

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

func (*Split) HttpRequest

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

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

func (*Split) Human

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

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 (*Split) MasterTimeout

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

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (Split) Perform

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

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

func (*Split) Pretty

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

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

func (*Split) Raw

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

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

func (*Split) Request

func (r *Split) Request(req *Request) *Split

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

func (*Split) Settings

func (r *Split) Settings(settings map[string]json.RawMessage) *Split

Settings Configuration options for the target index. API name: settings

func (*Split) Timeout

func (r *Split) Timeout(duration string) *Split

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*Split) WaitForActiveShards

func (r *Split) WaitForActiveShards(waitforactiveshards string) *Split

WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). API name: wait_for_active_shards