lib/elasticsearch/api/actions/count.rb in elasticsearch-api-0.4.1 vs lib/elasticsearch/api/actions/count.rb in elasticsearch-api-0.4.2
- old
+ new
@@ -10,9 +10,13 @@
#
# @example Get the number of documents in a specified index
#
# client.count index: 'myindex'
#
+ # @example Get the number of documents matching a specific query
+ #
+ # index: 'my_index', body: { filtered: { filter: { terms: { foo: ['bar'] } } } }
+ #
# @option arguments [List] :index A comma-separated list of indices to restrict the results
# @option arguments [List] :type A comma-separated list of types to restrict the results
# @option arguments [Hash] :body A query to restrict the results (optional)
# @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
# (options: none, missing)