API clients / Dart / Search

Batch indexing operations on one index

Adds, updates, or deletes records in one index with a single API request.

Batching index updates reduces latency and increases data integrity.

  • Actions are applied in the order they’re specified.
  • Actions are equivalent to the individual API requests of the same name.

This operation is subject to indexing rate limits.

Usage

Copy 
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

import 'package:algolia_client_search/algolia_client_search.dart';

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

final response = await client.batch(
  indexName: "ALGOLIA_INDEX_NAME",
  batchWriteParams: BatchWriteParams(
    requests: [
      BatchRequest(
        action: Action.fromJson("addObject"),
        body: {
          'key': "bar",
          'foo': "1",
        },
      ),
      BatchRequest(
        action: Action.fromJson("addObject"),
        body: {
          'key': "baz",
          'foo': "2",
        },
      ),
    ],
  ),
);
See full API reference
Did you find this page helpful?