Delete Index

About this method

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

This method not only removes an index from your application, it also removes its metadata and configured settings (like searchable attributes or custom ranking).

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 you want to only remove the records from the index, use the clear method.

Deleting an index will have no impact on Analytics data because you cannot delete an index’s Analytics data.

When deleting an nonexistent index, the engine ignores the operation but does not send back an error.

Examples

Delete an index by name

1
$index->delete();

1
index.delete_index('contacts')

1
2
3
4
5
client.deleteIndex('contacts', (err, content) => {
  if (err) throw err;

  console.log('success');
});

1
index.delete()

1
2
3
4
5
6
7
8
client.deleteIndex(
  withName: "contacts",
  completionHandler: { (content, error) -> Void in
    if error != nil {
        print("Could not delete: \(error!)")
    }
  }
)

1
client.deleteIndexAsync("contacts", null);

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()