Add or update attributes of multiple records

Add or update specific record attributes without replacing the entire record.

Required ACL: addObject

This helper method uses the Batch operations on one index operation. It builds a batch request with either the partialUpdateObject or partialUpdateObjectNoCreate action, depending on whether createIfNotExists is true or false. The method sends records in batches of up to 1,000.

This operation is subject to indexing rate limits.

Usage

C#

var response = await client.PartialUpdateObjectsAsync(
  "INDEX_NAME",
  new List<Object>
  {
    new Dictionary<string, string> { { "objectID", "1" }, { "name", "Adam" } },
    new Dictionary<string, string> { { "objectID", "2" }, { "name", "Benoit" } },
  },
  true
);

response, err := client.PartialUpdateObjects(
  "INDEX_NAME",
  []map[string]any{{"objectID": "1", "name": "Adam"}, {"objectID": "2", "name": "Benoit"}}, search.WithCreateIfNotExists(true))
if err != nil {
  // handle the eventual error
  panic(err)
}

List response = client.partialUpdateObjects(
  "INDEX_NAME",
  Arrays.asList(
    new HashMap() {
      {
        put("objectID", "1");
        put("name", "Adam");
      }
    },
    new HashMap() {
      {
        put("objectID", "2");
        put("name", "Benoit");
      }
    }
  ),
  true
);

const response = await client.partialUpdateObjects({
  indexName: 'cts_e2e_partialUpdateObjects_javascript',
  objects: [
    { objectID: '1', name: 'Adam' },
    { objectID: '2', name: 'Benoit' },
  ],
  createIfNotExists: true,
});

var response =
  client.partialUpdateObjects(
    indexName = "INDEX_NAME",
    objects =
      listOf(
        buildJsonObject {
          put("objectID", JsonPrimitive("1"))
          put("name", JsonPrimitive("Adam"))
        },
        buildJsonObject {
          put("objectID", JsonPrimitive("2"))
          put("name", JsonPrimitive("Benoit"))
        },
      ),
    createIfNotExists = true,
  )

$response = $client->partialUpdateObjects(
    'INDEX_NAME',
    [
        ['objectID' => '1',
            'name' => 'Adam',
        ],

        ['objectID' => '2',
            'name' => 'Benoit',
        ],
    ],
    true,
);

response = client.partial_update_objects(
    index_name="INDEX_NAME",
    objects=[
        {
            "objectID": "1",
            "name": "Adam",
        },
        {
            "objectID": "2",
            "name": "Benoit",
        },
    ],
    create_if_not_exists=True,
)

response = client.partial_update_objects(
  "INDEX_NAME",
  [{objectID: "1", name: "Adam"}, {objectID: "2", name: "Benoit"}],
  true
)

val response = Await.result(
  client.partialUpdateObjects(
    indexName = "INDEX_NAME",
    objects = Seq(
      JObject(List(JField("objectID", JString("1")), JField("name", JString("Adam")))),
      JObject(List(JField("objectID", JString("2")), JField("name", JString("Benoit"))))
    ),
    createIfNotExists = true
  ),
  Duration(100, "sec")
)

let response = try await client.partialUpdateObjects(
    indexName: "INDEX_NAME",
    objects: [["objectID": "1", "name": "Adam"], ["objectID": "2", "name": "Benoit"]],
    createIfNotExists: true
)

Parameters

C#

indexName · string · required

Name of the index to update records in.

objects · IEnumerable<T> · required

Records to update.

T · Type parameter · required

The model of your index’s records.

createIfNotExists · bool · required

Whether to add new records to the index if they don’t exist yet.

waitForTasks · bool · default: false

Whether to wait until all batch requests are done.

cancellationToken · CancellationToken · default: "default"

Parameter that can be used as a signal to cancel this request.

Go

indexName · string · required

Name of the index to update records in.

objects · []map[string]any · required

Records to update.

opts... · PartialUpdateObjectsOption

Functional options to provide extra arguments.

Show available functions

search.WithCreateIfNotExists · function

Signature: func(createIfNotExists bool) partialUpdateObjectsOption

Whether to add new records to the index if they don’t exist yet. By default, this function returns true.

search.WithBatchSize · function

Signature: func(batchSize int) chunkedBatchOption

Sets the number of records to process in one batch. The default batch size is 1,000.

search.WithWaitForTasks · function

Signature: func(withWaitForTasks bool) chunkedBatchOption

Whether to wait until all batch requests are done.

search.WithHeaderParam · function

Signature: func(key string, value string) requestOption

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

search.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 update records in.

objects · Iterable<T> · required

Records to update.

T · Type parameter · required

The model of your index’s records.

createIfNotExists · boolean · default: false

Whether to add new records to the index if they don’t exist yet.

waitForTasks · bool · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

JavaScript

indexName · string · required

Name of the index to update records in.

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

Records to update.

createIfNotExists · boolean · default: "undefined"

Whether to add new records to the index if they don’t exist yet.

waitForTasks · boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

Kotlin

indexName · String · required

Name of the index to update records in.

objects · List<JsonObject> · required

Records to update.

createIfNotExists · Boolean · required

Whether to add new records to the index if they don’t exist yet.

waitForTasks · Boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

PHP

indexName · string · required

Name of the index to update records in.

objects · array · required

Records to update.

createIfNotExists · bool · required

Whether to add new records to the index if they don’t exist yet.

requestOptions · array

Additional request options.

Python

index_name · str · required

Name of the index to update records in.

objects · list[dict] · required

Records to update.

create_if_not_exists · bool · default: false

Whether to add new records to the index if they don’t exist yet.

wait_for_task · bool · default: "False"

Whether to wait until all batch requests are done.

request_options · dict | RequestOptions

Additional request options.

Ruby

index_name · String · required

Name of the index to update records in.

objects · Array[Hash] · required

Records to update.

create_if_not_exists · Boolean

Whether to add new records to the index if they don’t exist yet.

wait_for_task · Boolean · default: false

Whether to wait until all batch requests are done.

request_options · Hash

Additional request options.

Scala

indexName · String · required

Name of the index to update records in.

objects · Seq[Any] · required

Records to update.

createIfNotExists · Boolean · default: false

Whether to add new records to the index if they don’t exist yet.

waitForTasks · Boolean · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.

Swift

indexName · String · required

Name of the index to update records in.

objects · [Encodable] · required

Records to update.

createIfNotExists · Bool · default: false

Whether to add new records to the index if they don’t exist yet.

waitForTasks · Bool · default: false

Whether to wait until all batch requests are done.

requestOptions · RequestOptions

Additional request options.