Save records with transformation

Adds records to an index using the transformation pipeline.

Required ACL: addObject

Before using this method, set up transformation options 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 push tasks with the addObject action and sends these requests in batches of 1,000.

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

Usage

C#

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

final response = await client.saveObjectsWithTransformation(
  indexName: "INDEX_NAME",
  objects: [
    {
      'objectID': "1",
      'name': "Adam",
    },
    {
      'objectID': "2",
      'name': "Benoit",
    },
  ],
  waitForTasks: true,
);

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

List response = client.saveObjectsWithTransformation(
  "INDEX_NAME",
  Arrays.asList(
    new HashMap() {
      {
        put("objectID", "1");
        put("name", "Adam");
      }
    },
    new HashMap() {
      {
        put("objectID", "2");
        put("name", "Benoit");
      }
    }
  ),
  true
);

const response = await client.saveObjectsWithTransformation({
  indexName: 'cts_e2e_saveObjectsWithTransformation_javascript',
  objects: [
    { objectID: '1', name: 'Adam' },
    { objectID: '2', name: 'Benoit' },
  ],
  waitForTasks: true,
});

var response =
  client.saveObjectsWithTransformation(
    indexName = "INDEX_NAME",
    objects =
      listOf(
        buildJsonObject {
          put("objectID", JsonPrimitive("1"))
          put("name", JsonPrimitive("Adam"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("2"))
          put("name", JsonPrimitive("Benoit"))
        },
      ),
    waitForTasks = true,
  )

$response = $client->saveObjectsWithTransformation(
    'INDEX_NAME',
    [
        ['objectID' => '1',
            'name' => 'Adam',
        ],

        ['objectID' => '2',
            'name' => 'Benoit',
        ],
    ],
    true,
);

response = client.save_objects_with_transformation(
    index_name="INDEX_NAME",
    objects=[
        {
            "objectID": "1",
            "name": "Adam",
        },
        {
            "objectID": "2",
            "name": "Benoit",
        },
    ],
    wait_for_tasks=True,
)

response = client.save_objects_with_transformation(
  "INDEX_NAME",
  [{objectID: "1", name: "Adam"}, {objectID: "2", name: "Benoit"}],
  true
)

val response = Await.result(
  client.saveObjectsWithTransformation(
    indexName = "INDEX_NAME",
    objects = Seq(
      JObject(List(JField("objectID", JString("1")), JField("name", JString("Adam")))),
      JObject(List(JField("objectID", JString("2")), JField("name", JString("Benoit"))))
    ),
    waitForTasks = true
  ),
  Duration(100, "sec")
)

let response = try await client.saveObjectsWithTransformation(
    indexName: "INDEX_NAME",
    objects: [["objectID": "1", "name": "Adam"], ["objectID": "2", "name": "Benoit"]],
    waitForTasks: true
)

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.

Java

indexName · String · required

Name of the index to save records to.

objects · Iterable<T> · required

Records to save.

T · Type parameter · required

The model of your index’s records.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

batchSize · int · default: 1000

Number of records to process in one batch.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Name of the index to save records to.

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

Records to save.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

batchSize · number · default: 1000

Number of records to process in one batch.

requestOptions · RequestOptions

Additional request options.

PHP

indexName · string · required

Name of the index to save records to.

objects · array · required

Records to save.

waitForTasks · bool · default: false

Whether to wait until all batch requests are done.

batchSize · int · default: 1000

Number of records to process in one batch.

requestOptions · array

Additional request options.

Python

index_name · str · required

Name of the index to save records to.

objects · list[dict] · required

Records to save.

wait_for_tasks · bool · default: false

Whether to wait until all batch requests are done.

batch_size · int · default: 1000

Number of records to process in one batch.

request_options · dict | RequestOptions

Additional request options.