Replace all records

Replaces all records in an index with new ones.

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:

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.

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

C#

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") }
);

Parameters

C#

indexName · string · required

Name of the index in which to replace records.

objects · IEnumerable<T> · required

Records that replace the existing records in your index.

T · type parameter · required

The model of your index’s records.

batchSize · int · default: 1000

Number of records to process in one batch.

scopes · List<ScopeType> · required

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

requestOptions · RequestOptions

Additional request options.

cancellationToken · CancellationToken · default: "default"

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

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. Use one or more ScopeType values. For the allowed values, 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.

batchSize · int · required

Number of records to process in one batch.

scopes · List<ScopeType> · required

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

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.

batchSize · number · default: 1000

Number of records to process in one batch.

scopes · string[] · required

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

requestOptions · RequestOptions

Additional request options.

Kotlin

indexName · String · required

Name of the index in which to replace records.

objects · List<JsonObject> · required

Records that replace the existing records in your index.

batchSize · Int · default: 1000

Number of records to process in one batch.

scopes · List<ScopeType> · required

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

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. Use one or more ScopeType values. For the allowed values, see Scope types.

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.

batch_size · int · default: 1000

Number of records to process in one batch.

scopes · list[str] · required

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

requestOptions · RequestOptions

Additional request options.

Ruby

index_name · String · required

Name of the index in which to replace records.

objects · Array[Hash] · required

Records that replace the existing records in your index.

batchSize · Integer · default: 1000

Number of records to process in one batch.

scopes · Array[String] · required

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

requestOptions · Hash

Additional request options.

Scala

indexName · String · required

Name of the index in which to replace records.

objects · Seq[JObject] · required

Records that replace the existing records in your index.

batchSize · Int · default: 1000

Number of records to process in one batch.

scopes · Seq[ScopeType]

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

requestOptions · RequestOptions

Additional request options.

Swift

indexName · String · required

Name of the index in which to replace records.

objects · [Encodable] · required

Records that replace the existing records in your index.

batchSize · Int · default: 1000

Number of records to process in one batch.

scopes · [ScopeType]

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

requestOptions · RequestOptions

Additional request options.