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, Hash opts = {
  'forwardToReplicas': Boolean
})

index.replaceAllRules(array rules)
index.replaceAllRules(array rules, {
  // All the following parameters are optional
  forwardToReplicas: boolean,
  // any other requestOptions
});

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

index.replaceAllRules(
  with rules: [Rule],
  forwardToReplicas: Bool? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<IndexRevision>> -> Void
)

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

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 # A

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

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 # A

Replace all rules#

Copy

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

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

1
2
3
4
5
6
7
8
9
client = Algolia::Search::Client.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

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

1
2
3
4
5
6
7
8
9
10
11
12
13
const client = algoliasearch('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb');

const index = client.initIndex('your_index_name');
const rules = [/* Fetch your rules */];

index.replaceAllRules(rules).then(() => {
  // done
});

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

1
2
3
4
5
6
7
8
9
client = algoliasearch.Client("AJ0P3S7DWQ", '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
let client = SearchClient(appID: "AJ0P3S7DWQ", apiKey: "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
let index = client.index(withName: "your_index_name")

let rules: [Rule] = [/* Fetch your rules */]

index.replaceAllRules(with: rules) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

// Or if you want to also replace synonyms on replicas
index.replaceAllRules(with: rules,
                      forwardToReplicas: true) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

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

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

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 # A

`rules` #	type: list Required See rule.
`forwardToReplicas` #	type: boolean default: false Optional Also replace rules on replicas
`requestOptions` #	type: key/value mapping default: No request options Optional A mapping of `requestOptions` to send along with the request.

Response # A

No response

Did you find this page helpful?

Replace All Rules

About this method # Found an issue? Edit this page A Edit this page

Examples # Found an issue? Edit this page A Edit this page

Replace all rules#

Parameters # Found an issue? Edit this page A Edit this page

Response # Found an issue? Edit this page A Edit this page

On this page

About this method # A

Examples # A

Parameters # A

Response # A