API Reference / API Methods / Query rules / Replace all rules

Feb. 26, 2019

Replace All Rules

Required API Key: any key with the editSettings ACL

Method signature

$index->replaceAllRules(array rules);
$index->replaceAllRules(array rules, [
  'forwardToReplicas' => boolean
]);

index.replace_all_rules(Array rules)
index.replace_all_rules(Array rules, {
  'forwardToReplicas': Boolean
})

Not implemented yet.

index.replace_all_rules(list rules)
index.replace_all_rules(list rules, {
    'forwardToReplicas': bool
});

Not implemented yet.

suspend fun Index.replaceAllRules(
    rules: List<Rule>,
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

Not implemented yet.

index.ReplaceAllRules(
  IEnumerable<Rule> rules,

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

index.replaceAllRules(List<Rule> rules);
index.replaceAllRules(List<Rule> rules, boolean forwardToReplicas);

index.ReplaceAllRules([]Rule rules)

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

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

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

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

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

client = algoliasearch.Client("YourApplicationID", 'YourAdminAPIKey')

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

SearchClient client = new SearchClient("YourApplicationID", "YourAdminAPIKey");
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);

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

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 A list of rules
`forwardToReplicas`	type: boolean default: false Optional Also replace rules 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 Rules

About this method

Examples

Replace all rules

Parameters

Response

Did you find this page helpful?

On this page