createIndex( )

Creates an index for a data collection.

The index can't be used immediately, as the process of generating the index takes time. You can check whether your index is ready using listIndexes().

Note that when an index fails to create, the failed index still occupies a slot. To remove the failed index and free up the slot for a new index, use dropIndex().

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Managa Data Indexes
Learn more about permission scopes.
Method Declaration
Method Parameters

ID of the data collection for which to generate the index.


Details of the index to be created.

Return Type:Promise<Index>
Was this helpful?