count #
Returns the number of documents matching the provided set of filters.
There is a small delay between the time a document is created and its availability in our search layer (usually a couple of seconds). That means that a document that was just created might not be returned by this function at first.
count(filters, [options], callback) #
Arguments | Type | Description |
---|---|---|
filters | JSON Object | Filters in ElasticSearch Query DSL format |
options | JSON Object | Optional parameters |
callback | function | Callback handling the response |
Options #
Option | Type | Description | Default |
---|---|---|---|
queuable | boolean | Make this request queuable or not | true |
Callback Response #
Returns a count for the number of document matches as an integer
.
Usage #
// Using callbacks (NodeJS or Web Browser)
kuzzle
.collection('collection', 'index')
.count({}, function (err, res) {
// ...
});
// Using promises (NodeJS only)
kuzzle
.collection('collection', 'index')
.countPromise({})
.then(res => {
// ...
});
Callback response:
12
Edit this page on Github(opens new window)