Push records in batches

Split records into batches and push them through the transformation pipeline.

Required ACL: addObject, deleteIndex, editSettings

Use chunkedPush to push a large number of records to an index through the transformation pipeline.

This helper method splits your records into batches (1,000 records by default) and sends each batch as a push request. This lets you index large datasets without worrying about request size limits.

To use this method, you need a Push to Algolia connector.

The Search API client helpers, such as saveObjectsWithTransformation and replaceAllObjectsWithTransformation, use chunkedPush internally. Use chunkedPush directly on the Ingestion client if you need more control over the indexing action or batch size.

This method is subject to connector limits.

Usage

C#

// Initialize the client
var client = new IngestionClient(
  new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);

// Records to push
var objects = new List<object>
{
  new { objectID = "1", name = "Record 1" },
  new { objectID = "2", name = "Record 2" },
};

// Push records in batches
var responses = await client.ChunkedPushAsync(
  "INDEX_NAME",
  objects,
  Action.AddObject,
  waitForTasks: true,
  batchSize: 1000
);

Parameters

C#

indexName · string · required

Name of the index to push records to.

objects · IEnumerable<object> · required

Records to push.

action · Action · required

Indexing action to perform on the records, such as AddObject or PartialUpdateObject.

waitForTasks · bool · default: false

Whether to wait for each push task to complete before returning.

batchSize · int · default: 1000

Number of records to include in each batch.

referenceIndexName · string

Index to use as a reference for index settings.

options · RequestOptions

Additional request options.

cancellationToken · CancellationToken

Token to cancel the operation.

Go

indexName · string · required

Name of the index to push records to.

objects · []map[string]any · required

Records to push.

action · Action · required

Indexing action to perform on the records, such as ActionAddObject or ActionPartialUpdateObject.

referenceIndexName · *string

Index to use as a reference for index settings.

opts... · ChunkedBatchOption

Functional options to provide extra arguments.

Show available functions

ingestion.WithWaitForTasks · function

Signature: func(withWaitForTasks bool) chunkedBatchOption

Whether to wait for each push task to complete before returning.

ingestion.WithBatchSize · function

Signature: func(batchSize int) chunkedBatchOption

Number of records to include in each batch. The default batch size is 1,000.

ingestion.WithHeaderParam · function

Signature: func(key string, value string) requestOption

Sets extra header parameters for this request. To learn more, see request options.

ingestion.WithQueryParam · function

Signature: func(key string, value string) requestOption

Sets extra query parameters for this request. To learn more, see request options.

Java

indexName · String · required

Name of the index to push records to.

objects · Iterable<T> · required

Records to push.

action · Action · required

Indexing action to perform on the records, such as ADD_OBJECT or PARTIAL_UPDATE_OBJECT.

waitForTasks · boolean · default: false

Whether to wait for each push task to complete before returning.

batchSize · int · default: 1000

Number of records to include in each batch.

referenceIndexName · String

Index to use as a reference for index settings.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Name of the index to push records to.

objects · Record<string,unknown>[] · required

Records to push.

action · string · default: "addObject"

Indexing action to perform on the records.

waitForTasks · boolean · default: false

Whether to wait for each push task to complete before returning.

batchSize · number · default: 1000

Number of records to include in each batch.

referenceIndexName · string

Index to use as a reference for index settings.

requestOptions · RequestOptions

Additional request options.

PHP

$indexName · string · required

Name of the index to push records to.

$objects · array · required

Records to push.

$action · string · default: "addObject"

Indexing action to perform on the records.

$waitForTasks · bool · default: true

Whether to wait for each push task to complete before returning.

$batchSize · int · default: 1000

Number of records to include in each batch.

$referenceIndexName · string|null

Index to use as a reference for index settings.

$requestOptions · array

Additional request options.

Python

index_name · str · required

Name of the index to push records to.

objects · list[dict] · required

Records to push.

action · Action · default: "Action.ADDOBJECT"

Indexing action to perform on the records.

wait_for_tasks · bool · default: false

Whether to wait for each push task to complete before returning.

batch_size · int · default: 1000

Number of records to include in each batch.

reference_index_name · str | None

Index to use as a reference for index settings.

request_options · dict | RequestOptions

Additional request options.