Batch 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

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

See code examples

About this method# A

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

Each Rule is created or updated, depending on whether a Rule with the same objectID already exists.

Examples# A

Edit

Copy

Copy
$rules = [$rule1, $rule2];

$index->saveRules($rules);

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

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

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

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

Copy
boolean forwardToReplicas = false;
boolean clearExistingRules = false;

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

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

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

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

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

Parameters# A

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

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.

Did you find this page helpful?

Batch Rules | JavaScript API Client V3 (Deprecated)

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

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

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

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

JSON format#

On this page

About this method# A

Examples# A

Parameters# A

Response# A