Documentation
¶
Overview ¶
Delete indices. Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards.
You cannot delete the current write index of a data stream. To delete the index, you must roll over the data stream so a new write index is created. You can then use the delete index API to delete the previous write index.
Index ¶
- Variables
- type Delete
- func (r *Delete) AllowNoIndices(allownoindices bool) *Delete
- func (r Delete) Do(providedCtx context.Context) (*Response, error)
- func (r *Delete) ErrorTrace(errortrace bool) *Delete
- func (r *Delete) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Delete
- func (r *Delete) FilterPath(filterpaths ...string) *Delete
- func (r *Delete) Header(key, value string) *Delete
- func (r *Delete) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Delete) Human(human bool) *Delete
- func (r *Delete) IgnoreUnavailable(ignoreunavailable bool) *Delete
- func (r Delete) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Delete) MasterTimeout(duration string) *Delete
- func (r Delete) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Delete) Pretty(pretty bool) *Delete
- func (r *Delete) Timeout(duration string) *Delete
- type NewDelete
- 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 Delete ¶
type Delete struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Delete
Delete indices. Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards.
You cannot delete the current write index of a data stream. To delete the index, you must roll over the data stream so a new write index is created. You can then use the delete index API to delete the previous write index.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete
func (*Delete) AllowNoIndices ¶
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. API name: allow_no_indices
func (Delete) Do ¶
Do runs the request through the transport, handle the response and returns a delete.Response
func (*Delete) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Delete) ExpandWildcards ¶
func (r *Delete) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Delete
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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards
func (*Delete) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Delete) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Delete) Human ¶
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 (*Delete) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (Delete) IsSuccess ¶
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 (*Delete) MasterTimeout ¶
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 (Delete) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
type NewDelete ¶
NewDelete type alias for index.
func NewDeleteFunc ¶
func NewDeleteFunc(tp elastictransport.Interface) NewDelete
NewDeleteFunc returns a new instance of Delete with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
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"`
Shards_ *types.ShardStatistics `json:"_shards,omitempty"`
}
Response holds the response body struct for the package delete
Source Files