Bulk API | Elasticsearch Guide [8.14] (2024)

« Multi get (mget) APIReindex API »

Elastic Docs›Elasticsearch Guide [8.14]›REST APIs›Document APIs

Bulk APIedit

Performs multiple indexing or delete operations in a single API call.This reduces overhead and can greatly increase indexing speed.

$params = [ 'body' => [ [ 'index' => [ '_index' => 'test', '_id' => '1', ], ], [ 'field1' => 'value1', ], [ 'delete' => [ '_index' => 'test', '_id' => '2', ], ], [ 'create' => [ '_index' => 'test', '_id' => '3', ], ], [ 'field1' => 'value3', ], [ 'update' => [ '_id' => '1', '_index' => 'test', ], ], [ 'doc' => [ 'field2' => 'value2', ], ], ],];$response = $client->bulk($params);

resp = client.bulk( body=[ {"index": {"_index": "test", "_id": "1"}}, {"field1": "value1"}, {"delete": {"_index": "test", "_id": "2"}}, {"create": {"_index": "test", "_id": "3"}}, {"field1": "value3"}, {"update": {"_id": "1", "_index": "test"}}, {"doc": {"field2": "value2"}}, ],)print(resp)

response = client.bulk( body: [ { index: { _index: 'test', _id: '1' } }, { "field1": 'value1' }, { delete: { _index: 'test', _id: '2' } }, { create: { _index: 'test', _id: '3' } }, { "field1": 'value3' }, { update: { _id: '1', _index: 'test' } }, { doc: { "field2": 'value2' } } ])puts response

res, err := es.Bulk(strings.NewReader(`{ "index" : { "_index" : "test", "_id" : "1" } }{ "field1" : "value1" }{ "delete" : { "_index" : "test", "_id" : "2" } }{ "create" : { "_index" : "test", "_id" : "3" } }{ "field1" : "value3" }{ "update" : {"_id" : "1", "_index" : "test"} }{ "doc" : {"field2" : "value2"} }`),)fmt.Println(res, err)

const response = await client.bulk({ body: [ { index: { _index: 'test', _id: '1' } }, { field1: 'value1' }, { delete: { _index: 'test', _id: '2' } }, { create: { _index: 'test', _id: '3' } }, { field1: 'value3' }, { update: { _id: '1', _index: 'test' } }, { doc: { field2: 'value2' } } ]})console.log(response)

POST _bulk{ "index" : { "_index" : "test", "_id" : "1" } }{ "field1" : "value1" }{ "delete" : { "_index" : "test", "_id" : "2" } }{ "create" : { "_index" : "test", "_id" : "3" } }{ "field1" : "value3" }{ "update" : {"_id" : "1", "_index" : "test"} }{ "doc" : {"field2" : "value2"} }

Requestedit

POST /_bulk

POST /<target>/_bulk

Prerequisitesedit

If the Elasticsearch security features are enabled, you must have the followingindex privileges for the target data stream, index,or index alias:
- To use the create action, you must have the create_doc, create,index, or write index privilege. Data streams support only the createaction.
- To use the index action, you must have the create, index, or writeindex privilege.
- To use the delete action, you must have the delete or write indexprivilege.
- To use the update action, you must have the index or write indexprivilege.
- To automatically create a data stream or index with a bulk API request, youmust have the auto_configure, create_index, or manage index privilege.
- To make the result of a bulk operation visible to search using the refreshparameter, you must have the maintenance or manage index privilege.
Automatic data stream creation requires a matching index template with datastream enabled. See Set up a data stream.

Descriptionedit

Provides a way to perform multiple index, create, delete, and update actions in a single request.

The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:

action_and_meta_data\noptional_source\naction_and_meta_data\noptional_source\n....action_and_meta_data\noptional_source\n

The index and create actions expect a source on the next line,and have the same semantics as the op_type parameter in the standard index API:create fails if a document with the same ID already exists in the target,index adds or replaces a document as necessary.

Data streams support only the create action. To updateor delete a document in a data stream, you must target the backing indexcontaining the document. See Update or delete documents in a backing index.

update expects that the partial doc, upsert,and script and its options are specified on the next line.

Client support for bulk requestsedit

Some of the officially supported clients provide helpers to assist withbulk requests and reindexing:

Go: See esutil.BulkIndexer
Perl: See Search::Elasticsearch::Client::5_0::Bulkand Search::Elasticsearch::Client::5_0::Scroll
Python: See elasticsearch.helpers.*
JavaScript: See client.helpers.*
.NET: See BulkAllObservable
PHP: See Bulk indexing

Submitting bulk requests with cURLedit

If you’re providing text file input to curl, you must use the--data-binary flag instead of plain -d. The latter doesn’t preservenewlines. Example:

$ cat requests{ "index" : { "_index" : "test", "_id" : "1" } }{ "field1" : "value1" }$ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo{"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]}

Optimistic concurrency controledit

Each index and delete action within a bulk API call may include theif_seq_no and if_primary_term parameters in their respective actionand meta data lines. The if_seq_no and if_primary_term parameters controlhow operations are executed, based on the last modification to existingdocuments. See Optimistic concurrency control for more details.

Versioningedit

Each bulk item can include the version value using theversion field. It automatically follows the behavior of theindex / delete operation based on the _version mapping. It alsosupport the version_type (see versioning).

Routingedit

Each bulk item can include the routing value using therouting field. It automatically follows the behavior of theindex / delete operation based on the _routing mapping.

Data streams do not support custom routing unless they were created withthe allow_custom_routing settingenabled in the template.

Wait for active shardsedit

When making bulk calls, you can set the wait_for_active_shardsparameter to require a minimum number of shard copies to be activebefore starting to process the bulk request. Seehere for further details and a usageexample.

Refreshedit

Control when the changes made by this request are visible to search. Seerefresh.

Only the shards that receive the bulk request will be affected byrefresh. Imagine a _bulk?refresh=wait_for request with threedocuments in it that happen to be routed to different shards in an indexwith five shards. The request will only wait for those three shards torefresh. The other two shards that make up the index do notparticipate in the _bulk request at all.

Securityedit

See URL-based access control.

Path parametersedit

<target>: (Optional, string)Name of the data stream, index, or index alias to perform bulk actionson.

Query parametersedit

list_executed_pipelines

(Optional, Boolean) If true, the response will include the ingest pipelines thatwere executed for each index or create.Defaults to false.

pipeline

(Optional, string) ID of the pipeline to use to preprocess incoming documents. If the index has adefault ingest pipeline specified, then setting the value to _none disables the default ingestpipeline for this request. If a final pipeline is configured it will always run, regardless of thevalue of this parameter.

refresh

(Optional, enum) If true, Elasticsearch refreshes the affected shards to make thisoperation visible to search, if wait_for then wait for a refresh to makethis operation visible to search, if false do nothing with refreshes.Valid values: true, false, wait_for. Default: false.

require_alias

(Optional, Boolean) If true, the request’s actions must target an index alias.Defaults to false.

routing

(Optional, string)Custom value used to route operations to a specific shard.

_source

(Optional, string) True or false to return the _source field or not, or alist of fields to return.

_source_excludes

(Optional, string)A comma-separated list of source fields to exclude fromthe response.

You can also use this parameter to exclude fields from the subset specified in_source_includes query parameter.

If the _source parameter is false, this parameter is ignored.

_source_includes

(Optional, string)A comma-separated list of source fields toinclude in the response.

If this parameter is specified, only these source fields are returned. You canexclude fields from this subset using the _source_excludes query parameter.

If the _source parameter is false, this parameter is ignored.

timeout

(Optional, time units)Period each action waits for the following operations:

Automatic index creation
Dynamic mapping updates
Waiting for active shards

Defaults to 1m (one minute). This guarantees Elasticsearch waits for at least thetimeout before failing. The actual wait time could be longer, particularly whenmultiple waits occur.

wait_for_active_shards

(Optional, string) The number of shard copies that must be active beforeproceeding with the operation. Set to all or any positive integer upto the total number of shards in the index (number_of_replicas+1).Default: 1, the primary shard.

See Active shards.

Request bodyedit

The request body contains a newline-delimited list of create, delete, index,and update actions and their associated source data.

create

(Optional, string)Indexes the specified document if it does not already exist.The following line must contain the source data to be indexed.

_index: (Optional, string)Name of the data stream, index, or index alias to perform the action on. Thisparameter is required if a <target> is not specified in the request path.
_id: (Optional, string)The document ID.If no ID is specified, a document ID is automatically generated.
list_executed_pipelines: (Optional, Boolean) If true, the response will include the ingest pipelines thatwere executed. Defaults to false.
require_alias: (Optional, Boolean)If true, the action must target an index alias. Defaults tofalse.
dynamic_templates: (Optional, map)A map from the full name of fields to the name of dynamic templates.Defaults to an empty map. If a name matches a dynamic template, then that template will beapplied regardless of other match predicates defined in the template. And if a field isalready defined in the mapping, then this parameter won’t be used.

delete

(Optional, string)Removes the specified document from the index.

_index: (Optional, string)Name of the index or index alias to perform the action on. Thisparameter is required if a <target> is not specified in the request path.
_id: (Required, string) The document ID.
require_alias: (Optional, Boolean)If true, the action must target an index alias. Defaults tofalse.

index

(Optional, string)Indexes the specified document.If the document exists, replaces the document and increments the version.The following line must contain the source data to be indexed.

_index: (Optional, string)Name of the index or index alias to perform the action on. Thisparameter is required if a <target> is not specified in the request path.
_id: (Optional, string)The document ID.If no ID is specified, a document ID is automatically generated.
list_executed_pipelines: (Optional, Boolean) If true, the response will include the ingest pipelines thatwere executed. Defaults to false.
require_alias: (Optional, Boolean)If true, the action must target an index alias. Defaults tofalse.
dynamic_templates: (Optional, map)A map from the full name of fields to the name of dynamic templates.Defaults to an empty map. If a name matches a dynamic template, then that template will beapplied regardless of other match predicates defined in the template. And if a field isalready defined in the mapping, then this parameter won’t be used.

update

(Optional, string)Performs a partial document update.The following line must contain the partial document and update options.

_index: (Optional, string)Name of the index or index alias to perform the action on. Thisparameter is required if a <target> is not specified in the request path.
_id: (Required, string) The document ID.
require_alias: (Optional, Boolean)If true, the action must target an index alias. Defaults tofalse.

doc

(Optional, object)The partial document to index.Required for update operations.

<fields>

(Optional, object)The document source to index.Required for create and index operations.

Response bodyedit

The bulk API’s response contains the individual results of each operation in therequest, returned in the order submitted. The success or failure of anindividual operation does not affect other operations in the request.

took

(integer)How long, in milliseconds, it took to process the bulk request.

errors

(Boolean)If true, one or more of the operations in the bulk request did not completesuccessfully.

items

(array of objects)Contains the result of each operation in the bulk request, in the order theywere submitted.

Properties of items objects

<action>

(object)The parameter name is an action associated with the operation. Possible valuesare create, delete, index, and update.

The parameter value is an object that contains information for the associatedoperation.

Properties of <action>

_index

(string)Name of the index associated with the operation. If the operation targeted adata stream, this is the backing index into which the document was written.

_id

(integer)The document ID associated with the operation.

_version

(integer)The document version associated with the operation. The document version isincremented each time the document is updated.

This parameter is only returned for successful actions.

result

(string)Result of the operation. Successful values are created, deleted, andupdated. Other valid values are noop and not_found.

_shards

(object)Contains shard information for the operation.

This parameter is only returned for successful operations.

Properties of _shards

total: (integer)Number of shards the operation attempted to execute on.
successful: (integer)Number of shards the operation succeeded on.
failed: (integer)Number of shards the operation attempted to execute on but failed.

_seq_no

(integer)The sequence number assigned to the document for the operation.Sequence numbers are used to ensure an older version of a documentdoesn’t overwrite a newer version. See Optimistic concurrency control.

This parameter is only returned for successful operations.

_primary_term

(integer)The primary term assigned to the document for the operation.See Optimistic concurrency control.

This parameter is only returned for successful operations.

status

(integer)HTTP status code returned for the operation.

error

(object)Contains additional information about the failed operation.

The parameter is only returned for failed operations.

Properties of error

type: (string)Error type for the operation.
reason: (string)Reason for the failed operation.
index_uuid: (string)The universally unique identifier (UUID) of the index associated with the failedoperation.
shard: (string)ID of the shard associated with the failed operation.
index: (string)Name of the index associated with the failed operation. If the operationtargeted a data stream, this is the backing index into which the document wasattempted to be written.

Examplesedit

$params = [ 'body' => [ [ 'index' => [ '_index' => 'test', '_id' => '1', ], ], [ 'field1' => 'value1', ], [ 'delete' => [ '_index' => 'test', '_id' => '2', ], ], [ 'create' => [ '_index' => 'test', '_id' => '3', ], ], [ 'field1' => 'value3', ], [ 'update' => [ '_id' => '1', '_index' => 'test', ], ], [ 'doc' => [ 'field2' => 'value2', ], ], ],];$response = $client->bulk($params);

resp = client.bulk( body=[ {"index": {"_index": "test", "_id": "1"}}, {"field1": "value1"}, {"delete": {"_index": "test", "_id": "2"}}, {"create": {"_index": "test", "_id": "3"}}, {"field1": "value3"}, {"update": {"_id": "1", "_index": "test"}}, {"doc": {"field2": "value2"}}, ],)print(resp)

response = client.bulk( body: [ { index: { _index: 'test', _id: '1' } }, { "field1": 'value1' }, { delete: { _index: 'test', _id: '2' } }, { create: { _index: 'test', _id: '3' } }, { "field1": 'value3' }, { update: { _id: '1', _index: 'test' } }, { doc: { "field2": 'value2' } } ])puts response

res, err := es.Bulk(strings.NewReader(`{ "index" : { "_index" : "test", "_id" : "1" } }{ "field1" : "value1" }{ "delete" : { "_index" : "test", "_id" : "2" } }{ "create" : { "_index" : "test", "_id" : "3" } }{ "field1" : "value3" }{ "update" : {"_id" : "1", "_index" : "test"} }{ "doc" : {"field2" : "value2"} }`),)fmt.Println(res, err)

const response = await client.bulk({ body: [ { index: { _index: 'test', _id: '1' } }, { field1: 'value1' }, { delete: { _index: 'test', _id: '2' } }, { create: { _index: 'test', _id: '3' } }, { field1: 'value3' }, { update: { _id: '1', _index: 'test' } }, { doc: { field2: 'value2' } } ]})console.log(response)

POST _bulk{ "index" : { "_index" : "test", "_id" : "1" } }{ "field1" : "value1" }{ "delete" : { "_index" : "test", "_id" : "2" } }{ "create" : { "_index" : "test", "_id" : "3" } }{ "field1" : "value3" }{ "update" : {"_id" : "1", "_index" : "test"} }{ "doc" : {"field2" : "value2"} }

The API returns the following result:

{ "took": 30, "errors": false, "items": [ { "index": { "_index": "test", "_id": "1", "_version": 1, "result": "created", "_shards": { "total": 2, "successful": 1, "failed": 0 }, "status": 201, "_seq_no" : 0, "_primary_term": 1 } }, { "delete": { "_index": "test", "_id": "2", "_version": 1, "result": "not_found", "_shards": { "total": 2, "successful": 1, "failed": 0 }, "status": 404, "_seq_no" : 1, "_primary_term" : 2 } }, { "create": { "_index": "test", "_id": "3", "_version": 1, "result": "created", "_shards": { "total": 2, "successful": 1, "failed": 0 }, "status": 201, "_seq_no" : 2, "_primary_term" : 3 } }, { "update": { "_index": "test", "_id": "1", "_version": 2, "result": "updated", "_shards": { "total": 2, "successful": 1, "failed": 0 }, "status": 200, "_seq_no" : 3, "_primary_term" : 4 } } ]}

Bulk update exampleedit

When using the update action, retry_on_conflict can be used as a field inthe action itself (not in the extra payload line), to specify how manytimes an update should be retried in the case of a version conflict.

The update action payload supports the following options: doc(partial document), upsert, doc_as_upsert, script, params (forscript), lang (for script), and _source. See update documentation for details onthe options. Example with update actions:

$params = [ 'body' => [ [ 'update' => [ '_id' => '1', '_index' => 'index1', 'retry_on_conflict' => 3, ], ], [ 'doc' => [ 'field' => 'value', ], ], [ 'update' => [ '_id' => '0', '_index' => 'index1', 'retry_on_conflict' => 3, ], ], [ 'script' => [ 'source' => 'ctx._source.counter += params.param1', 'lang' => 'painless', 'params' => [ 'param1' => 1, ], ], 'upsert' => [ 'counter' => 1, ], ], [ 'update' => [ '_id' => '2', '_index' => 'index1', 'retry_on_conflict' => 3, ], ], [ 'doc' => [ 'field' => 'value', ], 'doc_as_upsert' => true, ], [ 'update' => [ '_id' => '3', '_index' => 'index1', '_source' => true, ], ], [ 'doc' => [ 'field' => 'value', ], ], [ 'update' => [ '_id' => '4', '_index' => 'index1', ], ], [ 'doc' => [ 'field' => 'value', ], '_source' => true, ], ],];$response = $client->bulk($params);

resp = client.bulk( body=[ { "update": { "_id": "1", "_index": "index1", "retry_on_conflict": 3, } }, {"doc": {"field": "value"}}, { "update": { "_id": "0", "_index": "index1", "retry_on_conflict": 3, } }, { "script": { "source": "ctx._source.counter += params.param1", "lang": "painless", "params": {"param1": 1}, }, "upsert": {"counter": 1}, }, { "update": { "_id": "2", "_index": "index1", "retry_on_conflict": 3, } }, {"doc": {"field": "value"}, "doc_as_upsert": True}, {"update": {"_id": "3", "_index": "index1", "_source": True}}, {"doc": {"field": "value"}}, {"update": {"_id": "4", "_index": "index1"}}, {"doc": {"field": "value"}, "_source": True}, ],)print(resp)

response = client.bulk( body: [ { update: { _id: '1', _index: 'index1', retry_on_conflict: 3 } }, { doc: { field: 'value' } }, { update: { _id: '0', _index: 'index1', retry_on_conflict: 3 } }, { script: { source: 'ctx._source.counter += params.param1', lang: 'painless', params: { "param1": 1 } }, upsert: { counter: 1 } }, { update: { _id: '2', _index: 'index1', retry_on_conflict: 3 } }, { doc: { field: 'value' }, doc_as_upsert: true }, { update: { _id: '3', _index: 'index1', _source: true } }, { doc: { field: 'value' } }, { update: { _id: '4', _index: 'index1' } }, { doc: { field: 'value' }, _source: true } ])puts response

res, err := es.Bulk(strings.NewReader(`{ "update" : {"_id" : "1", "_index" : "index1", "retry_on_conflict" : 3} }{ "doc" : {"field" : "value"} }{ "update" : { "_id" : "0", "_index" : "index1", "retry_on_conflict" : 3} }{ "script" : { "source": "ctx._source.counter += params.param1", "lang" : "painless", "params" : {"param1" : 1}}, "upsert" : {"counter" : 1}}{ "update" : {"_id" : "2", "_index" : "index1", "retry_on_conflict" : 3} }{ "doc" : {"field" : "value"}, "doc_as_upsert" : true }{ "update" : {"_id" : "3", "_index" : "index1", "_source" : true} }{ "doc" : {"field" : "value"} }{ "update" : {"_id" : "4", "_index" : "index1"} }{ "doc" : {"field" : "value"}, "_source": true}`),)fmt.Println(res, err)

const response = await client.bulk({ body: [ { update: { _id: '1', _index: 'index1', retry_on_conflict: 3 } }, { doc: { field: 'value' } }, { update: { _id: '0', _index: 'index1', retry_on_conflict: 3 } }, { script: { source: 'ctx._source.counter += params.param1', lang: 'painless', params: { param1: 1 } }, upsert: { counter: 1 } }, { update: { _id: '2', _index: 'index1', retry_on_conflict: 3 } }, { doc: { field: 'value' }, doc_as_upsert: true }, { update: { _id: '3', _index: 'index1', _source: true } }, { doc: { field: 'value' } }, { update: { _id: '4', _index: 'index1' } }, { doc: { field: 'value' }, _source: true } ]})console.log(response)

POST _bulk{ "update" : {"_id" : "1", "_index" : "index1", "retry_on_conflict" : 3} }{ "doc" : {"field" : "value"} }{ "update" : { "_id" : "0", "_index" : "index1", "retry_on_conflict" : 3} }{ "script" : { "source": "ctx._source.counter += params.param1", "lang" : "painless", "params" : {"param1" : 1}}, "upsert" : {"counter" : 1}}{ "update" : {"_id" : "2", "_index" : "index1", "retry_on_conflict" : 3} }{ "doc" : {"field" : "value"}, "doc_as_upsert" : true }{ "update" : {"_id" : "3", "_index" : "index1", "_source" : true} }{ "doc" : {"field" : "value"} }{ "update" : {"_id" : "4", "_index" : "index1"} }{ "doc" : {"field" : "value"}, "_source": true}

Example with failed actionsedit

The following bulk API request includes operations that update non-existentdocuments.

$params = [ 'body' => [ [ 'update' => [ '_id' => '5', '_index' => 'index1', ], ], [ 'doc' => [ 'my_field' => 'foo', ], ], [ 'update' => [ '_id' => '6', '_index' => 'index1', ], ], [ 'doc' => [ 'my_field' => 'foo', ], ], [ 'create' => [ '_id' => '7', '_index' => 'index1', ], ], [ 'my_field' => 'foo', ], ],];$response = $client->bulk($params);

resp = client.bulk( body=[ {"update": {"_id": "5", "_index": "index1"}}, {"doc": {"my_field": "foo"}}, {"update": {"_id": "6", "_index": "index1"}}, {"doc": {"my_field": "foo"}}, {"create": {"_id": "7", "_index": "index1"}}, {"my_field": "foo"}, ],)print(resp)

response = client.bulk( body: [ { update: { _id: '5', _index: 'index1' } }, { doc: { my_field: 'foo' } }, { update: { _id: '6', _index: 'index1' } }, { doc: { my_field: 'foo' } }, { create: { _id: '7', _index: 'index1' } }, { my_field: 'foo' } ])puts response

res, err := es.Bulk(strings.NewReader(`{ "update": {"_id": "5", "_index": "index1"} }{ "doc": {"my_field": "foo"} }{ "update": {"_id": "6", "_index": "index1"} }{ "doc": {"my_field": "foo"} }{ "create": {"_id": "7", "_index": "index1"} }{ "my_field": "foo" }`),)fmt.Println(res, err)

const response = await client.bulk({ body: [ { update: { _id: '5', _index: 'index1' } }, { doc: { my_field: 'foo' } }, { update: { _id: '6', _index: 'index1' } }, { doc: { my_field: 'foo' } }, { create: { _id: '7', _index: 'index1' } }, { my_field: 'foo' } ]})console.log(response)

POST /_bulk{ "update": {"_id": "5", "_index": "index1"} }{ "doc": {"my_field": "foo"} }{ "update": {"_id": "6", "_index": "index1"} }{ "doc": {"my_field": "foo"} }{ "create": {"_id": "7", "_index": "index1"} }{ "my_field": "foo" }

Because these operations cannot complete successfully, the API returns aresponse with an errors flag of true.

The response also includes an error object for any failed operations. Theerror object contains additional information about the failure, such as theerror type and reason.

{ "took": 486, "errors": true, "items": [ { "update": { "_index": "index1", "_id": "5", "status": 404, "error": { "type": "document_missing_exception", "reason": "[5]: document missing", "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA", "shard": "0", "index": "index1" } } }, { "update": { "_index": "index1", "_id": "6", "status": 404, "error": { "type": "document_missing_exception", "reason": "[6]: document missing", "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA", "shard": "0", "index": "index1" } } }, { "create": { "_index": "index1", "_id": "7", "_version": 1, "result": "created", "_shards": { "total": 2, "successful": 1, "failed": 0 }, "_seq_no": 0, "_primary_term": 1, "status": 201 } } ]}

To return only information about failed operations, use thefilter_path query parameter with anargument of items.*.error.

$params = [ 'body' => [ [ 'update' => [ '_id' => '5', '_index' => 'index1', ], ], [ 'doc' => [ 'my_field' => 'baz', ], ], [ 'update' => [ '_id' => '6', '_index' => 'index1', ], ], [ 'doc' => [ 'my_field' => 'baz', ], ], [ 'update' => [ '_id' => '7', '_index' => 'index1', ], ], [ 'doc' => [ 'my_field' => 'baz', ], ], ],];$response = $client->bulk($params);

resp = client.bulk( filter_path="items.*.error", body=[ {"update": {"_id": "5", "_index": "index1"}}, {"doc": {"my_field": "baz"}}, {"update": {"_id": "6", "_index": "index1"}}, {"doc": {"my_field": "baz"}}, {"update": {"_id": "7", "_index": "index1"}}, {"doc": {"my_field": "baz"}}, ],)print(resp)

response = client.bulk( filter_path: 'items.*.error', body: [ { update: { _id: '5', _index: 'index1' } }, { doc: { my_field: 'baz' } }, { update: { _id: '6', _index: 'index1' } }, { doc: { my_field: 'baz' } }, { update: { _id: '7', _index: 'index1' } }, { doc: { my_field: 'baz' } } ])puts response

res, err := es.Bulk(strings.NewReader(`{ "update": {"_id": "5", "_index": "index1"} }{ "doc": {"my_field": "baz"} }{ "update": {"_id": "6", "_index": "index1"} }{ "doc": {"my_field": "baz"} }{ "update": {"_id": "7", "_index": "index1"} }{ "doc": {"my_field": "baz"} }`),es.Bulk.WithFilterPath("items.*.error"),)fmt.Println(res, err)

const response = await client.bulk({ filter_path: 'items.*.error', body: [ { update: { _id: '5', _index: 'index1' } }, { doc: { my_field: 'baz' } }, { update: { _id: '6', _index: 'index1' } }, { doc: { my_field: 'baz' } }, { update: { _id: '7', _index: 'index1' } }, { doc: { my_field: 'baz' } } ]})console.log(response)

POST /_bulk?filter_path=items.*.error{ "update": {"_id": "5", "_index": "index1"} }{ "doc": {"my_field": "baz"} }{ "update": {"_id": "6", "_index": "index1"} }{ "doc": {"my_field": "baz"} }{ "update": {"_id": "7", "_index": "index1"} }{ "doc": {"my_field": "baz"} }

The API returns the following result.

{ "items": [ { "update": { "error": { "type": "document_missing_exception", "reason": "[5]: document missing", "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA", "shard": "0", "index": "index1" } } }, { "update": { "error": { "type": "document_missing_exception", "reason": "[6]: document missing", "index_uuid": "aAsFqTI0Tc2W0LCWgPNrOA", "shard": "0", "index": "index1" } } } ]}

Example with dynamic templates parameteredit

The below example creates a dynamic template, then performs a bulk requestconsisting of index/create requests with the dynamic_templates parameter.

resp = client.indices.create( index="my-index", body={ "mappings": { "dynamic_templates": [ {"geo_point": {"mapping": {"type": "geo_point"}}} ] } },)print(resp)resp = client.bulk( body=[ { "index": { "_index": "my_index", "_id": "1", "dynamic_templates": {"work_location": "geo_point"}, } }, { "field": "value1", "work_location": "41.12,-71.34", "raw_location": "41.12,-71.34", }, { "create": { "_index": "my_index", "_id": "2", "dynamic_templates": {"home_location": "geo_point"}, } }, {"field": "value2", "home_location": "41.12,-71.34"}, ],)print(resp)

response = client.indices.create( index: 'my-index', body: { mappings: { dynamic_templates: [ { geo_point: { mapping: { type: 'geo_point' } } } ] } })puts responseresponse = client.bulk( body: [ { index: { _index: 'my_index', _id: '1', dynamic_templates: { work_location: 'geo_point' } } }, { field: 'value1', work_location: '41.12,-71.34', raw_location: '41.12,-71.34' }, { create: { _index: 'my_index', _id: '2', dynamic_templates: { home_location: 'geo_point' } } }, { field: 'value2', home_location: '41.12,-71.34' } ])puts response

PUT my-index/{ "mappings": { "dynamic_templates": [ { "geo_point": { "mapping": { "type" : "geo_point" } } } ] }}POST /_bulk{ "index" : { "_index" : "my_index", "_id" : "1", "dynamic_templates": {"work_location": "geo_point"}} }{ "field" : "value1", "work_location": "41.12,-71.34", "raw_location": "41.12,-71.34"}{ "create" : { "_index" : "my_index", "_id" : "2", "dynamic_templates": {"home_location": "geo_point"}} }{ "field" : "value2", "home_location": "41.12,-71.34"}

The bulk request creates two new fields work_location and home_location with type geo_point accordingto the dynamic_templates parameter; however, the raw_location field is created using default dynamic mappingrules, as a text field in that case since it is supplied as a string in the JSON document.

« Multi get (mget) APIReindex API »