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

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

About this method # A

Get a list of all Rules defined on an index.

The list contains the name and details of conditions and consequences for all Rules for the selected index, whether the Rule was created in the Algolia dashboard or with the API.

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

You can import and export Rules from the Algolia dashboard.

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
15
it, err := index.BrowseRules()
if err != nil {
  panic(err)
}

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

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

Parameters # A

Parameter	Description
`indexName` #	type: string only needed in Scala 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