Replace all records with transformation

Replaces all records in an index with new ones, 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 replaces all records in an index without interrupting ongoing searches.

It combines batch and copy/move index operations:

1. Copy settings, synonyms, and rules to a temporary index.
2. Add the records from the objects parameter to the temporary index.
3. Replace the original index with the temporary one.

If your API key restricts access to specific indices, make sure it also grants access to the temporary index INDEX_NAME_tmp_* (replace INDEX_NAME with the name of your original index).

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

The response includes the results of the individual API requests.

Usage

C#

var response = await client.ReplaceAllObjectsWithTransformationAsync(
  "INDEX_NAME",
  new List<Object>
  {
    new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
    new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
    new Dictionary<string, string> { { "objectID", "3" }, { "name", "Cyril" } },
    new Dictionary<string, string> { { "objectID", "4" }, { "name", "David" } },
    new Dictionary<string, string> { { "objectID", "5" }, { "name", "Eva" } },
    new Dictionary<string, string> { { "objectID", "6" }, { "name", "Fiona" } },
    new Dictionary<string, string> { { "objectID", "7" }, { "name", "Gael" } },
    new Dictionary<string, string> { { "objectID", "8" }, { "name", "Hugo" } },
    new Dictionary<string, string> { { "objectID", "9" }, { "name", "Igor" } },
    new Dictionary<string, string> { { "objectID", "10" }, { "name", "Julia" } },
  },
  3
);

final response = await client.replaceAllObjectsWithTransformation(
  indexName: "INDEX_NAME",
  objects: [
    {
      'objectID': "1",
      'name': "Adam",
    },
    {
      'objectID': "2",
      'name': "Benoit",
    },
    {
      'objectID': "3",
      'name': "Cyril",
    },
    {
      'objectID': "4",
      'name': "David",
    },
    {
      'objectID': "5",
      'name': "Eva",
    },
    {
      'objectID': "6",
      'name': "Fiona",
    },
    {
      'objectID': "7",
      'name': "Gael",
    },
    {
      'objectID': "8",
      'name': "Hugo",
    },
    {
      'objectID': "9",
      'name': "Igor",
    },
    {
      'objectID': "10",
      'name': "Julia",
    },
  ],
  batchSize: 3,
);

response, err := client.ReplaceAllObjectsWithTransformation(
  "INDEX_NAME",
  []map[string]any{
    {"objectID": "1", "name": "Adam"},
    {"objectID": "2", "name": "Benoit"},
    {"objectID": "3", "name": "Cyril"},
    {"objectID": "4", "name": "David"},
    {"objectID": "5", "name": "Eva"},
    {"objectID": "6", "name": "Fiona"},
    {"objectID": "7", "name": "Gael"},
    {"objectID": "8", "name": "Hugo"},
    {"objectID": "9", "name": "Igor"},
    {"objectID": "10", "name": "Julia"},
  },
  search.WithBatchSize(3),
)
if err != nil {
  // handle the eventual error
  panic(err)
}

ReplaceAllObjectsWithTransformationResponse response = client.replaceAllObjectsWithTransformation(
  "INDEX_NAME",
  Arrays.asList(
    new HashMap() {
      {
        put("objectID", "1");
        put("name", "Adam");
      }
    },
    new HashMap() {
      {
        put("objectID", "2");
        put("name", "Benoit");
      }
    },
    new HashMap() {
      {
        put("objectID", "3");
        put("name", "Cyril");
      }
    },
    new HashMap() {
      {
        put("objectID", "4");
        put("name", "David");
      }
    },
    new HashMap() {
      {
        put("objectID", "5");
        put("name", "Eva");
      }
    },
    new HashMap() {
      {
        put("objectID", "6");
        put("name", "Fiona");
      }
    },
    new HashMap() {
      {
        put("objectID", "7");
        put("name", "Gael");
      }
    },
    new HashMap() {
      {
        put("objectID", "8");
        put("name", "Hugo");
      }
    },
    new HashMap() {
      {
        put("objectID", "9");
        put("name", "Igor");
      }
    },
    new HashMap() {
      {
        put("objectID", "10");
        put("name", "Julia");
      }
    }
  ),
  3
);

const response = await client.replaceAllObjectsWithTransformation({
  indexName: 'cts_e2e_replace_all_objects_with_transformation_javascript',
  objects: [
    { objectID: '1', name: 'Adam' },
    { objectID: '2', name: 'Benoit' },
    { objectID: '3', name: 'Cyril' },
    { objectID: '4', name: 'David' },
    { objectID: '5', name: 'Eva' },
    { objectID: '6', name: 'Fiona' },
    { objectID: '7', name: 'Gael' },
    { objectID: '8', name: 'Hugo' },
    { objectID: '9', name: 'Igor' },
    { objectID: '10', name: 'Julia' },
  ],
  batchSize: 3,
});

var response =
  client.replaceAllObjectsWithTransformation(
    indexName = "INDEX_NAME",
    objects =
      listOf(
        buildJsonObject {
          put("objectID", JsonPrimitive("1"))
          put("name", JsonPrimitive("Adam"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("2"))
          put("name", JsonPrimitive("Benoit"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("3"))
          put("name", JsonPrimitive("Cyril"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("4"))
          put("name", JsonPrimitive("David"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("5"))
          put("name", JsonPrimitive("Eva"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("6"))
          put("name", JsonPrimitive("Fiona"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("7"))
          put("name", JsonPrimitive("Gael"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("8"))
          put("name", JsonPrimitive("Hugo"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("9"))
          put("name", JsonPrimitive("Igor"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("10"))
          put("name", JsonPrimitive("Julia"))
        },
      ),
    batchSize = 3,
  )

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

        ['objectID' => '2',
            'name' => 'Benoit',
        ],

        ['objectID' => '3',
            'name' => 'Cyril',
        ],

        ['objectID' => '4',
            'name' => 'David',
        ],

        ['objectID' => '5',
            'name' => 'Eva',
        ],

        ['objectID' => '6',
            'name' => 'Fiona',
        ],

        ['objectID' => '7',
            'name' => 'Gael',
        ],

        ['objectID' => '8',
            'name' => 'Hugo',
        ],

        ['objectID' => '9',
            'name' => 'Igor',
        ],

        ['objectID' => '10',
            'name' => 'Julia',
        ],
    ],
    3,
);

response = client.replace_all_objects_with_transformation(
    index_name="INDEX_NAME",
    objects=[
        {
            "objectID": "1",
            "name": "Adam",
        },
        {
            "objectID": "2",
            "name": "Benoit",
        },
        {
            "objectID": "3",
            "name": "Cyril",
        },
        {
            "objectID": "4",
            "name": "David",
        },
        {
            "objectID": "5",
            "name": "Eva",
        },
        {
            "objectID": "6",
            "name": "Fiona",
        },
        {
            "objectID": "7",
            "name": "Gael",
        },
        {
            "objectID": "8",
            "name": "Hugo",
        },
        {
            "objectID": "9",
            "name": "Igor",
        },
        {
            "objectID": "10",
            "name": "Julia",
        },
    ],
    batch_size=3,
)

response = client.replace_all_objects_with_transformation(
  "INDEX_NAME",
  [
    {objectID: "1", name: "Adam"},
    {objectID: "2", name: "Benoit"},
    {objectID: "3", name: "Cyril"},
    {objectID: "4", name: "David"},
    {objectID: "5", name: "Eva"},
    {objectID: "6", name: "Fiona"},
    {objectID: "7", name: "Gael"},
    {objectID: "8", name: "Hugo"},
    {objectID: "9", name: "Igor"},
    {objectID: "10", name: "Julia"}
  ],
  3
)

val response = Await.result(
  client.replaceAllObjectsWithTransformation(
    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")))),
      JObject(List(JField("objectID", JString("3")), JField("name", JString("Cyril")))),
      JObject(List(JField("objectID", JString("4")), JField("name", JString("David")))),
      JObject(List(JField("objectID", JString("5")), JField("name", JString("Eva")))),
      JObject(List(JField("objectID", JString("6")), JField("name", JString("Fiona")))),
      JObject(List(JField("objectID", JString("7")), JField("name", JString("Gael")))),
      JObject(List(JField("objectID", JString("8")), JField("name", JString("Hugo")))),
      JObject(List(JField("objectID", JString("9")), JField("name", JString("Igor")))),
      JObject(List(JField("objectID", JString("10")), JField("name", JString("Julia"))))
    ),
    batchSize = 3
  ),
  Duration(100, "sec")
)

let response = try await client.replaceAllObjectsWithTransformation(
    indexName: "INDEX_NAME",
    objects: [
        ["objectID": "1", "name": "Adam"],
        ["objectID": "2", "name": "Benoit"],
        ["objectID": "3", "name": "Cyril"],
        ["objectID": "4", "name": "David"],
        ["objectID": "5", "name": "Eva"],
        ["objectID": "6", "name": "Fiona"],
        ["objectID": "7", "name": "Gael"],
        ["objectID": "8", "name": "Hugo"],
        ["objectID": "9", "name": "Igor"],
        ["objectID": "10", "name": "Julia"],
    ],
    batchSize: 3
)

Parameters

Go

indexName · string · required

Name of the index in which to replace records.

objects · []map[string]any · required

Records that replace the existing records in your index.

opts... · replaceAllObjectsOption

Functional options to provide extra arguments.

Show available functions

search.WithScopes · function

Signature: func(scopes []ScopeType) replaceAllObjectsOption

Scopes to include in the replacement operation. Can be one or more of settings, synonyms, or rules. For more details, see Scope types.

search.WithBatchSize · function

Signature: func(batchSize int) chunkedBatchOption

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 in which to replace records.

objects · Iterable<T> · required

Records that replace the existing records in your index.

T · Type parameter · required

The model of your index’s records.

scopes · List<ScopeType> · required

Scopes to include in the replacement operation. Can be one or more of settings, synonyms, or rules. For more details, see Scope types.

batchSize · int · required

Number of records to process in one batch.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Name of the index in which to replace records.

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

Records that replace the existing records in your index.

scopes · string[] · required

Scopes to include in the replacement operation.

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 in which to replace records.

objects · array · required

Records that replace the existing records in your index.

batchSize · int · default: 1000

Number of records to process in one batch.

scopes · array · required

Scopes to include in the replacement operation.

requestOptions · array

Additional request options.

Python

index_name · str · required

Name of the index in which to replace records.

objects · list[dict] · required

Records that replace the existing records in your index.

scopes · list[str] · required

Scopes to include in the replacement operation.

batch_size · int · default: 1000

Number of records to process in one batch.

request_options · dict | RequestOptions

Additional request options.