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, you must create a push connector.

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.

This operation is subject to indexing rate limits.

Usage

C#

var response = await client.PartialUpdateObjectsWithTransformationAsync(
  "ALGOLIA_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.