Clear objects

About this method

Clear the records of an index without affecting its settings.

This method enables you to delete an index’s contents (records) without removing any settings, rules and synonyms.

If you want to remove the entire index and not just its records, use the delete method instead.

Clearing an index will have no impact on its Analytics data because you cannot clear an index’s analytics data.

Clearing an index counts as one operation. Note, however, that this operation is expensive:

• when you have more than 100 requests pending, your requests will be throttled.
• when you have more than 5000 requests pending, further requests will be ignored.
• if needed, these values can be tuned through configuration.

Examples

1
$index->clearObjects();

1
index.clear_objects

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

1
index.clear_objects()

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

1
index.clearObjects()

1
2
3
4
index.ClearObjects();

// Asynchronous
await index.ClearObjectsAsync();

1
2
3
4
index.clearObjects();

// Asynchronous
index.clearObjectsAsync();

1
res, err := index.ClearObjects()

1
client.execute { clear index "your_index_name" }

1
algolia index clear <INDEX-NAME>