SDK
SDK Javascript v7.x
2

create #

Creates a new index.

Indexes are only virtual container for collections.
They can be listed only if they contain at least one collection.


create(index, [options]);

ArgumentsTypeDescription
index
string
Index name
options
object
Query options

options #

Additional query options

PropertyType
(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 if the index does not already exists

Usage #

try {
  await kuzzle.index.create('nyc-open-data');
  console.log('Index created');
} catch (error) {
  console.error(error.message);
}