API Reference / API Methods / Synonyms / Clear all synonyms
Required API Key: any key with the editSettings ACL
Method signature
$index->clearSynonyms([
  'forwardToReplicas' => boolean
])

About this method # A

Remove all synonyms from an index.

This is a convenience method to delete all synonyms at once.

This Clear All method should not be used on a production index to push a new list of synonyms because it will result in a short down period during which the index would have no synonyms at all. Instead, use the saveSynonyms (with replaceExistingSynonyms set to true) to atomically replace all synonyms of an index with no down time.

Examples # A

Clear all synonyms and forward to replicas#

1
2
3
$index->clearSynonyms([
  'forwardToReplicas' => true
]);

Parameters # A

forwardToReplicas #
type: boolean
default: false
optional

Will delete synonyms on all replicas. Without this parameter, or by setting it to false, the method sill apply the change only to the specified index. If you want to forward your deletes to your replicas you will need to set this parameter to true.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
updatedAt #
string

Date at which the indexing job has been created.

taskID #
integer

The taskID used with the waitTask method.

Did you find this page helpful?
PHP v3