dropIndex( )

Removes an index from a data collection.

The process of dropping an index from a collection takes time. You can check whether an index has been dropped by calling List Indexes.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Data Indexes
Manage All Data Resources
Learn more about app permissions.
Method Declaration
Copy
function dropIndex(dataCollectionId: string, indexName: string): Promise<void>;
Method Parameters
dataCollectionIdstringRequired

ID of the data collection for which the index to be dropped is defined.

indexNamestringRequired

Name of the index to drop.

JavaScript
import { indexes } from "@wix/data";

async function dropIndex(dataCollectionId, indexName) {
  const response = await indexes.dropIndex(dataCollectionId, indexName);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?