Clear Objects | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

index.clearIndex(callback)

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.

Note this is an expensive operation:

• 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_index

1
2
3
4
5
index.clearIndex((err, content) => {
  if (err) throw err;

  console.log(content);
});

1
index.clear_objects()

1
2
3
4
5
index.clearIndex(completionHandler: { (content, error) -> Void in
    if error != nil {
        print("Could not clear index: \(error!)")
    }
})

1
index.clearIndexAsync(null);

1
2
3
4
index.ClearObjects();

// Asynchronous
await index.ClearObjectsAsync();

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

// Async version
index.clearObjectsAsync();

1
res, err := index.ClearObjects()

1
client.execute { clear index "index" }

1
index.clearObjects()

1
2
3
4
{
  "updatedAt": "2017-12-18T21:22:40.761Z",
  "taskID": 19541511530
}