create #

Creates a new index.

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

Copied to clipboard!

create(index, [options]);

Arguments	Type	Description
index	string	Index 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	Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely

Resolves #

Resolves if the index does not already exists

Usage #

Copied to clipboard!

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