The highest tagged major version is
Documentation
¶
Overview ¶
Delete a synonym set.
You can only delete a synonyms set that is not in use by any index analyzer.
Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers.
Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.
If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. To prevent that, synonyms sets that are used in analyzers can't be deleted. A delete request in this case will return a 400 response code.
To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. Once finished, you can delete the index. When the synonyms set is not used in analyzers, you will be able to delete it.
Index ¶
- Variables
- type DeleteSynonym
- func (r DeleteSynonym) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteSynonym) ErrorTrace(errortrace bool) *DeleteSynonym
- func (r *DeleteSynonym) FilterPath(filterpaths ...string) *DeleteSynonym
- func (r *DeleteSynonym) Header(key, value string) *DeleteSynonym
- func (r *DeleteSynonym) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteSynonym) Human(human bool) *DeleteSynonym
- func (r DeleteSynonym) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteSynonym) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteSynonym) Pretty(pretty bool) *DeleteSynonym
- type NewDeleteSynonym
- 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 DeleteSynonym ¶
type DeleteSynonym struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteSynonym
Delete a synonym set.
You can only delete a synonyms set that is not in use by any index analyzer.
Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers.
Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.
If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. To prevent that, synonyms sets that are used in analyzers can't be deleted. A delete request in this case will return a 400 response code.
To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. Once finished, you can delete the index. When the synonyms set is not used in analyzers, you will be able to delete it.
https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonyms-set.html
func (DeleteSynonym) Do ¶
func (r DeleteSynonym) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletesynonym.Response
func (*DeleteSynonym) ErrorTrace ¶ added in v8.14.0
func (r *DeleteSynonym) ErrorTrace(errortrace bool) *DeleteSynonym
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteSynonym) FilterPath ¶ added in v8.14.0
func (r *DeleteSynonym) FilterPath(filterpaths ...string) *DeleteSynonym
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*DeleteSynonym) Header ¶
func (r *DeleteSynonym) Header(key, value string) *DeleteSynonym
Header set a key, value pair in the DeleteSynonym headers map.
func (*DeleteSynonym) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteSynonym) Human ¶ added in v8.14.0
func (r *DeleteSynonym) Human(human bool) *DeleteSynonym
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 (DeleteSynonym) IsSuccess ¶
func (r DeleteSynonym) IsSuccess(providedCtx context.Context) (bool, error)
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.
func (DeleteSynonym) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteSynonym) Pretty ¶ added in v8.14.0
func (r *DeleteSynonym) Pretty(pretty bool) *DeleteSynonym
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewDeleteSynonym ¶
type NewDeleteSynonym func(id string) *DeleteSynonym
NewDeleteSynonym type alias for index.
func NewDeleteSynonymFunc ¶
func NewDeleteSynonymFunc(tp elastictransport.Interface) NewDeleteSynonym
NewDeleteSynonymFunc returns a new instance of DeleteSynonym with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files