putsettings

package
v9.2.0 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.

For performance optimization during bulk indexing, you can disable the refresh interval. Refer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example. There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:

``` 

{
  "number_of_replicas": 1
}

```

Or you can use an `index` setting object: ``` 

{
  "index": {
    "number_of_replicas": 1
  }
}

```

Or you can use dot annotation: ``` 

{
  "index.number_of_replicas": 1
}

```

Or you can embed any of the aforementioned options in a `settings` object. For example:

``` 

{
  "settings": {
    "index": {
      "number_of_replicas": 1
    }
  }
}

```

NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. Refer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples.

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 NewPutSettings 

type NewPutSettings func() *PutSettings

NewPutSettings type alias for index.

func NewPutSettingsFunc 

func NewPutSettingsFunc(tp elastictransport.Interface) NewPutSettings

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

type PutSettings 

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

func New 

func New(tp elastictransport.Interface) *PutSettings

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.

For performance optimization during bulk indexing, you can disable the refresh interval. Refer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example. There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:

``` 

{
  "number_of_replicas": 1
}

```

Or you can use an `index` setting object: ``` 

{
  "index": {
    "number_of_replicas": 1
  }
}

```

Or you can use dot annotation: ``` 

{
  "index.number_of_replicas": 1
}

```

Or you can embed any of the aforementioned options in a `settings` object. For example:

``` 

{
  "settings": {
    "index": {
      "number_of_replicas": 1
    }
  }
}

```

NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. Refer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings

func (*PutSettings) AddIndexSetting 

func (r *PutSettings) AddIndexSetting(key string, value json.RawMessage) *PutSettings

func (*PutSettings) AddSimilarity 

func (r *PutSettings) AddSimilarity(key string, value types.SettingsSimilarityVariant) *PutSettings

func (*PutSettings) AllowNoIndices 

func (r *PutSettings) AllowNoIndices(allownoindices bool) *PutSettings

AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. API name: allow_no_indices

func (*PutSettings) Analysis 

func (r *PutSettings) Analysis(analysis types.IndexSettingsAnalysisVariant) *PutSettings

API name: analysis

func (*PutSettings) Analyze 

func (r *PutSettings) Analyze(analyze types.SettingsAnalyzeVariant) *PutSettings

Settings to define analyzers, tokenizers, token filters and character filters. Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices. API name: analyze

func (*PutSettings) AutoExpandReplicas 

func (r *PutSettings) AutoExpandReplicas(autoexpandreplicas any) *PutSettings

API name: auto_expand_replicas

func (*PutSettings) Blocks 

func (r *PutSettings) Blocks(blocks types.IndexSettingBlocksVariant) *PutSettings

API name: blocks

func (*PutSettings) CheckOnStartup 

func (r *PutSettings) CheckOnStartup(checkonstartup indexcheckonstartup.IndexCheckOnStartup) *PutSettings

API name: check_on_startup

func (*PutSettings) Codec 

func (r *PutSettings) Codec(codec string) *PutSettings

API name: codec

func (*PutSettings) CreationDate 

func (r *PutSettings) CreationDate(stringifiedepochtimeunitmillis types.StringifiedEpochTimeUnitMillisVariant) *PutSettings

API name: creation_date

func (*PutSettings) CreationDateString 

func (r *PutSettings) CreationDateString(datetime types.DateTimeVariant) *PutSettings

API name: creation_date_string

func (*PutSettings) DefaultPipeline 

func (r *PutSettings) DefaultPipeline(pipelinename string) *PutSettings

API name: default_pipeline

func (PutSettings) Do 

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

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

func (*PutSettings) ErrorTrace 

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

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

func (*PutSettings) ExpandWildcards 

func (r *PutSettings) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *PutSettings

ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards

func (*PutSettings) FilterPath 

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

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

func (*PutSettings) FinalPipeline 

func (r *PutSettings) FinalPipeline(pipelinename string) *PutSettings

API name: final_pipeline

func (*PutSettings) FlatSettings 

func (r *PutSettings) FlatSettings(flatsettings bool) *PutSettings

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

func (*PutSettings) Format 

func (r *PutSettings) Format(format string) *PutSettings

API name: format

func (*PutSettings) GcDeletes 

func (r *PutSettings) GcDeletes(duration types.DurationVariant) *PutSettings

API name: gc_deletes

func (*PutSettings) Header 

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

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

func (*PutSettings) Hidden 

func (r *PutSettings) Hidden(hidden string) *PutSettings

API name: hidden

func (*PutSettings) Highlight 

func (r *PutSettings) Highlight(highlight types.SettingsHighlightVariant) *PutSettings

API name: highlight

func (*PutSettings) HttpRequest 

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

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

func (*PutSettings) Human 

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (*PutSettings) IgnoreUnavailable 

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

IgnoreUnavailable If `true`, returns settings in flat format. API name: ignore_unavailable

func (*PutSettings) Index 

func (r *PutSettings) Index(index types.IndexSettingsVariant) *PutSettings

API name: index

func (*PutSettings) IndexSettings 

func (r *PutSettings) IndexSettings(indexsettings map[string]json.RawMessage) *PutSettings

API name: IndexSettings

func (*PutSettings) IndexingPressure 

func (r *PutSettings) IndexingPressure(indexingpressure types.IndicesIndexingPressureVariant) *PutSettings

Configure indexing back pressure limits. API name: indexing_pressure

func (*PutSettings) IndexingSlowlog 

func (r *PutSettings) IndexingSlowlog(indexingslowlog types.IndexingSlowlogSettingsVariant) *PutSettings

API name: indexing.slowlog

func (*PutSettings) Indices 

func (r *PutSettings) Indices(index string) *PutSettings

Indices 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 (*PutSettings) Lifecycle 

func (r *PutSettings) Lifecycle(lifecycle types.IndexSettingsLifecycleVariant) *PutSettings

API name: lifecycle

func (*PutSettings) LoadFixedBitsetFiltersEagerly 

func (r *PutSettings) LoadFixedBitsetFiltersEagerly(loadfixedbitsetfilterseagerly bool) *PutSettings

API name: load_fixed_bitset_filters_eagerly

func (*PutSettings) Mapping 

func (r *PutSettings) Mapping(mapping types.MappingLimitSettingsVariant) *PutSettings

Enable or disable dynamic mapping for an index. API name: mapping

func (*PutSettings) MasterTimeout 

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

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 (*PutSettings) MaxDocvalueFieldsSearch 

func (r *PutSettings) MaxDocvalueFieldsSearch(maxdocvaluefieldssearch int) *PutSettings

API name: max_docvalue_fields_search

func (*PutSettings) MaxInnerResultWindow 

func (r *PutSettings) MaxInnerResultWindow(maxinnerresultwindow int) *PutSettings

API name: max_inner_result_window

func (*PutSettings) MaxNgramDiff 

func (r *PutSettings) MaxNgramDiff(maxngramdiff int) *PutSettings

API name: max_ngram_diff

func (*PutSettings) MaxRefreshListeners 

func (r *PutSettings) MaxRefreshListeners(maxrefreshlisteners int) *PutSettings

API name: max_refresh_listeners

func (*PutSettings) MaxRegexLength 

func (r *PutSettings) MaxRegexLength(maxregexlength int) *PutSettings

API name: max_regex_length

func (*PutSettings) MaxRescoreWindow 

func (r *PutSettings) MaxRescoreWindow(maxrescorewindow int) *PutSettings

API name: max_rescore_window

func (*PutSettings) MaxResultWindow 

func (r *PutSettings) MaxResultWindow(maxresultwindow int) *PutSettings

API name: max_result_window

func (*PutSettings) MaxScriptFields 

func (r *PutSettings) MaxScriptFields(maxscriptfields int) *PutSettings

API name: max_script_fields

func (*PutSettings) MaxShingleDiff 

func (r *PutSettings) MaxShingleDiff(maxshinglediff int) *PutSettings

API name: max_shingle_diff

func (*PutSettings) MaxSlicesPerScroll 

func (r *PutSettings) MaxSlicesPerScroll(maxslicesperscroll int) *PutSettings

API name: max_slices_per_scroll

func (*PutSettings) MaxTermsCount 

func (r *PutSettings) MaxTermsCount(maxtermscount int) *PutSettings

API name: max_terms_count

func (*PutSettings) Merge 

func (r *PutSettings) Merge(merge types.MergeVariant) *PutSettings

API name: merge

func (*PutSettings) Mode 

func (r *PutSettings) Mode(mode string) *PutSettings

API name: mode

func (*PutSettings) NumberOfReplicas 

func (r *PutSettings) NumberOfReplicas(numberofreplicas string) *PutSettings

API name: number_of_replicas

func (*PutSettings) NumberOfRoutingShards 

func (r *PutSettings) NumberOfRoutingShards(numberofroutingshards int) *PutSettings

API name: number_of_routing_shards

func (*PutSettings) NumberOfShards 

func (r *PutSettings) NumberOfShards(numberofshards string) *PutSettings

API name: number_of_shards

func (PutSettings) Perform 

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

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

func (*PutSettings) PreserveExisting 

func (r *PutSettings) PreserveExisting(preserveexisting bool) *PutSettings

PreserveExisting If `true`, existing index settings remain unchanged. API name: preserve_existing

func (*PutSettings) Pretty 

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

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

func (*PutSettings) Priority 

func (r *PutSettings) Priority(priority string) *PutSettings

API name: priority

func (*PutSettings) ProvidedName 

func (r *PutSettings) ProvidedName(name string) *PutSettings

API name: provided_name

func (*PutSettings) Queries 

func (r *PutSettings) Queries(queries types.QueriesVariant) *PutSettings

API name: queries

func (*PutSettings) QueryString 

func (r *PutSettings) QueryString(querystring types.SettingsQueryStringVariant) *PutSettings

API name: query_string

func (*PutSettings) Raw 

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

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

func (*PutSettings) RefreshInterval 

func (r *PutSettings) RefreshInterval(duration types.DurationVariant) *PutSettings

API name: refresh_interval

func (*PutSettings) Reopen 

func (r *PutSettings) Reopen(reopen bool) *PutSettings

Reopen Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. API name: reopen

func (*PutSettings) Request 

func (r *PutSettings) Request(req *Request) *PutSettings

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

func (*PutSettings) Routing 

func (r *PutSettings) Routing(routing types.IndexRoutingVariant) *PutSettings

API name: routing

func (*PutSettings) RoutingPartitionSize 

func (r *PutSettings) RoutingPartitionSize(stringifiedinteger types.StringifiedintegerVariant) *PutSettings

API name: routing_partition_size

func (*PutSettings) RoutingPath 

func (r *PutSettings) RoutingPath(routingpaths ...string) *PutSettings

API name: routing_path

func (*PutSettings) Search 

func (r *PutSettings) Search(search types.SettingsSearchVariant) *PutSettings

API name: search

func (*PutSettings) Settings 

func (r *PutSettings) Settings(settings types.IndexSettingsVariant) *PutSettings

API name: settings

func (*PutSettings) Similarity 

func (r *PutSettings) Similarity(similarity map[string]types.SettingsSimilarity) *PutSettings

Configure custom similarity settings to customize how search results are scored. API name: similarity

func (*PutSettings) SoftDeletes 

func (r *PutSettings) SoftDeletes(softdeletes types.SoftDeletesVariant) *PutSettings

API name: soft_deletes

func (*PutSettings) Sort 

func (r *PutSettings) Sort(sort types.IndexSegmentSortVariant) *PutSettings

API name: sort

func (*PutSettings) Store 

func (r *PutSettings) Store(store types.StorageVariant) *PutSettings

The store module allows you to control how index data is stored and accessed on disk. API name: store

func (*PutSettings) TimeSeries 

func (r *PutSettings) TimeSeries(timeseries types.IndexSettingsTimeSeriesVariant) *PutSettings

API name: time_series

func (*PutSettings) Timeout 

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

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 (*PutSettings) TopMetricsMaxSize 

func (r *PutSettings) TopMetricsMaxSize(topmetricsmaxsize int) *PutSettings

API name: top_metrics_max_size

func (*PutSettings) Translog 

func (r *PutSettings) Translog(translog types.TranslogVariant) *PutSettings

API name: translog

func (*PutSettings) Uuid 

func (r *PutSettings) Uuid(uuid string) *PutSettings

API name: uuid

func (*PutSettings) VerifiedBeforeClose 

func (r *PutSettings) VerifiedBeforeClose(verifiedbeforeclose string) *PutSettings

API name: verified_before_close

func (*PutSettings) Version 

func (r *PutSettings) Version(version types.IndexVersioningVariant) *PutSettings

API name: version

type Request 

type Request = types.IndexSettings

Request holds the request body struct for the package putsettings

https://github.com/elastic/elasticsearch-specification/blob/d520d9e8cf14cad487de5e0654007686c395b494/specification/indices/put_settings/IndicesPutSettingsRequest.ts#L25-L165

func NewRequest 

func NewRequest() *Request

NewRequest returns a Request

type Response 

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package putsettings

https://github.com/elastic/elasticsearch-specification/blob/d520d9e8cf14cad487de5e0654007686c395b494/specification/indices/put_settings/IndicesPutSettingsResponse.ts#L22-L25

func NewResponse 

func NewResponse() *Response

NewResponse returns a Response

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.