Clear All Synonyms | Ruby API Client V1 (Deprecated)
editSettings
ACL
index.clear_synonyms(Boolean forwardToReplicas)
About this method
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 batch method
(with replaceExistingSynonyms
set to true)
to atomically replace all synonyms of an index with no down time.
Examples
Clear all synonyms and forward to replicas
1
2
3
$index->clearSynonyms([
'forwardToReplicas' => true
]);
Parameters
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
In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.
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. |