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 an index is ready by calling List Indexes.

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, call Drop Index.

Authentication

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

Permissions
Manage Data Indexes
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
dataCollectionIdstringRequired

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


indexIndexRequired

Details of the index to be created.


optionsCreateIndexOptions

Options for creating an index.

Returns
Return Type:Promise<Index>
Did this help?