API Reference / API Methods / Indexing / Replace all objects

Jan. 28, 2022

Replace All Objects

A

Required API Key: Admin

Method signature

$index->replaceAllObjects(array objects);

$index->replaceAllObjects(array objects, [
  // All the following parameters are optional
  'safe' => bool,
]);

index.replace_all_objects(Array objects)

index.replace_all_objects(Array objects, Hash opts = {
  bool safe: false
})

index.replaceAllObjects(array objects)

index.replaceAllObjects(array objects, {
    // All the following parameters are optional
    safe: bool,
    // + any requestOptions
})

index.replace_all_objects(list objects)

index.replace_all_objects(list objects, {
    // All the following parameters are optional
    'safe' => bool
})

index.replaceAllObjects<T: Encodable>(
  with objects: [T],
  autoGeneratingObjectID: Bool = false,
  safe: Bool = false,
  requestOptions: RequestOptions? = nil,
  completion: Result<[IndexedTask]> -> Void  
) throws

suspend fun Index.replaceAllObjects(
    records: List<JsonObject>
): List<Task>

suspend fun <T : Indexable> Index.replaceAllObjects(
    serializer: KSerializer<T>,
    records: List<T>
): List<Task>

index.ReplaceAllObjects(
  IEnumerable<T> objects,

  // All the following parameters are optional
  safe: bool
);

index.replaceAllObjects(Iterable<T> objects);
index.replaceAllObjects(Iterable<T> objects, Boolean safe);

index.ReplaceAllObjects([]Object objects)

Not implemented yet.

See the example section

See code examples

About this method # A

Clears all objects from your index and replaces them with a new set of objects.

Only your objects are replaced: settings, synonyms, and query rules aren’t modified. This method replaces all records in an index without any downtime.

Behind the scenes, replaceAllObjects uses a temporary index and:

Copies your index’s settings, synonyms, and query rules to the temporary index
Adds your objects to the temporary index
Replaces your index with the temporary one.

If the API key has restricted index access, the API will return an error when attempting this operation. To fix this, make sure your API key has access to yourIndex and yourIndex_tmp_*.

Using this method can significantly increase your indexing operations and record count. It costs the number of new records + 2 operations (copySettings and moveIndex). For example, replacing all objects of an index with a new set of a million objects costs one million (and two) operations. Because your main and temporary index both have one million records, your application will temporarily host two million records. Make sure you don’t exceed your record limit, and be careful of the impact on your operations count.

Examples # A

Replace all objects#

Copy

1
2
3
4
5
6
7
8
9
$client = Algolia\AlgoliaSearch\SearchClient::create(
  'AJ0P3S7DWQ',
  '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb'
);

$objects = /* Fetch your objects */;

$index = $client->initIndex('your_index_name');
$index->replaceAllObjects($objects);

1
2
3
4
5
6
7
8
client = Algolia::Search::Client.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

objects = [
  # your new objects
]

index = client.init_index('your_index_name')
index.replace_all_objects(objects)

1
2
3
4
5
6
7
8
9
const client = algoliasearch('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb');

const objects = []; // Fetch your objects

const index = client.initIndex('your_index_name');

index.replaceAllObjects(objects).then(({ objectIDs }) => {
  console.log(objectIDs);
});

1
2
3
4
5
6
client = SearchClient.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

objects = [] # Fetch your objects

index = client.init_index('your_index_name')
index.replace_all_objects(objects)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
struct Contact: Encodable {
  let objectID: ObjectID
  let firstname: String
  let lastname: String
}

let client = SearchClient(appID: "AJ0P3S7DWQ", apiKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
let index = client.index(withName: "your_index_name")

let objects: [Contact]! = [/*Fetch your objects*/]

index.replaceAllObjects(with: objects) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
var client = new SearchClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");
var index = client.InitIndex("your_index_name");

var objects = /* Fetch your objects */;
index.ReplaceAllObjects(objects);

1
2
3
4
5
6
7
8
9
10
11
12
13
SearchClient client =
DefaultSearchClient.create("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");

SearchIndex<Contact> index = client.initIndex("your_index_name", Contact.class);

// Fetch your objects
List<Contact> objects = new ArrayList<>();

// Sync version
index.replaceAllObjects(objects);

// Async version
index.replaceAllObjectsAsync(objects);

1
2
3
4
5
6
7
8
9
10
11
12
package main

import "github.com/algolia/algoliasearch-client-go/v3/algolia/search"

func main() {
    client := search.NewClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
    index := client.InitIndex("your_index_name")

    objects := []Object{ /* Fetch your objects */ }

    res, err := index.ReplaceAllObjects(objects)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
import algolia.AlgoliaClient
import algolia.AlgoliaDsl._
import algolia.responses._

import scala.concurrent.duration._
import scala.concurrent.duration.FiniteDuration
import scala.concurrent.{Await, ExecutionContext, ExecutionContextExecutor, Future}

case class MyCaseClass(objectID: String, /* ... */) extends ObjectID

object Main {

  def main(args: Array[String]): Unit = {

    implicit val ec: ExecutionContextExecutor = ExecutionContext.global
    implicit val awaitDuration: FiniteDuration = 10 seconds

    val client = new AlgoliaClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
    val tmpIndexName = "atomic_reindex_tmp"
    val indexName = "atomic_reindex"

    // 1. Copy the settings, synonyms and rules (but not the records)
    // of the target index into the temporary index
    val copyTask = Await.result(
      client.execute(copy index indexName to tmpIndexName scope Seq("settings", "synonyms", "rules")),
      awaitDuration
    )
    client.execute(waitFor task copyTask from indexName)

    // 2. Fetch your data and push it to the temporary index
    val objects: Seq[MyCaseClass] = Seq(/* ... */)

    // Here is where you push your data to the temporary index
    val batchTasks = Await.result(
      Future.sequence(objects.grouped(1000).map(batch => client.execute(index into tmpIndexName objects batch))),
      awaitDuration
    )

    Await.result(
      Future.sequence(batchTasks.map(task => client.execute(waitFor task task from tmpIndexName))),
      awaitDuration
    )

    // 3. Move the temporary index to the target index
    client.execute(move index tmpIndexName to indexName)
  }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// With JsonObject
val json = listOf(
    json {
        "firstname" to "Jimmie"
        "lastname" to "Barninger"
    },
    json {
        "firstname" to "Warren"
        "lastname" to "Speach"
    }
)

index.replaceAllObjects(json)

// With serializable class
@Serializable
data class Contact(val firstname: String, val lastname: String)

val contacts = listOf(
    Contact("Jimmie", "Barninger"),
    Contact("Warren", "Speach")
)

index.replaceAllObjects(Contact.serializer(), contacts)

Replace all objects and wait for operations#

Copy

1
2
3
4
5
6
7
8
9
10
11
$client = Algolia\AlgoliaSearch\SearchClient::create(
  'AJ0P3S7DWQ',
  '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb'
);

$objects = /* Fetch your objects */;

$index = $client->initIndex('your_index_name');
$index->replaceAllObjects($objects, [
  'safe' => true,
]);

1
2
3
4
5
6
7
8
client = Algolia::Search::Client.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

objects = [
  # your new objects
]

index = client.init_index('your_index_name')
index.replace_all_objects(objects, { safe: true })

1
2
3
4
5
6
7
8
9
const client = algoliasearch('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb');

const objects = []; // Fetch your objects

const index = client.initIndex('your_index_name');

index.replaceAllObjects(objects, { safe: true }).then(({ objectIDs }) => {
  console.log(objectIDs);
});

1
2
3
4
5
6
7
8
client = SearchClient.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

objects = [] # Fetch your objects

index = client.init_index('your_index_name')
index.replace_all_objects(objects, {
    'safe': True
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
struct Contact: Encodable {
  let objectID: ObjectID
  let firstname: String
  let lastname: String
}

let client = SearchClient(appID: "AJ0P3S7DWQ", apiKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
let index = client.index(withName: "your_index_name")

let objects: [Contact]! = [/*Fetch your objects*/]

index.replaceAllObjects(with: objects, safe: true) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
var client = new SearchClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");
var index = client.InitIndex("your_index_name");

var objects = /* Fetch your objects */;
index.ReplaceAllObjects(objects, true);

1
2
3
4
5
6
7
8
9
SearchClient client =
DefaultSearchClient.create("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");

SearchIndex<Contact> index = client.initIndex("your_index_name", Contact.class);

// Fetch your objects
List<Contact> objects = new ArrayList<>();

index.replaceAllObjects(objects, true);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package main

import (
  "github.com/algolia/algoliasearch-client-go/v3/algolia/opt"
  "github.com/algolia/algoliasearch-client-go/v3/algolia/search"
)

func main() {
    client := search.NewClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
    index := client.InitIndex("your_index_name")

    objects := []Object{ /* Fetch your objects */ }

    res, err := index.ReplaceAllObjects(objects, opt.Safe(true))
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
import algolia.AlgoliaClient
import algolia.AlgoliaDsl._
import algolia.responses._

import scala.concurrent.duration._
import scala.concurrent.duration.FiniteDuration
import scala.concurrent.{Await, ExecutionContext, ExecutionContextExecutor, Future}

case class MyCaseClass(objectID: String, /* ... */) extends ObjectID

object Main {

  def main(args: Array[String]): Unit = {

    implicit val ec: ExecutionContextExecutor = ExecutionContext.global
    implicit val awaitDuration: FiniteDuration = 10 seconds

    val client = new AlgoliaClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
    val tmpIndexName = "atomic_reindex_tmp"
    val indexName = "atomic_reindex"

    // 1. Copy the settings, synonyms and rules (but not the records)
    // of the target index into the temporary index
    val copyTask = Await.result(
      client.execute(copy index indexName to tmpIndexName scope Seq("settings", "synonyms", "rules")),
      awaitDuration
    )
    client.execute(waitFor task copyTask from indexName)

    // 2. Fetch your data and push it to the temporary index
    val objects: Seq[MyCaseClass] = Seq(/* ... */)

    // Here is where you push your data to the temporary index
    val batchTasks = Await.result(
      Future.sequence(objects.grouped(1000).map(batch => client.execute(index into tmpIndexName objects batch))),
      awaitDuration
    )

    Await.result(
      Future.sequence(batchTasks.map(task => client.execute(waitFor task task from tmpIndexName))),
      awaitDuration
    )

    // 3. Move the temporary index to the target index
    client.execute(move index tmpIndexName to indexName)
  }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
client.apply {
  val json = listOf(
      json {
          "firstname" to "Jimmie"
          "lastname" to "Barninger"
      },
      json {
          "firstname" to "Warren"
          "lastname" to "Speach"
      }
  )

  index.replaceAllObjects(json).waitAll()
}

Parameters # A

`objects` #	type: list Required A schemaless set of key-value pairs representing index attributes.
`safe` #	type: boolean default: false Optional Whether to wait for indexing operations.
`requestOptions` #	type: key-value mapping default: No request options Optional A mapping of `requestOptions` to send along with the query.

Response # A

No response

Did you find this page helpful?

PHP v3