Bulk indexing optimization in Elasticsearch - Mini Project: Build & Apply

Bulk indexing optimization

📖 Scenario: You work with Elasticsearch to store many documents quickly. Instead of adding one document at a time, you want to use bulk indexing to save time and resources.

🎯 Goal: Build a simple bulk indexing process using Elasticsearch's bulk API to add multiple documents efficiently.

📋 What You'll Learn

Create a list of documents with exact fields and values

Set a bulk size limit variable

Write a loop to prepare bulk request body with action and data lines

Print the final bulk request body as a string

💡 Why This Matters

🌍 Real World

Bulk indexing is used in real projects to add many records to Elasticsearch quickly, saving time and reducing server load.

💼 Career

Knowing how to optimize bulk indexing is important for roles like backend developer, data engineer, and search engineer working with Elasticsearch.

1

Create the documents list

Create a list called documents with these exact dictionaries: {"id": 1, "name": "Alice", "age": 30}, {"id": 2, "name": "Bob", "age": 25}, and {"id": 3, "name": "Charlie", "age": 35}.

Elasticsearch

# Create the list of documents
# Your code here

Hint

Use a Python list with dictionaries inside. Each dictionary has keys id, name, and age.

2

Set the bulk size limit

Create a variable called bulk_size and set it to 2 to limit how many documents to send in one bulk request.

Elasticsearch

documents = [
    {"id": 1, "name": "Alice", "age": 30},
    {"id": 2, "name": "Bob", "age": 25},
    {"id": 3, "name": "Charlie", "age": 35}
]
# Set the bulk size limit
# Your code here

Hint

Just create a variable bulk_size and assign the number 2.

3

Prepare the bulk request body

Create a list called bulk_body. Use a for loop with variable doc to go through documents. For each doc, add two dictionaries to bulk_body: one with {"index": {"_id": doc["id"]}} and one with the doc itself.

Elasticsearch

documents = [
    {"id": 1, "name": "Alice", "age": 30},
    {"id": 2, "name": "Bob", "age": 25},
    {"id": 3, "name": "Charlie", "age": 35}
]
bulk_size = 2
# Prepare the bulk request body
# Your code here

Hint

Remember, the bulk API needs an action line and a data line for each document.

4

Print the bulk request body

Print the string version of bulk_body using print(str(bulk_body)) to see the final bulk request content.

Elasticsearch

documents = [
    {"id": 1, "name": "Alice", "age": 30},
    {"id": 2, "name": "Bob", "age": 25},
    {"id": 3, "name": "Charlie", "age": 35}
]
bulk_size = 2
bulk_body = []
for doc in documents:
    bulk_body.append({"index": {"_id": doc["id"]}})
    bulk_body.append(doc)
# Print the bulk request body
# Your code here

Hint

Use print(str(bulk_body)) to show the list as a string.

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