Api clients / JavaScript / V3 / Methods

Jan. 09, 2023

Custom Batch | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the depends on operations performed inside the batch ACL

Method signature

client.batch(array operations, callback)

See code examples

About this method

Perform several indexing operations in one API call.

This method enables you to batch multiple different indexing operations in one API call, like add or delete objects, potentially targeting multiple indices.

You would use this method to:

reduce latency - only one network trip is required for multiple operations
ensure data integrity - all operations inside the batch will be executed atomically. Meaning that instead of deleting 30 objects then adding 20 new objects in two operations, we do both operations in one go. This will remove the time during which an index is in an inconsistent state and could be a great alternative to doing an atomic reindexing using a temporary index.

When batching of a large numbers of objects, or large sizes, be aware of our rate limit. You’ll know you’ve reached the rate limit when you start receiving errors on your indexing operations. This can only be resolved if you wait before sending any further indexing operations.

Examples

Batch write operations

Copy

Copy
$res = $client->multipleBatch(
  [
    [
      'action'    => 'addObject',
      'indexName' => 'index1',
      'body'      => [
        'firstname' => 'Jimmie',
        'lastname'  => 'Barninger'
      ]
    ],
    [
      'action'    => 'updateObject',
      'indexName' => 'index1',
      'body'      => [
        'objectID' => 'myID2',
        'firstname' => 'Max',
        'lastname'  => 'Barninger'
      ]
    ],
    [
      'action'    => 'partialUpdateObject',
      'indexName' => 'index1',
      'body'      => [
        'objectID'  => 'myID3',
        'lastname'  => 'McFarway'
      ]
    ],
    [
      'action'    => 'partialUpdateObjectNoCreate',
      'indexName' => 'index1',
      'body'      => [
        'objectID'  => 'myID4',
        'firstname' => 'Warren'
      ]
    ],
    [
      'action'    => 'deleteObject',
      'indexName' => 'index2',
      'body'      => [
        'objectID'  => 'myID5'
      ]
    ]
  ]
);

Copy
res = client.batch([
  {
    'action': 'addObject',
    'indexName': 'index1',
    'body': {
      'firstname': 'Jimmie',
      'lastname': 'Barninger'
    }
  },
  {
    'action': 'updateObject',
    'indexName': 'index1',
    'body': {
      'objectID': 'myID2',
      'firstname': 'Max',
      'lastname': 'Barninger'
    }
  }
  {
    'action': 'partialUpdateObject',
    'indexName': 'index1',
    'body': {
      'objectID': 'myID3',
      'lastname': 'McFarway'
    }
  }
  {
    'action': 'partialUpdateObjectNoCreate',
    'indexName': 'index1',
    'body': {
      'objectID': 'myID4',
      'firstname': 'Warren'
    }
  }
  {
    'action': 'deleteObject',
    'indexName': 'index2',
    'body': {
      'objectID': 'myID5'
    }
  }
])

Copy
client.batch([
  {
    action: 'addObject',
    indexName: 'index1',
    body: {
      firstname: 'Jimmie',
      lastname: 'Barninger'
    }
  },
  {
    action: 'updateObject',
    indexName: 'index1',
    body: {
      objectID: 'myID2',
      firstname: 'Max',
      lastname: 'Barninger'
    }
  },
  {
    action: 'partialUpdateObject',
    indexName: 'index1',
    body: {
      objectID: 'myID3',
      lastname: 'McFarway'
    }
  },
  {
    action: 'partialUpdateObjectNoCreate',
    indexName: 'index1',
    body: {
      objectID: 'myID4',
      firstname: 'Warren'
    }
  },
  {
    action: 'deleteObject',
    indexName: 'index2',
    body: {
      objectID: 'myID5'
    }
  }
], (err, content) => {
  if (err) throw err;

  console.log(content);
})

Copy
client.multiple_batch([
    {
        'action': 'addObject',
        'indexName': 'index1',
        'body': {
            'firstname': 'Jimmie',
            'lastname': 'Barninger'
        }
    },
    {
        'action': 'updateObject',
        'indexName': 'index1',
        'body': {
            'objectID': 'myID2',
            'firstname': 'Max',
            'lastname': 'Barninger'
        }
    },
    {
        'action': 'partialUpdateObject',
        'indexName': 'index1',
        'body': {
            'objectID': 'myID3',
            'lastname': 'McFarway'
        }
    },
    {
        'action': 'partialUpdateObjectNoCreate',
        'indexName': 'index1',
        'body': {
            'objectID': 'myID4',
            'firstname': 'Warren'
        }
    },
    {
        'action': 'deleteObject',
        'indexName': 'index2',
        'body': {
            'objectID': 'myID5'
        }
    }
])

Copy
let operations: [JSONObject] = [
  [
    "action": "addObject",
    "indexName": "index1",
    "body": [
      "firstname": "Jimmie",
      "lastname": "Barninger"
    ]
  ],
  [
    "action": "updateObject",
    "indexName": "index1",
    "body": [
      "objectID": "myID2",
      "firstname": "Max",
      "lastname": "Barninger"
    ]
  ],
  [
    "action": "partialUpdateObject",
    "indexName": "index1",
    "body": [
      "objectID": "myID3",
      "lastname": "McFarway"
    ]
  ],
  [
    "action": "partialUpdateObjectNoCreate",
    "indexName": "index1",
    "body": [
      "objectID": "myID4",
      "firstname": "Warren"
    ]
  ],
  [
    "action": "deleteObject",
    "indexName": "index2",
    "body": [
      "objectID": "myID5"
    ]
  ]
]

client.batch(operations: operations) {
  (content, error) in
  // Handle response
}

Copy
List<JSONObject> array = new ArrayList<>();
array.add(new JSONObject()
  .put("action", "addObject")
  .put("indexName", "index1")
  .put("body", new JSONObject()
    .put("firstname", "Jimmie")
    .put("lastname", "Barninger")
  )
);

array.add(new JSONObject()
  .put("action", "updateObject")
  .put("indexName", "index1")
  .put("body", new JSONObject()
    .put("objectID", "myID2")
    .put("firstname", "Max")
    .put("lastname", "Barninger")
  )
);

array.add(new JSONObject()
  .put("action", "partialUpdateObject")
  .put("indexName", "index1")
  .put("body", new JSONObject()
    .put("objectID", "myID3")
    .put("lastname", "McFarway")
  )
);

array.add(new JSONObject()
  .put("action", "partialUpdateObjectNoCreate")
  .put("indexName", "index1")
  .put("body", new JSONObject()
    .put("objectID", "myID4")
    .put("firstname", "Warren")
  )
);

array.add(new JSONObject()
  .put("action", "deleteObject")
  .put("indexName", "index2")
  .put("body", new JSONObject()
    .put("objectID", "myID5")
  )
);

client.batchAsync(new JSONArray(array), null);

Copy
  List<BatchOperation<Contact>> operations = new List<BatchOperation<Contact>>
  {
      new BatchOperation<Contact>
      {
        Action = BatchActionType.AddObject,
        IndexName = "index1",
        Body = new Contact { FirstName = "Jimmie", LastName = "Barninger" }
      },
      new BatchOperation<Contact>
      {
        Action = BatchActionType.UpdateObject,
        IndexName = "index1",
        Body = new Contact { ObjectID = "myID2", FirstName = "Max", LastName = "Barninger" }
      },
      new BatchOperation<Contact>
      {
        Action = BatchActionType.PartialUpdateObject,
        IndexName = "index1",
        Body = new Contact { ObjectID = "myID3", LastName = "McFarway" }
      },
      new BatchOperation<Contact>
      {
        Action = BatchActionType.PartialUpdateObjectNoCreate,
        IndexName = "index1",
        Body = new Contact { ObjectID = "myID4", LastName = "Warren" }
      },
      new BatchOperation<Contact>
      {
        Action = BatchActionType.DeleteObject,
        IndexName = "index2",
        Body = new Contact { ObjectID = "myID5" }
      }
  };

client.MultipleBatch(operations);

// Asynchronous
client.MultipleBatchAsync(operations);

Copy
List<BatchOperation<Contact>> operations =
Arrays.asList(
    new BatchOperation<>(
        "index1", ActionEnum.ADD_OBJECT,
        new Contact()
        .setFirstName("Jimmie")
        .setLastName("Barninger")),
    new BatchOperation<>(
        "index1", ActionEnum.UPDATE_OBJECT,
         new Contact()
         .setObjectID("myID2")
         .setFirstName("Max")
         .setLastName("Barninger")),
    new BatchOperation<>(
        "index1", ActionEnum.PARTIAL_UPDATE_OBJECT,
        new Contact()
        .setObjectID("myID3")
        .setLastName("McFarway")),
    new BatchOperation<>(
        "index1", ActionEnum.PARTIAL_UPDATE_OBJECT_NO_CREATE,
        new Contact()
        .setObjectID("myID4")
        .setFirstName("Warren")),
    new BatchOperation<>(
        "index2", ActionEnum.DELETE_OBJECT,
        new Contact()
        .setObjectID("myID5")));

// Async version
client.multipleBatchAsync(operations);

// Async version
client.multipleBatchAsync(operations);

Copy
type Contact struct {
    ObjectID  string `json:"objectID,omitempty"`
    Firstname string `json:"firstname,omitempty"`
    Lastname  string `json:"lastname,omitempty"`
}

operations := []search.BatchOperationIndexed{
    {
        IndexName: "index1",
        BatchOperation: search.BatchOperation{
            Action: search.AddObject,
            Body:   Contact{Firstname: "Jimmie", Lastname: "Barninger"},
        },
    },
    {
        IndexName: "index1",
        BatchOperation: search.BatchOperation{
            Action: search.UpdateObject,
            Body:   Contact{ObjectID: "myID2", Firstname: "Max", Lastname: "Barninger"},
        },
    },
    {
        IndexName: "index1",
        BatchOperation: search.BatchOperation{
            Action: search.PartialUpdateObject,
            Body:   Contact{ObjectID: "myID3", Lastname: "McFarway"},
        },
    },
    {
        IndexName: "index1",
        BatchOperation: search.BatchOperation{
            Action: search.PartialUpdateObjectNoCreate,
            Body:   Contact{ObjectID: "myID4", Firstname: "Warren"},
        },
    },
    {
        IndexName: "index2",
        BatchOperation: search.BatchOperation{
            Action: search.DeleteObject,
            Body:   Contact{ObjectID: "myID5"},
        },
    },
}

res, err := client.MultipleBatch(operations)

Copy
client.execute {
  batch(
    index into "index1" `object` Contact("", "Jimmie", "Barninger"),
    index into "index1" `object` ContactWithObjectID("myID2", "Max", "Barninger"),
    partialUpdate from "index1" `object` ContactWithObjectID("myID3", "", "McFarway"),
    partialUpdate from "index1" `object` ContactWithObjectID("myID4", "Warren", "") createIfNotExists false,
    delete from "index2" objectId "myID5"
  )
}

Copy
@Serializable
data class Contact(
    val firstname: String,
    val lastname: String,
    override val objectID: ObjectID
) : Indexable

val operations = listOf(
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.AddObject(
            json {
                "firstname" to "Jimmie"
                "lastname" to "Barninger"
            }
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.AddObject.from(
            serializer = Contact.serializer(),
            data = Contact("Jimmie", "Barninger", ObjectID("myID1"))
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.PartialUpdateObject.from(
            serializer = Contact.serializer(),
            data = Contact("Max", "Barninger", ObjectID("myID2"))
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.PartialUpdateObject.from(
            objectID = ObjectID("myID3"),
            partial = Partial.Update(Attribute("firstname"), "McFarway")
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.PartialUpdateObject.from(
            objectID = ObjectID("myID4"),
            partial = Partial.Update(Attribute("firstname"), "Warren"),
            createIfNotExists = false
        )
    ),
    BatchOperationIndex(
        indexName = indexName2,
        operation = BatchOperation.DeleteObject(ObjectID("myID5"))
    )
)
client.multipleBatchObjects(operations)

Batch write operations and send extra HTTP headers

Copy

Copy
$operations = [
  [
    'action' => 'addObject',
    'indexName' => 'index1',
    'body' => [
      'firstname' => 'Jimmie',
      'lastname' => 'Barninger'
    ]
  ],
  [
    'action' => 'addObject',
    'indexName' => 'index2',
    'body' => [
      'firstname' => 'Warren',
      'lastname' => 'Speach'
    ]
  ]
];

$res = $client->multipleBatch($operations, [
  'X-Forwarded-For' => '94.228.178.246'
]);

Copy
operations = [
 {
   'action': 'addObject',
   'indexName': 'index1',
   'body': {'firstname': 'Jimmie', 'lastname': 'Barninger'}
 },
 {
   'action': 'addObject',
   'indexName': 'index2',
   'body': {'firstname': 'Warren', 'lastname': 'Speach'}
 }
]

extra_headers = {
  'X-Forwarded-For': '94.228.178.246'
}

res = client.batch(operations, extra_headers)

Copy
client.setExtraHeader('X-Forwarded-For', '94.228.178.246');
client.batch([
  {
    action: 'addObject',
    indexName: 'index1',
    body:
    {
      firstname: 'Jimmie',
      lastname: 'Barninger'
    }
  },
  {
    action: 'addObject',
    indexName: 'index2',
    body: {
      firstname: 'Warren',
      lastname: 'Speach'
    }
  }
], (err, content) => {
  if (err) throw err;

  console.log(content);
})

Copy
operations = [
    {
        'action': 'addObject',
        'indexName': 'index1',
        'body': {'firstname': 'Jimmie', 'lastname': 'Barninger'}
    },
    {
        'action': 'addObject',
        'indexName': 'index2',
        'body': {'firstname': 'Warren', 'lastname': 'Speach'}
    }
]

res = client.multiple_batch(operations, {
    'X-Forwarded-For': '94.228.178.246'
})

Copy
let operations: [JSONObject] = [
  [
    "action": "addObject",
    "indexName": "index1",
    "body": [
      "firstname": "Jimmie",
      "lastname": "Barninger"
    ]
  ],
  [
    "action": "addObject",
    "indexName": "index2",
    "body": [
      "firstname": "Warren",
      "lastname": "Speach"
    ]
  ]
]

let requestOptions = RequestOptions()
requestOptions.headers["X-Algolia-User-ID"] = "user123"

client.batch(operations: operations, requestOptions: requestOptions) {
  (content, error) in
  // Handle response
}

Copy
List<JSONObject> array = new ArrayList<>();

array.add(new JSONObject()
  .put("action", "addObject")
  .put("indexName", "index1")
  .put("body", new JSONObject()
    .put("firstname", "Jimmie")
    .put("lastname", "Barninger")
  )
);

array.add(new JSONObject()
  .put("action", "addObject")
  .put("indexName", "index2")
  .put("body", new JSONObject()
      .put("firstname", "Warren")
      .put("lastname", "Speach")
  )
);

client.batchAsync(
  new JSONArray(array),
  new RequestOptions().setHeader("X-Algolia-User-ID", "94.228.178.246"),
  null
);

Copy
RequestOptions requestOptions = new RequestOptions
{
    Headers = new Dictionary<string,string>{ { "X-Algolia-User-ID", "user123" } }
};

  List<BatchOperation<Contact>> operations = new List<BatchOperation<Contact>>
  {
      new BatchOperation<Contact>
      {
        Action = BatchActionType.AddObject,
        IndexName = "index1",
        Body = new Contact { FirstName = "Jimmie", LastName = "Barninger" }
      },
      new BatchOperation<Contact>
      {
        Action = BatchActionType.AddObject,
        IndexName = "index1",
        Body = new Contact { FirstName = "Warren", LastName = "Speach" }
      }
  };

client.MultipleBatch(operations, requestOptions);

// Asynchronous
client.MultipleBatchAsync(operations, requestOptions);

Copy
List<BatchOperation<Contact>> operations =
Arrays.asList(
    new BatchOperation<>(
        "index1", ActionEnum.ADD_OBJECT,
        new Contact()
        .setFirstName("Jimmie")
        .setLastName("Barninger")),
    new BatchOperation<>(
        "index2", ActionEnum.ADD_OBJECT,
        new Contact()
        .setFirstName("Warren")
        .setLastName("Speach")));

// Async version
client.multipleBatchAsync(operations,
  new RequestOptions().addExtraHeader("X-Algolia-User-ID", "user123"));

// Async version
client.multipleBatchAsync(operations,
  new RequestOptions().addExtraHeader("X-Algolia-User-ID", "user123"));

Copy
 contact := Contact{
    Firstname: "Jimmie",
    Lastname:  "Barninger",
}

operation := search.BatchOperation{Action: search.AddObject, Body: contact}

operations := []search.BatchOperationIndexed{
    {IndexName: "prodIndex", BatchOperation: operation},
    {IndexName: "devIndex", BatchOperation: operation},
}

res, err := client.MultipleBatch(
    operations,
    opt.ExtraHeaders(map[string]string{"X-Algolia-User-ID": "userID2"}),
)

Copy
client.execute {
  batch(
    index into "index1" `object` Contact("Jimmie", "Barninger"),
    index into "index2" `object` Contact("Warren", "Speach")
  ) options RequestOptions(extraHeaders = Some(
    Map("X-Algolia-User-ID" => "user123"))
  )
}

Copy
@Serializable
data class Contact(
    val firstname: String,
    val lastname: String,
    override val objectID: ObjectID
) : Indexable

val operations = listOf(
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.AddObject(
            json {
                "firstname" to "Jimmie"
                "lastname" to "Barninger"
            }
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.AddObject.from(
            serializer = Contact.serializer(),
            data = Contact("Jimmie", "Barninger", ObjectID("myID1"))
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.PartialUpdateObject.from(
            serializer = Contact.serializer(),
            data = Contact("Max", "Barninger", ObjectID("myID2"))
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.PartialUpdateObject.from(
            objectID = ObjectID("myID3"),
            partial = Partial.Update(Attribute("firstname"), "McFarway")
        )
    ),
    BatchOperationIndex(
        indexName = indexName1,
        operation = BatchOperation.PartialUpdateObject.from(
            objectID = ObjectID("myID4"),
            partial = Partial.Update(Attribute("firstname"), "Warren"),
            createIfNotExists = false
        )
    ),
    BatchOperationIndex(
        indexName = indexName2,
        operation = BatchOperation.DeleteObject(ObjectID("myID5"))
    )
)
val requestOptions = requestOptions {
    headerAlgoliaUserId(UserID("user123"))
}

client.multipleBatchObjects(operations, requestOptions)

Parameters


            operations

type: list of

Required

List of operation.

Each operation is described by:

action: type of operation
indexName: name of the index targeted by this operation
body: arguments to the operation (depends on the type of the operation)


            requestOptions

type: key value mapping

default: No requestOptions

Optional

A mapping of [`requestOptions`](/doc/api-client/getting-started/request-options/) to send along with the query.

operations ➔ operation


            action

type: string

Required

Actions that need to be performed. It can be one of the following values:

addObject: Add an object.
updateObject: Add or replace an existing object. You must set the objectID attribute to indicate the object to update.
partialUpdateObject: Partially update an object. You must set the objectID attribute to indicate the object to update.
partialUpdateObjectNoCreate: Same as partialUpdateObject, except that the object is not created if the object designated by objectID does not exist.
deleteObject: Delete an object. You must set the objectID attribute to indicate the object to delete.


            indexName

type: string

Required

Index name to target.


            body

type: object

Required

The JSON object containing the information you need for the selected action.

For example, deleteObject would be: An object with the following format

{
  "objectID": "myID1"
}

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy

        {
  "objectIDs": [
    "myObjectID1",
    "myObjectID2"
  ],
  "taskID": {
    "index1": 29866710291
  }
}

      

`objectIDs`	list List of objectIDs affected by the batch of operations.
`taskID`	list A list of taskIDs to use with the waitTask method. One for each index.

Did you find this page helpful?

Custom Batch | JavaScript API Client V3 (Deprecated)

About this method

Examples

Batch write operations

Batch write operations and send extra HTTP headers

Parameters

operations ➔ operation

Response

JSON format

On this page