Bulk indexing optimization in Elasticsearch - Step-by-Step Execution

Concept Flow - Bulk indexing optimization

Prepare bulk data

↓

Create bulk request payload

↓

Send bulk request to Elasticsearch

↓

Receive response

↓

Check for errors

↓

Retry or log

↓

End

This flow shows how bulk data is prepared, sent to Elasticsearch in one request, and how responses are handled to optimize indexing speed.

Execution Sample

Elasticsearch

POST _bulk
{ "index" : { "_index" : "test", "_id" : "1" } }
{ "field1" : "value1" }
{ "index" : { "_index" : "test", "_id" : "2" } }
{ "field1" : "value2" }

This example sends two documents in a single bulk request to Elasticsearch to index them efficiently.

Execution Table

Step	Action	Payload Sent	Response	Next Step
1	Prepare bulk payload	{"index":{"_index":"test","_id":"1"}} {"field1":"value1"} {"index":{"_index":"test","_id":"2"}} {"field1":"value2"}	N/A	Send bulk request
2	Send bulk request	Bulk payload from step 1	{"took":5,"errors":false,"items":[{"index":{"_id":"1","status":201}},{"index":{"_id":"2","status":201}}]}	Check for errors
3	Check for errors	N/A	errors=false	Success, end
4	End	N/A	N/A	Process complete

💡 Bulk request completed successfully with no errors, indexing two documents in one request.

Variable Tracker

Variable	Start	After Step 1	After Step 2	Final
bulk_payload	empty	{"index":{"_index":"test","_id":"1"}} {"field1":"value1"} {"index":{"_index":"test","_id":"2"}} {"field1":"value2"}	sent	N/A
response	none	none	{"took":5,"errors":false,"items":[{"index":{"_id":"1","status":201}},{"index":{"_id":"2","status":201}}]}	stored
errors	unknown	unknown	false	false

Key Moments - 3 Insights

Why do we send multiple documents in one bulk request instead of one by one?

Sending multiple documents in one bulk request reduces network overhead and speeds up indexing, as shown in step 2 where both documents are sent together.

What happens if the bulk response shows errors?

If errors are true (not shown here), you should retry or log the failed items as indicated in the flow after checking errors in step 3.

Why is the bulk payload formatted with alternating action and data lines?

Elasticsearch expects bulk payloads with an action line (like index) followed by the document data line, repeated for each document, as seen in the payload in step 1.

Visual Quiz - 3 Questions

Look at the execution table, what is the value of 'errors' in the response at step 3?

A true

B false

C null

D undefined

💡 Hint

Check the 'Response' column in row for step 3 in the execution_table.

At which step is the bulk payload actually sent to Elasticsearch?

A Step 1

B Step 3

C Step 2

D Step 4

💡 Hint

Look at the 'Action' and 'Next Step' columns in the execution_table for when sending occurs.

If the bulk payload included 5 documents instead of 2, how would the 'Payload Sent' in step 1 change?

A It would have 10 lines alternating action and data

B It would have 5 lines total

C It would have 5 lines alternating action and data

D It would have 2 lines total

💡 Hint

Remember each document needs an action line and a data line, doubling the number of lines.

Concept Snapshot

Bulk indexing optimization in Elasticsearch:
- Prepare multiple documents in one payload
- Format as alternating action and data lines
- Send one bulk request to reduce overhead
- Check response for errors
- Retry failed items if needed

Full Transcript

Bulk indexing optimization means sending many documents to Elasticsearch in one request instead of one by one. First, you prepare the bulk payload with alternating lines: one line to tell Elasticsearch what to do (like index) and one line with the document data. Then you send this big payload in a single request. Elasticsearch processes all documents quickly and returns a response showing if any errors happened. If errors occur, you retry or log them. This method saves time and network resources compared to sending documents individually.

Practice

1. What is the main benefit of using the _bulk API in Elasticsearch for indexing documents?

easy

A. It reduces the number of network requests by sending many documents at once.

B. It automatically fixes errors in documents before indexing.

C. It compresses documents to save disk space.

D. It indexes documents one by one to ensure accuracy.

Solution

1. Step 1: Understand the purpose of bulk API

   The bulk API is designed to send multiple documents in a single request to Elasticsearch.

2. Step 2: Identify the main advantage

   Sending many documents at once reduces network overhead and speeds up indexing.

3. Final Answer:

   It reduces the number of network requests by sending many documents at once. -> Option A

4. Quick Check:

   Bulk API = fewer requests = faster indexing [OK]

Hint: Bulk API batches documents to reduce network calls [OK]

Common Mistakes:

• Thinking bulk API fixes document errors automatically
• Believing bulk API compresses data for storage
• Assuming bulk API indexes documents one by one

2. Which of the following is the correct JSON structure for a single bulk action in Elasticsearch?

easy

A. { "index": { "_index": "myindex", "_id": "1" } }\n{ "field": "value" }

B. A, C, and D are all valid bulk actions

C. { "update": { "_index": "myindex", "_id": "1" } }\n{ "doc": { "field": "value" } }

D. { "create": { "_index": "myindex" } }\n{ "field": "value" }

Solution

1. Step 1: Review bulk action types

   Elasticsearch bulk API supports multiple actions: index, create, update.

2. Step 2: Check each option

   A shows an index action, C an update action, D a create action. All are valid formats.

3. Final Answer:

   A, C, and D are all valid bulk actions -> Option B

4. Quick Check:

   Bulk supports index, create, update actions [OK]

Hint: Bulk API supports index, create, update actions [OK]

Common Mistakes:

• Thinking only index action is allowed
• Confusing create and update JSON formats
• Missing newline between action and data lines

3. Given this Python snippet using Elasticsearch bulk API, what will be the output if one document has a mapping error?

from elasticsearch import Elasticsearch, helpers
es = Elasticsearch()
docs = [
  {"_index": "test", "_id": "1", "field": "value1"},
  {"_index": "test", "_id": "2", "field": 123}  # mapping error if field expects string
]
response = helpers.bulk(es, docs)
print(response)

medium

A. (2, []) # all documents indexed successfully

B. (0, [{"index": {"_id": "1", "error": "mapper_parsing_exception"}}, {"index": {"_id": "2", "error": "mapper_parsing_exception"}}])

C. Raises a Python exception and stops

D. (1, [{"index": {"_id": "2", "error": "mapper_parsing_exception"}}])

Solution

1. Step 1: Understand helpers.bulk behavior

   helpers.bulk returns a tuple: (success_count, errors_list). It continues indexing even if some docs fail.

2. Step 2: Analyze the documents

   First doc is valid, second has a mapping error (wrong type). So one success, one error.

3. Final Answer:

   (1, [{"index": {"_id": "2", "error": "mapper_parsing_exception"}}]) -> Option D

4. Quick Check:

   One success, one mapping error = (1, [{"index": {"_id": "2", "error": "mapper_parsing_exception"}}]) [OK]

Hint: helpers.bulk returns (success_count, errors) tuple [OK]

Common Mistakes:

• Assuming bulk stops on first error
• Expecting a Python exception instead of error info
• Misreading success count as total docs

4. You wrote this bulk request but it fails with a parsing error. What is the mistake?

{ "index": { "_index": "myindex", "_id": "1" }
{ "field": "value" }

medium

A. Incorrect _id field type

B. Missing comma between JSON objects

C. Missing newline between action and data lines

D. Using index instead of create action

Solution

1. Step 1: Check bulk request format

   Bulk API requires each action line and data line to be separated by a newline character.

2. Step 2: Identify the error

   The given request misses a newline between the two JSON objects, causing parsing failure.

3. Final Answer:

   Missing newline between action and data lines -> Option C

4. Quick Check:

   Bulk lines must be separated by newlines [OK]

Hint: Each bulk action and data must be on separate lines [OK]

Common Mistakes:

• Forgetting newline between JSON objects
• Adding commas between bulk lines
• Confusing index and create actions

5. You want to optimize bulk indexing for 10,000 documents. Which approach best balances speed and reliability?

hard

A. Split documents into batches of 500, send each batch, and check for errors after each batch.

B. Send all 10,000 documents in a single bulk request without checking errors.

C. Index documents one by one to catch errors immediately.

D. Send batches of 10 documents to avoid any errors.

Solution

1. Step 1: Consider bulk request size

   Very large bulk requests (like 10,000 docs) can cause memory or timeout issues.

2. Step 2: Choose batch size and error handling

   Splitting into moderate batches (e.g., 500) balances speed and resource use. Checking errors after each batch ensures reliability.

3. Final Answer:

   Split documents into batches of 500, send each batch, and check for errors after each batch. -> Option A

4. Quick Check:

   Batching + error check = optimal bulk indexing [OK]

Hint: Use moderate batch sizes and check errors after each [OK]

Common Mistakes:

• Sending too large batches causing failures
• Ignoring errors during bulk indexing
• Sending very small batches losing speed benefits