split

package
v8.8.2 Latest Latest
Warning

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

Go to latest
Published: Jul 5, 2023 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Allows you to split an existing index into a new index with more primary shards.

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 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  map[string]types.Alias     `json:"aliases,omitempty"`
	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/a0da620389f06553c0727f98f95e40dbb564fcca/specification/indices/split/IndicesSplitRequest.ts#L27-L46

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

type Response added in v8.7.0

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

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type Split

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

func New

Allows you to split an existing index into a new index with more primary shards.

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

func (Split) Do

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

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

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) Index

func (r *Split) Index(v string) *Split

Index The name of the source index to split API Name: index

func (*Split) MasterTimeout

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (Split) Perform added in v8.7.0

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

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

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) Target

func (r *Split) Target(v string) *Split

Target The name of the target index to split into API Name: target

func (*Split) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*Split) WaitForActiveShards

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

WaitForActiveShards Set the number of active shards to wait for on the shrunken index before the operation returns. API name: wait_for_active_shards

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL