Delete records

Delete multiple records by their ID.

Required ACL: deleteObject

This helper method deletes multiple records from an index by their objectID. It constructs a Batch request with the deleteObject action and automatically sends requests in batches of 1,000.

Usage

C#

var response = await client.DeleteObjectsAsync(
  "ALGOLIA_INDEX_NAME",
  new List<string> { "1", "2" }
);

Parameter

C#

indexName · string · required

Index name from which to delete records.

objectIDs · IEnumerable · required

Object IDs for records to delete.

waitForTasks · bool · default: false

Whether to wait until all batch requests are done.

cancellationToken · cancellationToken · default: "default"

Parameter that can be used as a signal to cancel the request.

requestOptions · RequestOptions

Additional request options.

Go

indexName · string · required

Index name from which to delete records.

objectIDs · []string · required

Object IDs for records to delete.

opts... · ChunkedBatchOption

Functional options to provide extra arguments.

Show available functions

search.WithBatchSize · function

Signature: func(batchSize int) chunkedBatchOption

Sets the number of object IDs to process in one batch. The default batch size is 1,000.

search.WithWaitForTasks · function

Signature: func(withWaitForTasks bool) chunkedBatchOption

Whether to wait until all batch requests are done.

search.WithHeaderParam · function

Signature: func(key string, value string) requestOption

Sets extra header parameters for this request. To learn more, see request options.

search.WithQueryParam · function

Signature: func(key string, value string) requestOption

Sets extra query parameters for this request. To learn more, see request options.

Java

indexName · String · required

Index name from which to delete records.

objectIDs · List<String> · required

Object IDs for records to delete.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Index name from which to delete records.

objectIDs · string[] · required

Object IDs for records to delete.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

Kotlin

indexName · String · required

Index name from which to delete records.

objectIDs · List<String> · required

Object IDs for records to delete.

waitForTasks · Boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

PHP

indexName · string · required

Index name from which to delete records.

objectIDs · string[] · required

Object IDs for records to delete.

requestOptions · array

Additional request options.

Python

index_name · str · required

Index name from which to delete records.

object_ids · list[str] · required

Object IDs for records to delete.

wait_for_tasks · bool · default: "False"

Whether to wait until all batch requests are done.

requestOptions · dict | RequestOptions

Additional request options.

Ruby

index_name · String · required

Index name from which to delete records.

object_ids · Array[String] · required

Object IDs for records to delete.

wait_for_tasks · bool · default: false

Whether to wait until all batch requests are done.

requestOptions · Hash

Additional request options.

Scala

indexName · String · required

Index name from which to delete records.

objectIds · Seq[String] · required

Object IDs for records to delete.

waitForTasks · Boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · Option[RequestOptions]

Additional request options.

Swift

indexName · String · required

Index name from which to delete records.

objectIds · [String] · required

Object IDs for records to delete.

waitForTasks · Bool · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.