Save records with transformation

Adds records to an index using the transformation pipeline.

Required ACL: addObject

Before using this method, you must create a push connector.

This helper method creates push tasks with the addObject action and sents these requests in batches of 1,000.

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

Usage

Go

response, err := client.SaveObjectsWithTransformation(
  "ALGOLIA_INDEX_NAME",
  []map[string]any{map[string]any{"objectID": "1", "name": "Adam"}, map[string]any{"objectID": "2", "name": "Benoit"}}, search.WithWaitForTasks(true))
if err != nil {
  // handle the eventual error
  panic(err)
}

Parameters

Go

indexName · string · required

Name of the index to save records to.

objects · []map[string]any · required

Records to save.

opts... · ChunkedBatchOption

Functional options to provide extra arguments.

Show available functions

search.WithWaitForTasks · function

Signature: func(withWaitForTasks bool) chunkedBatchOption

Whether to wait until all batch requests are done.

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.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.