Replace All Objects | Ruby API Client V1 (Deprecated)
This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.
About this method
Clears all objects from your index and replaces them with a new set of objects.
Only your objects are replaced: all settings, synonyms, and query rules are untouched.
This method performs an atomic reindex: it replaces all records in an index without any downtime.
This method uses a temporary index. First, it copies your index’s settings, synonyms, and query rules to the temporary index. Then, it adds the objects you passed to the temporary index. Finally, it replaces your index with the temporary one.
Before replacing all objects, make sure your source index exists. Our API creates a job even when an index doesn’t exist, but because it has no source index, the job won’t be able to end. If you perform a
waitTask for this job, or set the
safe parameter to true while the source index doesn’t exist, the wait will never resolve.
Using this method can significantly increase your indexing operations count. It costs the number of new records + 2 operations (
moveIndex). For example, replacing all objects of an index with a new set of a million objects costs one million (and two) operations. Make sure you don’t exceed your record limit, and be careful of the impact on your operations count.
Behind the scenes, using this method will generate a new, temporary index. If the API key used 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
Replace all objects
1 2 3 4 5 6 7 8 9 $client = Algolia\AlgoliaSearch\SearchClient::create( 'YourApplicationID', 'YourWriteAPIKey' ); $objects = /* Fetch your objects */; $index = $client->initIndex('your_index_name'); $index->replaceAllObjects($objects);
Replace all objects and wait for operations
1 2 3 4 5 6 7 8 9 10 11 $client = Algolia\AlgoliaSearch\SearchClient::create( 'YourApplicationID', 'YourWriteAPIKey' ); $objects = /* Fetch your objects */; $index = $client->initIndex('your_index_name'); $index->replaceAllObjects($objects, [ 'safe' => true, ]);
A schemaless set of key/value pairs representing index attributes.
Whether to wait for indexing operations.
type: key/value mapping
default: No request options
A mapping of request options to send along with the query.