Bulk

    The bulk operation lets you add, update, or delete many documents in a single request. Compared to individual OpenSearch indexing requests, the bulk operation has significant performance benefits. Whenever practical, we recommend batching indexing operations into bulk requests.

    2. POST <index>/_bulk

    Specifying the index in the path means you don’t need to include it in the request body.

    OpenSearch also accepts PUT requests to the _bulk path, but we highly recommend using POST. The accepted usage of PUT—adding or replacing a single resource at a given path—doesn’t make sense for bulk requests.

    All bulk URL parameters are optional.

    The optional JSON document doesn’t need to be minified—spaces are fine—but it does need to be on a single line. OpenSearch uses newline characters to parse bulk requests and requires that the request body end with a newline character.

    All actions support the same metadata: _index, _id, and _require_alias. If you don’t provide an ID, OpenSearch generates one automatically, which can make it challenging to update the document at a later time.

    • Create

      Creates a document if it doesn’t already exist and returns an error otherwise. The next line must include a JSON document.

      1. { "create": { "_index": "movies", "_id": "tt1392214" } }
      2. { "title": "Prisoners", "year": 2013 }

    • This action deletes a document if it exists. If the document doesn’t exist, OpenSearch doesn’t return an error, but instead returns not_found under result. Delete actions don’t require documents on the next line.

    • Index

      Index actions create a document if it doesn’t yet exist and replace the document if it already exists. The next line must include a JSON document.

      1. { "index": { "_index": "movies", "_id": "tt1979320" } }
      2. { "title": "Rush", "year": 2013}

    • Update

    In the response, pay particular attention to the top-level errors boolean. If true, you can iterate over the individual actions for more detailed information.

    1. {
    2.   "took": 11,
    4.   "items": [
    5.     {
    6.       "index": {
    7.         "_id": "tt1979320",
    8.         "_version": 1,
    9.         "result": "created",
    10.         "_shards": {
    11.           "total": 2,
    12.           "successful": 1,
    13.           "failed": 0
    14.         },
    15.         "_seq_no": 1,
    16.         "_primary_term": 1,
    17.         "status": 201
    18.       }
    19.     },
    20.     {
    21.       "create": {
    22.         "_index": "movies",
    23.         "_id": "tt1392214",
    24.         "status": 409,
    25.         "error": {
    27.           "reason": "[tt1392214]: version conflict, document already exists (current version [1])",
    28.           "shard": "0",
    29.           "index_uuid": "yhizhusbSWmP0G7OJnmcLg"
    30.         }
    31.       }
    32.     },
    33.     {
    34.       "update": {
    35.         "_index": "movies",
    36.         "_id": "tt0816711",
    37.         "status": 404,
    38.         "error": {
    39.           "type": "document_missing_exception",
    40.           "reason": "[_doc][tt0816711]: document missing",
    41.           "index": "movies",
    42.           "shard": "0",
    43.           "index_uuid": "yhizhusbSWmP0G7OJnmcLg"
    44.         }
    45.       }
    46.     }
    47.   ]
    48. }