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.save_rules(
  Array rules,
  Hash opts = {
    Boolean forwardToReplicas: false,
    Boolean clearExistingRules: false,
    # any requestOptions
  }
)

index.saveRules(array rules)

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

index.save_rules(list rules)

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

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

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

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

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

About this method

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

Read the Algolia CLI documentation for more information.

Copy

1
2
3
$rules = [$rule1, $rule2];

$index->saveRules($rules);

1
2
3
4
5
6
7
8
rules = [rule1, rule2]

# Save the Rules.
index.batch_rules(rules)
# Save the Rules and wait the end of indexing.
index.batch_rules!(rules)
# Replace all the rules in the index by the provided ones.
index.batch_rules(rules, { forwardToReplicas: true, clearExistingRules: true })

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
const rules = [
  {
    objectID: 'rule-1',
    conditions: [{
      pattern: 'smartphone',
      anchoring: 'contains'
    }],
    consequence: {
      params: {
        filters: 'category = 1'
      }
    }
  },
  {
    objectID: 'rule-2',
    conditions: [{
      pattern: 'tv',
      anchoring: 'contains'
    }],
    consequence: {
      params: {
        filters: 'category = 2'
      }
    }
  }
];

// Save the Rules.
index.saveRules(rules).then(() => {
  // done
});

// Replace all the rules in the index by the provided ones.
index.saveRules(rules, { clearExistingRules: true }).then(() => {
  // done
});

// Save the Rules, and forward them to all replicas of the index.
index.saveRules(rules, { forwardToReplicas: true }).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
let rules: [Rule] = [/* Your Query rules */]

index.saveRules(rules,
                forwardToReplicas: true,
                clearExistingRules: true) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
List<Rule> rules;
index.SaveRules(rules, forwardToReplicas: true, clearExistingRules: false);

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
boolean forwardToReplicas = false;
boolean clearExistingRules = false;

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

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

1
2
3
4
5
6
7
8
rules := []search.Rule{rule1, rule2}

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

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

Parameters

Parameter	Description
`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.
`requestOptions`	type: key/value mapping default: No request options Optional A mapping of `requestOptions` to send along with the request.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

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

        

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