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 (opens new window) 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 |
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 (opens new window)