API Reference / API Methods / Synonyms / Replace all synonyms

Replace All Synonyms

Required API Key: any key with the editSettings ACL
Method signature
$index->replaceAllSynonyms(array synonyms);
$index->replaceAllSynonyms(array synonyms, [
  'forwardToReplicas' => boolean
]);

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

Push a new set of synonyms and erase all previous ones.

This method, like replaceAllObjects, guarantees zero downtime.

All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation.

Examples

Replace all synonyms

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

$synonyms = /* Fetch your synonyms */;

$index = $client->initIndex('your_index_name');
$index->replaceAllSynonyms($synonyms);

// Or if you want to also replace synonyms on replicas
$index->replaceAllSynonyms($synonyms, ['forwardToReplicas' => true]);

Parameters

synonyms
type: list
Required

A list of synonyms

forwardToReplicas
type: boolean
default: false
Optional

Also replace synonyms on replicas

requestOptions
type: key/value mapping
default: No request options
Optional

A mapping of request options to send along with the request.

Response

No response

Did you find this page helpful?