Documentation
¶
Overview ¶
Get a document count.
Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
Index ¶
- Variables
- type Count
- func (r Count) Do(providedCtx context.Context) (Response, error)
- func (r *Count) ErrorTrace(errortrace bool) *Count
- func (r *Count) FilterPath(filterpaths ...string) *Count
- func (r *Count) Format(format string) *Count
- func (r *Count) H(names ...string) *Count
- func (r *Count) Header(key, value string) *Count
- func (r *Count) Help(help bool) *Count
- func (r *Count) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Count) Human(human bool) *Count
- func (r *Count) Index(index string) *Count
- func (r Count) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Count) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Count) Pretty(pretty bool) *Count
- func (r *Count) S(names ...string) *Count
- func (r *Count) V(v bool) *Count
- type NewCount
- 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 Count ¶
type Count struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Count
Get a document count.
Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.
IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count
func (Count) Do ¶
Do runs the request through the transport, handle the response and returns a count.Response
func (*Count) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Count) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Count) Format ¶
Format Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. API name: format
func (*Count) H ¶
H List of columns to appear in the response. Supports simple wildcards. API name: h
func (*Count) Help ¶
Help When set to `true` will output available columns. This option can't be combined with any other query string option. API name: help
func (*Count) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Count) 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 (*Count) Index ¶
Index A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
func (Count) 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 (Count) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Count) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewCount ¶
type NewCount func() *Count
NewCount type alias for index.
func NewCountFunc ¶
func NewCountFunc(tp elastictransport.Interface) NewCount
NewCountFunc returns a new instance of Count with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response []types.CountRecord
Source Files