Add or update attributes of multiple records with transformation

Add or update record attributes without replacing the entire record, using the transformation pipeline.

Required ACL: addObject

Before using this method, set up the transformation region on the search client.

To use this method, you must have only one Push to Algolia connector. The API returns a 400 error if you have more than one Push connector, or you use Collections and a Push connector.

For more information, see WithTransformation helper methods.

This helper method creates a push task with the partialUpdateObject or partialUpdateObjectNoCreate actions, depending on whether the createIfNotExists option is true or false. Requests are sent in batches of 1,000 records.

This method is subject to indexing rate limits and connector limits.

If you use this method to update records in a collection, include all attributes referenced in the collection’s conditions. Even though this method uses partial updates, conditions are re-evaluated whenever the records update. Missing attributes can prevent records from matching the collection’s conditions.

Usage

C#

var response = await client.PartialUpdateObjectsWithTransformationAsync(
  "INDEX_NAME",
  new List<Object>
  {
    new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
    new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
  },
  true,
  true
);

Parameters

Go

indexName · string · required

Name of the index to update records in.

objects · []map[string]any · required

Records to update.

opts... · PartialUpdateObjectsOption

Functional options to provide extra arguments.

Show available functions

search.WithCreateIfNotExists · function

Signature: func(createIfNotExists bool) partialUpdateObjectsOption

Whether to add new records to the index if they don’t exist yet. By default, this function returns true.

search.WithBatchSize · function

Signature: func(batchSize int) chunkedBatchOption

Sets the number of records 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

Name of the index to update records in.

objects · Iterable<T> · required

Records to update.

T · Type parameter · required

The model of your index’s records.

createIfNotExists · boolean · required

Whether to add new records to the index if they don’t exist yet.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Name of the index to update records in.

objects · Record<string,unknown>[] · required

Records to update.

createIfNotExists · boolean · default: "undefined"

Whether to add new records to the index if they don’t exist yet.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

PHP

indexName · string · required

Name of the index to update records in.

objects · array · required

Records to update.

createIfNotExists · bool · required

Whether to add new records to the index if they don’t exist yet.

requestOptions · array

Additional request options.

Python

index_name · str · required

Name of the index to update records in.

objects · list[dict] · required

Records to update.

create_if_not_exists · bool · default: "False"

Whether to add new records to the index if they don’t exist yet.

wait_for_task · bool · default: "False"

Whether to wait until all batch requests are done.

request_options · dict | RequestOptions

Additional request options.