lib/elasticsearch/api/actions/cat/count.rb in elasticsearch-api-7.4.0 vs lib/elasticsearch/api/actions/cat/count.rb in elasticsearch-api-7.5.0.pre.pre
- old
+ new
@@ -4,70 +4,49 @@
module Elasticsearch
module API
module Cat
module Actions
-
- # Return document counts for the entire cluster or specific indices
+ # Provides quick access to the document count of the entire cluster, or individual indices.
#
- # @example Display number of documents in the cluster
- #
- # puts client.cat.count
- #
- # @example Display number of documents in an index
- #
- # puts client.cat.count index: 'index-a'
- #
- # @example Display number of documents in a list of indices
- #
- # puts client.cat.count index: ['index-a', 'index-b']
- #
- # @example Display header names in the output
- #
- # puts client.cat.count v: true
- #
- # @example Return the information as Ruby objects
- #
- # client.cat.count format: 'json'
- #
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
- # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
- # @option arguments [Boolean] :v Display column headers as part of the output
+ # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+ # @option arguments [List] :h Comma-separated list of column names to display
+ # @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
- # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
- # @option arguments [Boolean] :help Return information about headers
- # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
- # (default: false)
- # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+ # @option arguments [Boolean] :v Verbose mode. Display column headers
+
#
- # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html
+ # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-count.html
#
- def count(arguments={})
- index = arguments.delete(:index)
+ def count(arguments = {})
+ arguments = arguments.clone
- method = HTTP_GET
+ _index = arguments.delete(:index)
- path = Utils.__pathify '_cat/count', Utils.__listify(index)
-
+ method = Elasticsearch::API::HTTP_GET
+ path = if _index
+ "_cat/count/#{Utils.__listify(_index)}"
+ else
+ "_cat/count"
+end
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
params[:h] = Utils.__listify(params[:h]) if params[:h]
- body = nil
-
+ body = nil
perform_request(method, path, params, body).body
end
# Register this action with its valid params when the module is loaded.
#
- # @since 6.1.1
+ # @since 6.2.0
ParamsRegistry.register(:count, [
- :format,
- :local,
- :master_timeout,
- :h,
- :help,
- :s,
- :v ].freeze)
+ :format,
+ :h,
+ :help,
+ :s,
+ :v
+ ].freeze)
+end
end
- end
end
end