Update index settings

Update the specified index settings.

Index settings that you don’t specify are left unchanged. Specify null to reset a setting to its default value.

For best performance, update the index settings before you add new records to your index.

Usage

Required ACL: editSettings
1
2
3
4
5
6
7
8
9
10
11
12
import 'package:algolia_client_search/algolia_client_search.dart';

final client =
    SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

final response = await client.setSettings(
  indexName: "ALGOLIA_INDEX_NAME",
  indexSettings: IndexSettings(
    paginationLimitedTo: 10,
  ),
  forwardToReplicas: true,
);
Did you find this page helpful?