Delete Objects
deleteObject
ACL
$index->deleteObjects(array objectIds) $index->deleteObjects(array objectIds, array requestOptions) // delete a single object $index->deleteObject(string objectID) $index->deleteObject(string objectID, array requestOptions)
About this method
You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.
You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.
Remove objects from an index using their objectID
.
This method enables you to remove one or more objects from an index.
There are two methods available to delete objects:
- this one, which uses an
objectID
to identify objects - and
deleteBy
, which usesfilters
to identify objects.
As with other batch operations, each record included in the batch counts as one operation. If you pass an objectID
that doesn’t exist, it still counts as an operation. This is because the engine doesn’t know if the record exists when attempting the operation.
Removing all objects in an index doesn’t delete the index. You have to delete it manually with the deleteIndex
method.
Note: This method also has a singular version.
Examples
Delete multiple objects using their objectID
s
1
$index->deleteObjects(["myID1", "myID2"]);
Delete a single object
1
$index->deleteObject('myID');
Delete multiple objects and send extra HTTP headers
1
2
3
4
5
$objectIDs = [/* objectIDs */];
$index->deleteObjects($objectIDs, [
'X-Forwarded-For' => '94.228.178.246'
]);
Parameters
objectIDs
|
type: list
Required
List of objectIDs to delete. |
requestOptions
|
type: key/value mapping
default: No request options
Optional
A mapping of |
objectID
|
type: integer|string
Required
The objectID of the object to delete. |
Response
In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.
JSON format
1
2
3
4
5
6
7
{
"objectIDs": [
"myObjectID1",
"myObjectID2"
],
"taskID": 678,
}
objectIDs
|
list
List of the objectIDS of the deleted objects. |
taskID
|
integer
The taskID used with the waitTask method. |