count #

Counts documents in a collection.

A query can be provided to alter the count result, otherwise returns the total number of documents in the collection.

Kuzzle uses the ElasticSearch Query DSL syntax.

count(index, collection, query, [options]);

Argument	Type	Description
`index`	string	Index name
`collection`	string	Collection name
`query`	object	Query to match
`options`	object	Query options

options #

Additional query options

Options	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

Resolves to the number of matched documents.

Usage #

try {
  const count = await kuzzle.document.count(
    'nyc-open-data',
    'yellow-taxi',
    {
      query: {
        match: { license: 'valid' }
      }
    }
  );
  console.log(`Found ${count} documents matching license:valid`);
} catch (error) {
  console.error(error.message);
}

Edit this page on Github