exists #
Checks if a collection exists in Kuzzle.
exists(index, collection, [options]);
Arguments | Type | Description |
---|---|---|
index | string | Index name |
collection | string | Collection name |
options | object | Query options |
options #
Additional query options
Property | 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 true
if the collection exists, false
otherwise.
Usage #
try {
const exists = await kuzzle.collection.exists('nyc-open-data', 'green-taxi');
if (exists) {
console.log('Success');
}
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)