Clear All Synonyms | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

index.clearSynonyms(
  {
    forwardToReplicas: boolean
  },
  callback
);

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
]);

1
2
3
4
# Clear synonyms and forward to replicas
forward_to_replicas = true

index.clear_synonyms(forward_to_replicas)

1
2
3
4
5
index.clearSynonyms({ forwardToReplicas: true }, (err, content) => {
  if (err) throw err;

  console.error(err);
});

1
2
3
4
# Clear synonyms and forward to replicas
index.clear_synonyms({
    'forwardToReplicas': True
})

1
2
3
4
index.ClearSynonyms(forwardToReplicas: true);

// Asynchronous
await index.ClearSynonymsAsync(forwardToReplicas: true);

1
2
3
4
5
6
boolean forwardToReplicas = true;

index.clearSynonyms(forwardToReplicas);

// Asynchronous
index.clearSynonymsAsync(forwardToReplicas);

1
2
forwardToReplicas := opt.ForwardToReplicas(true)
res, err := index.ClearSynonyms(forwardToReplicas)

1
2
3
client.execute {
  clear synonyms of index "index_name" and forwardToReplicas
}

1
index.clearSynonyms(forwardToReplicas = true)

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