exists #
Check if a document exists.
exists (index, collection, id, [options]);
Argument | Type | Description |
---|---|---|
index | string | Index name |
collection | string | Collection name |
id | string | Document ID |
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 |
refresh | string ( "" ) | If set to wait_for , waits for the change to be reflected for search (up to 1s) |
silent | boolean ( false ) | If true , then Kuzzle will not generate notifications Available since 7.5.3 |
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 a boolean.
Usage #
try {
const response = await kuzzle.document.exists('nyc-open-data', 'yellow-taxi', 'some-id');
console.log(response);
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)