API Reference / API Methods / Synonyms / Replace all synonyms

Feb. 26, 2019

Replace All Synonyms

Required API Key: any key with the editSettings ACL

Method signature

$index->replaceAllSynonyms(array synonyms);
$index->replaceAllSynonyms(array synonyms, [
  'forwardToReplicas' => boolean
]);

index.replace_all_synonyms(Array synonyms)
index.replace_all_synonyms(Array synonyms, {
  'forwardToReplicas': Boolean
})

Not implemented yet.

index.replace_all_synonyms(list synonyms)
index.replace_all_synonyms(list synonyms, {
    'forwardToReplicas': bool
})

Not implemented yet.

suspend fun Index.replaceAllSynonyms(
    synonyms: List<Synonym>,
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

Not implemented yet.

index.ReplaceAllSynonyms(
  synonyms,

  // All the following parameters are optional
  forwardToReplicas: forwardToReplicas
)

index.replaceAllSynonyms(
  List<Synonym> synonyms
);
index.replaceAllSynonyms(
  List<Synonym> synonyms,
  bool forwardToReplicas
);

index.ReplaceAllSynonyms([]Synonym synonyms)
index.ReplaceAllSynonyms([]Synonym synonyms, opt.ForwardToReplicas(bool forwardToReplicas))

Not implemented yet.

See code examples

About this method

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

Copy

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

client = Algolia::Client.new({
    :application_id => 'YourApplicationID',
    :api_key => 'YourAdminAPIKey'
})

synonyms = [] # Fetch your synonyms

index = client.init_index('your_index_name')
index.replace_all_synonyms(synonyms)

# Or if you want to also replace synonyms on replicas
index.replace_all_synonyms(synonyms, {'forwardToReplicas': true})

client = SearchClient.create('YourApplicationID', 'YourAdminAPIKey')

synonyms = [] # Fetch your synonyms

index = client.init_index('your_index_name')
index.replace_all_synonyms(synonyms)

# Or if you want to also replace synonyms on replicas
index.replace_all_synonyms(synonyms, {'forwardToReplicas': True})

SearchClient client = new SearchClient("YourApplicationID", "YourAdminAPIKey");
SearchIndex index = client.InitIndex("your_index_name");

List<Synonym> synonyms = /* Fetch your synonyms */

index.ReplaceAllSynonyms(synonyms);

// Or if you want to also replace synonyms on replicas
index.ReplaceAllSynonyms(synonyms, forwardToReplicas: true);

// Asynchronous
await index.ReplaceAllSynonymsAsync(synonyms, forwardToReplicas: true);

SearchClient client = 
DefaultSearchClient.create("YourApplicationID", "YourAdminAPIKey");

SearchIndex index = client.InitIndex("your_index_name");

List<Synonym> synonyms = /* Fetch your synonyms */

index.replaceAllSynonyms(synonyms);

// Or if you want to also replace synonyms on replicas
index.replaceAllSynonyms(synonyms, true);

// Async
index.replaceAllSynonymsAsync(synonyms);
index.replaceAllSynonymsAsync(synonyms, true);

package main

import (
	"github.com/algolia/algoliasearch-client-go/algolia/search"
)

func main() {
	client := search.NewClient("YourApplicationID", "YourAdminKey")
	index := client.InitIndex("your_index_name")

	synonyms := []search.Synonym{ /* Fetch your synonyms */ }

	res, err := index.ReplaceAllSynonyms(synonyms)
}

Parameters

`synonyms`	type: list Required A list of synonyms
`forwardToReplicas`	type: boolean default: false Optional Also replace synonyms on replicas

Response

No response

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Replace All Synonyms

About this method

Examples

Replace all synonyms

Parameters

Response

Did you find this page helpful?

On this page