Api clients / Swift / V7 / Methods

Jan 16, 2025

Replace All Synonyms | iOS API Client V7 (Deprecated)

Deprecated content

This documentation is for a deprecated version of iOS API client. Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of iOS API client for up-to-date information.

Required API Key: any key with the editSettings ACL

Method signature

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
client = Algolia::Client.new({
    :application_id => 'YourApplicationID',
    :api_key => 'YourWriteAPIKey'
})

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})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const client = algoliasearch('YourApplicationID', 'YourWriteAPIKey');

const synonyms = [/* Fetch your synonyms */];

const index = client.initIndex('your_index_name');

index.replaceAllSynonyms(synonyms).then(() => {
  // done
});

// Or if you want to also replace synonyms on replicas
index.replaceAllSynonyms(synonyms, { forwardToReplicas: true }).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
client = SearchClient.create('YourApplicationID', 'YourWriteAPIKey')

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})

1
2
3
4
5
6
7
8
9
10
11
12
SearchClient client = new SearchClient("YourApplicationID", "YourWriteAPIKey");
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);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
SearchClient client =
DefaultSearchClient.create("YourApplicationID", "YourWriteAPIKey");

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
package main

import (
    "github.com/algolia/algoliasearch-client-go/v3/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
`requestOptions`	type: key/value mapping default: No request options Optional A mapping of [`requestOptions`](/doc/api-client/getting-started/request-options/) to send along with the request.

Response

No response.

Did you find this page helpful?