Export 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.

index.exportRules()

About this method

Retrieve an index’s full list of Rules using an iterator.

The list contains the Rule name, plus the complete details of its conditions and consequences.

The list includes all Rules, whether created on the dashboard or pushed by the API.

To export Rules, you will need to use an iterator.

Examples

1
2
3
4
5
$iterator = $index->browseRules();

foreach ($iterator as $rule) {
  var_dump($rule);
}

1
2
3
4
# Get rules by batch
rules = index.export_rules
# With a block
index.export_rules { |rule| puts rule }

1
2
3
index.exportRules(100, rule => {
  console.log(rule);
});

1
2
3
# Print all rules in an index.
for rule in index.browse_rules():
    print(rule)

1
2
3
4
5
6
var rulesIterator = index.BrowseRules();

foreach (var rule in rulesIterator)
{
    Console.WriteLine(rule);
}

1
2
3
List<Rule> rules = new ArrayList();
RulesIterable sourceRules = index.browseRules();
sourceRules.forEach(rules::add);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
it, err := index.BrowseRules()
// error handling

for {
	rule, err := it.Next()
	if err != nil {
		if err == io.EOF {
			break
		}
		// error handling
	}

	fmt.Printf("%#v\n", *rule)
}

1
2
val helper = AlgoliaSyncHelper(client)
helper.exportRules("myIndex").map(println)

1
2
3
index.browseRules().forEach {
    println(it)
}

Parameters

Response

Returns a Rule iterator.