Replace all records

Required ACL: addObject, deleteIndex (optional, for cleanup after a failed operation) This helper method replaces all records in an index without interrupting ongoing searches. It combines batch and copy/move index operations:

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

Notes:

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 creates a temporary index, so your record count can temporarily double during the operation. Algolia doesn’t count the three days with the highest number of records towards usage.
This method is subject to indexing rate limits.
If the operation fails, the original index isn’t replaced. The client can delete the temporary index only if your API key has the deleteIndex ACL.

The response includes the results of the individual API requests.

Usage

var response = await client.ReplaceAllObjectsAsync(
  "INDEX_NAME",
  new List<Object>
  {
    new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
    new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
  },
  77,
  new List<ScopeType> { Enum.Parse<ScopeType>("Settings"), Enum.Parse<ScopeType>("Synonyms") }
);

response, err := client.ReplaceAllObjects(
  "INDEX_NAME",
  []map[string]any{{"objectID": "1", "name": "Adam"}, {"objectID": "2", "name": "Benoit"}}, search.WithBatchSize(77), search.WithScopes(
    []search.ScopeType{search.ScopeType("settings"), search.ScopeType("synonyms")}))
if err != nil {
  // handle the eventual error
  panic(err)
}

ReplaceAllObjectsResponse response = client.replaceAllObjects(
  "INDEX_NAME",
  Arrays.asList(
    new HashMap() {
      {
        put("objectID", "1");
        put("name", "Adam");
      }
    },
    new HashMap() {
      {
        put("objectID", "2");
        put("name", "Benoit");
      }
    }
  ),
  77,
  Arrays.asList(ScopeType.SETTINGS, ScopeType.SYNONYMS)
);

const response = await client.replaceAllObjects({
  indexName: 'cts_e2e_replace_all_objects_scopes_javascript',
  objects: [
    { objectID: '1', name: 'Adam' },
    { objectID: '2', name: 'Benoit' },
  ],
  batchSize: 77,
  scopes: ['settings', 'synonyms'],
});

var response =
  client.replaceAllObjects(
    indexName = "INDEX_NAME",
    objects =
      listOf(
        buildJsonObject {
          put("objectID", JsonPrimitive("1"))
          put("name", JsonPrimitive("Adam"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("2"))
          put("name", JsonPrimitive("Benoit"))
        },
      ),
    batchSize = 77,
    scopes =
      listOf(
        ScopeType.entries.first { it.value == "settings" },
        ScopeType.entries.first { it.value == "synonyms" },
      ),
  )

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

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

        'synonyms',
    ],
);

response = client.replace_all_objects(
    index_name="INDEX_NAME",
    objects=[
        {
            "objectID": "1",
            "name": "Adam",
        },
        {
            "objectID": "2",
            "name": "Benoit",
        },
    ],
    batch_size=77,
    scopes=[
        "settings",
        "synonyms",
    ],
)

response = client.replace_all_objects(
  "INDEX_NAME",
  [{objectID: "1", name: "Adam"}, {objectID: "2", name: "Benoit"}],
  77,
  ["settings", "synonyms"]
)

val response = Await.result(
  client.replaceAllObjects(
    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"))))
    ),
    batchSize = 77,
    scopes = Some(Seq(ScopeType.withName("settings"), ScopeType.withName("synonyms")))
  ),
  Duration(100, "sec")
)

let response = try await client.replaceAllObjects(
    indexName: "INDEX_NAME",
    objects: [["objectID": "1", "name": "Adam"], ["objectID": "2", "name": "Benoit"]],
    batchSize: 77,
    scopes: [ScopeType.settings, ScopeType.synonyms]
)

Parameters

string

required

Name of the index in which to replace records.

IEnumerable<T>

required

Records that replace the existing records in your index.

type parameter

required

The model of your index’s records.

int

default:1000

Number of records to process in one batch.

List<ScopeType>

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

CancellationToken

default:"default"

Parameter that can be used as a signal to cancel this request.

string

required

Name of the index in which to replace records.

[]map[string]any

required

Records that replace the existing records in your index.

ReplaceAllObjectsOption

Functional options to provide extra arguments.

Show available functions

function

Signature: func(scopes []ScopeType) replaceAllObjectsOptionScopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

function

Signature: func(batchSize int) chunkedBatchOptionNumber of records to process in one batch. The default batch size is 1,000.

function

Signature: func(withWaitForTasks bool) chunkedBatchOptionWhether to wait until all batch requests are done.

function

Signature: func(key string, value string) requestOptionSets extra header parameters for this request. To learn more, see request options.

function

Signature: func(key string, value string) requestOptionSets extra query parameters for this request. To learn more, see request options.

String

required

Name of the index in which to replace records.

Iterable<T>

required

Records that replace the existing records in your index.

Type parameter

required

The model of your index’s records.

int

required

Number of records to process in one batch.

List<ScopeType>

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

string

required

Name of the index in which to replace records.

Record<string,unknown>[]

required

Records that replace the existing records in your index.

number

default:1000

Number of records to process in one batch.

string[]

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

String

required

Name of the index in which to replace records.

List<JsonObject>

required

Records that replace the existing records in your index.

Int

default:1000

Number of records to process in one batch.

List<ScopeType>

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

string

required

Name of the index in which to replace records.

array

required

Records that replace the existing records in your index.

int

default:1000

Number of records to process in one batch.

array

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

array

Additional request options.

str

required

Name of the index in which to replace records.

list[dict]

required

Records that replace the existing records in your index.

int

default:1000

Number of records to process in one batch.

list[str]

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

String

required

Name of the index in which to replace records.

Array[Hash]

required

Records that replace the existing records in your index.

Integer

default:1000

Number of records to process in one batch.

Array[String]

required

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

Hash

Additional request options.

String

required

Name of the index in which to replace records.

Seq[JObject]

required

Records that replace the existing records in your index.

Int

default:1000

Number of records to process in one batch.

Seq[ScopeType]

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

String

required

Name of the index in which to replace records.

[Encodable]

required

Records that replace the existing records in your index.

Int

default:1000

Number of records to process in one batch.

[ScopeType]

Scopes to include in the replacement operation. Use one or more ScopeType values. For the allowed values, see Scope types.

RequestOptions

Additional request options.

API clients (current)

Reference

Replace all records

Usage

Parameters

​Usage

​Parameters

Usage

Parameters