Replace All Rules | 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.

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 rules and erase all previous ones.

This method, like replaceAllObjects, guarantees zero downtime.

All existing rules are deleted and replaced with the new ones, in a single, atomic operation.

Examples

Replace all rules

Copy

Copy
$client = Algolia\AlgoliaSearch\SearchClient::create(
  'YourApplicationID',
  'YourWriteAPIKey'
);

$rules = /* Fetch your rules */;

$index = $client->initIndex('your_index_name');
$index->replaceAllRules($rules);

// Or if you want to also replace rules on replicas
$index->replaceAllRules($rules, ['forwardToReplicas' => true]);

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

rules = [] # Fetch your rules

index = client.init_index('your_index_name')
index.replace_all_rules(rules)

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

Copy
client = algoliasearch.Client("YourApplicationID", 'YourWriteAPIKey')

rules = [] # Fetch your rules

index = client.init_index('your_index_name')
index.replace_all_rules(rules)

# Or if you want to also replace rules on replicas
index.replace_all_rules(rules, algoliasearch.RequestOptions({'forwardToReplicas': True}))

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

List<Rule> rules = /* Fetch your rules */

index.ReplaceAllRules(rules);

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

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

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

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

List<Rule> rules = /* Fetch your rules */

index.replaceAllRules(rules);

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

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

Parameters

`rules`	type: list Required See rule.
`forwardToReplicas`	type: boolean default: false Optional Also replace rules on replicas

Response

No response.