Documentation
¶
Overview ¶
Flush data streams or indices. Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.
After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.
It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.
Index ¶
- Variables
- type Flush
- func (r *Flush) AllowNoIndices(allownoindices bool) *Flush
- func (r Flush) Do(providedCtx context.Context) (*Response, error)
- func (r *Flush) ErrorTrace(errortrace bool) *Flush
- func (r *Flush) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Flush
- func (r *Flush) FilterPath(filterpaths ...string) *Flush
- func (r *Flush) Force(force bool) *Flush
- func (r *Flush) Header(key, value string) *Flush
- func (r *Flush) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Flush) Human(human bool) *Flush
- func (r *Flush) IgnoreUnavailable(ignoreunavailable bool) *Flush
- func (r *Flush) Index(index string) *Flush
- func (r Flush) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Flush) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Flush) Pretty(pretty bool) *Flush
- func (r *Flush) WaitIfOngoing(waitifongoing bool) *Flush
- type NewFlush
- 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 Flush ¶
type Flush struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Flush
Flush data streams or indices. Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.
After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.
It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
func (*Flush) 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 (Flush) Do ¶
Do runs the request through the transport, handle the response and returns a flush.Response
func (*Flush) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Flush) ExpandWildcards ¶
func (r *Flush) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Flush
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 (*Flush) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Flush) Force ¶
Force If `true`, the request forces a flush even if there are no changes to commit to the index. API name: force
func (*Flush) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Flush) Human ¶ added in v8.14.0
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 (*Flush) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*Flush) Index ¶
Index Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
func (Flush) 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 (Flush) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Flush) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*Flush) WaitIfOngoing ¶
WaitIfOngoing If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. API name: wait_if_ongoing
type NewFlush ¶
type NewFlush func() *Flush
NewFlush type alias for index.
func NewFlushFunc ¶
func NewFlushFunc(tp elastictransport.Interface) NewFlush
NewFlushFunc returns a new instance of Flush with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Shards_ *types.ShardStatistics `json:"_shards,omitempty"`
}
Response holds the response body struct for the package flush
Source Files