Export Rules

Required API Key: any key with the settings ACL

Method signature

$index->browseRules()

index.browse_rules()

index.browseRules({
  // A `batch` callback function that's called
  // on every batch of rules with the
  // signature: (rules: Rules[]) => any
  batch: function
})

index.browseRules({
  // A `batch` callback function that's called
  // on every batch of rules with the
  // signature: (rules: Rules[]) => any
  batch: function,
  // All the following parameters are optional
  // + any requestOptions
})

index.browse_rules()

index.browseRules(
  query: RuleQuery = .init(),
  requestOptions: RequestOptions? = nil,
  completion: Result<[RuleSearchResponse]> -> Void
)

suspend fun Index.browseRules(
    query: RuleQuery = RuleQuery(),
    requestOptions: RequestOptions? = null
): List<ResponseSearchRules>

index.BrowseRules()

index.browseRules()

index.BrowseRules()

AlgoliaSyncHelper(client).exportRules(String indexName)

See code examples

About this method # A

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.

You can batch import and export Rules from the dashboard with a configuration file.

Examples # A

Copy

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

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

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

Parameters # A

`indexName` #	type: string only needed in go, scala, c# Index name.
`requestOptions` #	type: key/value mapping default: No request options Optional A mapping of `requestOptions` to send along with the query.

Response # A

Returns a Rule iterator.

Did you find this page helpful?

Export 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

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