Delete Index

About this method # Found an issue? Edit this page A Edit this page

Delete an index and all its settings, including links to its replicas.

This method permanently removes an index from your application, and removes its metadata and configured settings (like searchable attributes and custom ranking).

Rather than use the API, you can delete indices using the dashboard.

If the index has replicas, they will be preserved but will no longer be linked to their primary index. Instead, they’ll become independent indices. If the index is a replica, you must first unlink it before you can delete it.

If you want to only remove records from the index, use the clear method. To delete more than one index, refer to the delete multiple indices guide.

Deleting an index won’t affect analytics data because you can’t delete an index’s analytics data.

If you select and attempt to delete a nonexistent index, the engine ignores the operation but doesn’t send back an error.

Examples # Found an issue? Edit this page A Edit this page

Delete an index by name#

1
$index->delete();

1
index.delete

1
2
3
index.delete().then(() => {
  // done
});

1
index.delete()

1
2
3
4
5
index.delete { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
index.Delete();

// Asynchronous
await index.DeleteAsync();

1
2
3
4
5
//Sync version
index.delete();

//Async version
index.deleteAsync();

1
res, err := index.Delete()

1
client.execute { delete index "index" }

1
index.deleteIndex()