Delete records matching a filter

This operation doesn’t accept empty filters.

This operation is resource-intensive. You should only use it if you can’t get the object IDs of the records you want to delete. It’s more efficient to get a list of object IDs with the browse operation, and then delete the records using the batch operation.

This operation is subject to indexing rate limits.

Usage

Required ACL: deleteIndex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import algoliasearch.api.SearchClient
import algoliasearch.config.*
import algoliasearch.extension.SearchClientExtensions

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

val response = Await.result(
  client.deleteBy(
    indexName = "ALGOLIA_INDEX_NAME",
    deleteByParams = DeleteByParams(
      filters = Some("brand:brandName")
    )
  ),
  Duration(100, "sec")
)
Did you find this page helpful?
Scala API clients v2