API Reference / API Methods / Query rules / Batch rules

Feb. 26, 2019

Batch Rules

Required API Key: any key with the editSettings ACL

Method signature

$index->saveRules(array rules)

$index->saveRules(array rules, [
  // All the following parameters are optional
  'forwardToReplicas' => boolean
  'clearExistingRules' => boolean
])

index.batch_rules(
  Array rules,
  Boolean forwardToReplicas,
  Boolean clearExistingRules
)

index.batchRules(
  array rules,
  {
    forwardToReplicas: boolean,
    clearExistingRules: boolean
  },
  callback
)

index.save_rules(list rules, {
    // All the following parameters are optional
    'forwardToReplicas': bool
    'clearExistingRules': bool
})

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

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

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.SaveRules(
  IEnumerable<Rule> rules,

  // All the following parameters are optional
  forwardToReplicas: bool,
  clearExistingRules: bool
)

index.saveRules(
  List<Rule> rules,
  bool forwardToReplicas,
  bool clearExistingRules
)

index.SaveRules(
  []Rule rules,
  opt.ForwardToReplicas(bool forwardToReplicas),
  opt.ClearExistingRules(bool clearExistingRules),
)

save.rules(List<Rule> rules)
  .inIndex("index_name")
  .and(bool clearExistingRules)
  .and(bool forwardToReplicas)

See code examples

About this method

Create or update a specified set of rules, or all rules.

Each rule will be created or updated, depending on whether a rule with the same objectID already exists.

Examples

Copy

$rules = [$rule1, $rule2];

$index->saveRules($rules);

rules = [rule1, rule2]
forward_to_replicas = true
clear_existing_rules = true

# Save the rules.
index.batch_rules(rules)
# Save the rules and wait the end of indexing.
index.batch_rules!(rules)
# Save the rules, and forward them to all replicas of the index.
index.batch_rules(rules, forward_to_replicas)
# Replace all the rules in the index by the provided ones.
index.batch_rules(rules, forward_to_replicas, clear_existing_rules)

const rules = [
  {
    objectID: 'rule-1',
    condition: {
      pattern: 'smartphone',
      anchoring: 'contains'
    },
    consequence: {
      params: {
        filters: 'category = 1'
      }
    }
  },
  {
    objectID: 'rule-2',
    condition: {
      pattern: 'tv',
      anchoring: 'contains'
    },
    consequence: {
      params: {
        filters: 'category = 2'
      }
    }
  }
];

// Save the rules.
index.batchRules(rules, (err, content) => {
  if (err) throw err;

  console.log(content);
});

// Replace all the rules in the index by the provided ones.
index.batchRules(rules, {clearExistingRules: true}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

// Save the rules, and forward them to all replicas of the index.
index.batchRules(rules, {forwardToReplicas: true}, (err, content) => {
  if (err) throw err;

  console.log(content);
});

List<Rule> rules;
index.SaveRules(rules, forwardToReplicas: true, clearExistingRules: false);

// Asynchronous
await index.SaveRulesAsync(rules, forwardToReplicas: true, clearExistingRules: false);

boolean forwardToReplicas = false;
boolean clearExistingRules = false;

index.saveRules(
  Arrays.asList(rule1, rule2),
  forwardToReplicas,
  clearExistingRules
);

index.saveRulesAsync(
  Arrays.asList(rule1, rule2),
  forwardToReplicas,
  clearExistingRules
);

rules := []search.Rule{rule1, rule2}

opts := []interface{}{
  opt.ForwardToReplicas(false),
  opt.ClearExistingRules(false),
}

res, err := index.SaveRules(rules, opts...)

Parameters

`rules`	type: list of rule objects Required See rule.
`clearExistingRules`	type: boolean default: false Optional Whether the batch will remove all existing rules before adding/updating the rules.
`forwardToReplicas`	type: boolean default: false Optional Whether to forward the operation to the replica indices.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

`updatedAt`	string Date at which the batch rules job has been created.
`taskID`	integer The taskID used with the waitTask method.

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

Batch Rules

About this method

Examples

Parameters

Response

JSON format

Did you find this page helpful?

On this page