- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 8.10
- Set up Elasticsearch
- Installing Elasticsearch
- Run Elasticsearch locally
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Networking
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Advanced configuration
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Aliases
- Search your data
- Collapse search results
- Filter search results
- Highlighting
- Long-running searches
- Near real-time search
- Paginate search results
- Retrieve inner hits
- Retrieve selected fields
- Search across clusters
- Search multiple data streams and indices
- Search shard routing
- Search templates
- Search with synonyms
- Sort search results
- kNN search
- Semantic search
- Searching with query rules
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- EQL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- How to
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Multiple deployments writing to the same snapshot repository
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- Features APIs
- Fleet APIs
- Find structure API
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Ingest APIs
- Info API
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get service accounts
- Get service account credentials
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Update API key
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Bulk API
editBulk API
editPerforms 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"} }
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:
-
To use the
create
action, you must have thecreate_doc
,create
,index
, orwrite
index privilege. Data streams support only thecreate
action. -
To use the
index
action, you must have thecreate
,index
, orwrite
index privilege. -
To use the
delete
action, you must have thedelete
orwrite
index privilege. -
To use the
update
action, you must have theindex
orwrite
index privilege. -
To automatically create a data stream or index with a bulk API request, you
must have the
auto_configure
,create_index
, ormanage
index privilege. -
To make the result of a bulk operation visible to search using the
refresh
parameter, you must have themaintenance
ormanage
index privilege.
-
To use the
- Automatic data stream creation requires a matching index template with data stream enabled. See Set up a data stream.
Description
editProvides 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\n optional_source\n action_and_meta_data\n optional_source\n .... action_and_meta_data\n optional_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 update
or delete a document in a data stream, you must target the backing index
containing 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.
delete
does not expect a source on the next line and
has the same semantics as the standard delete API.
The final line of data must end with a newline character \n
.
Each newline character may be preceded by a carriage return \r
.
When sending NDJSON data to the _bulk
endpoint, use a Content-Type
header of
application/json
or application/x-ndjson
.
Because this format uses literal \n
's as delimiters,
make sure that the JSON actions and sources are not pretty printed.
If you provide a <target>
in the request path,
it is used for any actions that don’t explicitly specify an _index
argument.
A note on the format: The idea here is to make processing of this as
fast as possible. As some of the actions are redirected to other
shards on other nodes, only action_meta_data
is parsed on the
receiving node side.
Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.
There is no "correct" number of actions to perform in a single bulk request.
Experiment with different settings to find the optimal size for your particular
workload. Note that Elasticsearch limits the maximum size of a HTTP request to 100mb
by default so clients must ensure that no request exceeds this size. It is not
possible to index a single document which exceeds the size limit, so you must
pre-process any such documents into smaller pieces before sending them to Elasticsearch.
For instance, split documents into pages or chapters before indexing them, or
store raw binary data in a system outside Elasticsearch and replacing the raw data with
a link to the external system in the documents that you send to Elasticsearch.
Client support for bulk requests
editSome of the officially supported clients provide helpers to assist with bulk requests and reindexing:
- Go
- See esutil.BulkIndexer
- Perl
- See Search::Elasticsearch::Client::5_0::Bulk and 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 cURL
editIf you’re providing text file input to curl
, you must use the
--data-binary
flag instead of plain -d
. The latter doesn’t preserve
newlines. 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 control
editEach index
and delete
action within a bulk API call may include the
if_seq_no
and if_primary_term
parameters in their respective action
and meta data lines. The if_seq_no
and if_primary_term
parameters control
how operations are executed, based on the last modification to existing
documents. See Optimistic concurrency control for more details.
Versioning
editEach bulk item can include the version value using the
version
field. It automatically follows the behavior of the
index / delete operation based on the _version
mapping. It also
support the version_type
(see versioning).
Routing
editEach bulk item can include the routing value using the
routing
field. It automatically follows the behavior of the
index / delete operation based on the _routing
mapping.
Data streams do not support custom routing unless they were created with
the allow_custom_routing
setting
enabled in the template.
Wait for active shards
editWhen making bulk calls, you can set the wait_for_active_shards
parameter to require a minimum number of shard copies to be active
before starting to process the bulk request. See
here for further details and a usage
example.
Refresh
editControl when the changes made by this request are visible to search. See refresh.
Only the shards that receive the bulk request will be affected by
refresh
. Imagine a _bulk?refresh=wait_for
request with three
documents in it that happen to be routed to different shards in an index
with five shards. The request will only wait for those three shards to
refresh. The other two shards that make up the index do not
participate in the _bulk
request at all.
Security
editPath parameters
edit-
<target>
- (Optional, string) Name of the data stream, index, or index alias to perform bulk actions on.
Query parameters
edit-
pipeline
-
(Optional, string) ID of the pipeline to use to preprocess incoming documents. If the index has a
default ingest pipeline specified, then setting the value to
_none
disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. -
refresh
-
(Optional, enum) If
true
, Elasticsearch refreshes the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
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 tofalse
. -
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 a list of fields to return. -
_source_excludes
-
(Optional, string) A comma-separated list of source fields to exclude from the response.
You can also use this parameter to exclude fields from the subset specified in
_source_includes
query parameter.If the
_source
parameter isfalse
, this parameter is ignored. -
_source_includes
-
(Optional, string) A comma-separated list of source fields to include in the response.
If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the
_source_excludes
query parameter.If the
_source
parameter isfalse
, this parameter is ignored. -
timeout
-
(Optional, time units) Period each action waits for the following operations:
Defaults to
1m
(one minute). This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. -
wait_for_active_shards
-
(Optional, string) The number of shard copies that must be active before proceeding with the operation. Set to
all
or any positive integer up to the total number of shards in the index (number_of_replicas+1
). Default: 1, the primary shard.See Active shards.
Request body
editThe 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. This
parameter 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.
-
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 be applied regardless of other match predicates defined in the template. And if a field is already 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. This
parameter 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. This
parameter 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.
-
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 be applied regardless of other match predicates defined in the template. And if a field is already 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. This
parameter 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
andindex
operations.
Response body
editThe bulk API’s response contains the individual results of each operation in the request, returned in the order submitted. The success or failure of an individual 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 complete successfully. -
items
-
(array of objects) Contains the result of each operation in the bulk request, in the order they were submitted.
Properties of
items
objects- <action>
-
(object) The parameter name is an action associated with the operation. Possible values are
create
,delete
,index
, andupdate
.The parameter value is an object that contains information for the associated operation.
Properties of
<action>
-
_index
- (string) Name of the index associated with the operation. If the operation targeted a data 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 is incremented 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
.This parameter is only returned for successful operations.
-
_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 document doesn’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 failed operation.
-
shard
- (string) ID of the shard associated with the failed operation.
-
index
- (string) Name of the index associated with the failed operation. If the operation targeted a data stream, this is the backing index into which the document was attempted to be written.
-
-
Examples
edit$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 example
editWhen using the update
action, retry_on_conflict
can be used as a field in
the action itself (not in the extra payload line), to specify how many
times 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
(for
script), lang
(for script), and _source
. See update documentation for details on
the 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 actions
editThe following bulk API request includes operations that update non-existent documents.
$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 a
response with an errors
flag of true
.
The response also includes an error
object for any failed operations. The
error
object contains additional information about the failure, such as the
error 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 the
filter_path
query parameter with an
argument 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 parameter
editThe below example creates a dynamic template, then performs a bulk request
consisting of index/create requests with the dynamic_templates
parameter.
response = client.indices.create( index: 'my-index', body: { mappings: { dynamic_templates: [ { geo_point: { mapping: { type: 'geo_point' } } } ] } } ) puts response response = 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
according
to the dynamic_templates
parameter; however, the raw_location
field is created using default dynamic mapping
rules, as a text
field in that case since it is supplied as a string in the JSON document.
On this page
- Request
- Prerequisites
- Description
- Client support for bulk requests
- Submitting bulk requests with cURL
- Optimistic concurrency control
- Versioning
- Routing
- Wait for active shards
- Refresh
- Security
- Path parameters
- Query parameters
- Request body
- Response body
- Examples
- Bulk update example
- Example with failed actions
- Example with dynamic templates parameter