Bulk API for batch operations in Elasticsearch - Mini Project: Build & Apply

Bulk API for batch operations

📋 What You'll Learn

💡 Why This Matters

🌍 Real World

Bulk API is used to efficiently add, update, or delete many documents in a search engine index in one request, saving time and resources.

💼 Career

Knowing how to use the Bulk API is important for backend developers and data engineers working with Elasticsearch or similar search platforms to manage large datasets.

1

Create the bulk request body

Create a variable called bulk_body that contains the bulk request body as a list of dictionaries. Add two documents with IDs 1 and 2 and fields title and content as shown: first document title is "First Doc" and content is "Hello World", second document title is "Second Doc" and content is "Bulk API example". Use the correct bulk action format with index action and _id.

Elasticsearch

# Create the bulk request body with two documents
# Your code here

Hint

The bulk request body is a list where each action line is followed by the document line.

2

Set the target index name

Create a variable called index_name and set it to the string "my_documents".

Elasticsearch

bulk_body = [
    {"index": {"_id": "1"}},
    {"title": "First Doc", "content": "Hello World"},
    {"index": {"_id": "2"}},
    {"title": "Second Doc", "content": "Bulk API example"}
]
# Set the target index name
# Your code here

Hint

Just assign the string "my_documents" to the variable index_name.

3

Send the bulk request

Use the Elasticsearch Python client to send the bulk request. Create a variable called response and assign it the result of calling client.bulk() with index=index_name and body=bulk_body. Assume client is already created and connected.

Elasticsearch

bulk_body = [
    {"index": {"_id": "1"}},
    {"title": "First Doc", "content": "Hello World"},
    {"index": {"_id": "2"}},
    {"title": "Second Doc", "content": "Bulk API example"}
]
index_name = "my_documents"
# Send the bulk request using client.bulk()
# Your code here

Hint

Use client.bulk(index=index_name, body=bulk_body) and assign it to response.

4

Print the bulk response status

Print the value of response["errors"] to check if there were any errors in the bulk operation.

Elasticsearch

bulk_body = [
    {"index": {"_id": "1"}},
    {"title": "First Doc", "content": "Hello World"},
    {"index": {"_id": "2"}},
    {"title": "Second Doc", "content": "Bulk API example"}
]
index_name = "my_documents"
response = client.bulk(index=index_name, body=bulk_body)
# Print the errors status from the response
# Your code here

Hint

If the bulk operation succeeded, response["errors"] will be False.

Practice

1. What is the main purpose of the Elasticsearch Bulk API?

easy

A. To perform multiple document operations in a single request

B. To create a new Elasticsearch index

C. To search documents with complex queries

D. To delete an entire Elasticsearch cluster

Solution

1. Step 1: Understand Bulk API functionality

   The Bulk API is designed to handle many document operations like add, update, or delete in one request to improve efficiency.

2. Step 2: Compare options with Bulk API purpose

   Creating indexes, searching, or deleting clusters are not the Bulk API's main tasks.

3. Final Answer:

   To perform multiple document operations in a single request -> Option A

4. Quick Check:

   Bulk API = batch operations [OK]

Hint: Bulk API batches many actions in one request [OK]

Common Mistakes:

• Confusing Bulk API with search API
• Thinking Bulk API creates indexes
• Assuming Bulk API deletes clusters

2. Which of the following is the correct format for a single action in the Elasticsearch Bulk API?

easy

A. {"index": {"_index": "test", "_id": "1", "field": "value"}}

B. {"index": {"_index": "test", "_id": "1"}}
{"field": "value"}

C. [{"index": {"_index": "test", "_id": "1"}}, {"field": "value"}]

D. {"field": "value"}
{"index": {"_index": "test", "_id": "1"}}

Solution

1. Step 1: Recall Bulk API action format

   Each action in Bulk API consists of two JSON lines: first metadata (like index and id), then the document data.

2. Step 2: Check options for correct order and format

   Combining metadata and data in one JSON object is invalid. The reversed order with data line before metadata line is wrong. Using a JSON array is invalid. {"index": {"_index": "test", "_id": "1"}} {"field": "value"} correctly shows metadata line followed by data line.

3. Final Answer:

   {"index": {"_index": "test", "_id": "1"}} {"field": "value"} -> Option B

4. Quick Check:

   Metadata line then data line = correct Bulk format [OK]

Hint: Metadata line first, then data line in Bulk API [OK]

Common Mistakes:

• Swapping metadata and data lines
• Using JSON arrays instead of lines
• Combining metadata and data in one JSON object

3. Given the following Bulk API request body, what will happen?

{"index": {"_index": "products", "_id": "10"}}
{"name": "Laptop", "price": 1200}
{"delete": {"_index": "products", "_id": "5"}}
{"index": {"_index": "products", "_id": "11"}}
{"name": "Mouse", "price": 25}

medium

A. Adds two documents and deletes one document

B. Adds three documents

C. Deletes two documents

D. Syntax error due to missing data line for delete

Solution

1. Step 1: Analyze each Bulk API action

   First action: index document with id 10 (add Laptop). Second action: delete document with id 5 (no data line needed). Third action: index document with id 11 (add Mouse).

2. Step 2: Confirm correct syntax and operations

   Delete action does not require a data line, so no syntax error. Two documents are added, one deleted.

3. Final Answer:

   Adds two documents and deletes one document -> Option A

4. Quick Check:

   Index + delete + index = add 2, delete 1 [OK]

Hint: Delete action needs no data line in Bulk API [OK]

Common Mistakes:

• Expecting data line after delete action
• Counting delete as add
• Confusing action order

4. Identify the error in this Bulk API request snippet:

{"update": {"_index": "users", "_id": "3"}}
{"name": "Alice"}

medium

A. Update action cannot be used with _id

B. Incorrect index name format

C. Missing "doc" field inside the data line for update

D. Data line should be empty for update

Solution

1. Step 1: Understand update action format

   Update action requires the data line to contain a "doc" field wrapping the fields to update.

2. Step 2: Check the given data line

   The data line only has {"name": "Alice"} without "doc", so it is invalid syntax for update.

3. Final Answer:

   Missing "doc" field inside the data line for update -> Option C

4. Quick Check:

   Update data needs "doc" wrapper [OK]

Hint: Update data must be inside "doc" field [OK]

Common Mistakes:

• Omitting "doc" in update data
• Thinking update needs empty data line
• Confusing update with index action

5. You want to update multiple documents but only if their "status" field is "pending". How can you use the Bulk API to do this efficiently?

hard

A. Use Bulk API with delete actions for all documents and re-index updated ones

B. Use Bulk API with index actions to overwrite all documents regardless of status

C. Use Bulk API with search queries to filter documents before updating

D. Use Bulk API with update actions including a script that checks "status" before updating

Solution

1. Step 1: Understand conditional updates in Bulk API

   Bulk API update actions can include scripts that check document fields before applying changes.

2. Step 2: Evaluate options for conditional update

   Use Bulk API with update actions including a script that checks "status" before updating uses update with scripts to check "status" = "pending" before updating, which is efficient. Use Bulk API with index actions to overwrite all documents regardless of status overwrites all documents ignoring condition. Use Bulk API with delete actions for all documents and re-index updated ones deletes unnecessarily. Use Bulk API with search queries to filter documents before updating is invalid because Bulk API does not support search queries.

3. Final Answer:

   Use Bulk API with update actions including a script that checks "status" before updating -> Option D

4. Quick Check:

   Conditional update = update + script in Bulk API [OK]

Hint: Use update with scripts for conditional Bulk updates [OK]

Common Mistakes:

• Using index to overwrite without condition
• Deleting documents unnecessarily
• Trying to filter with search inside Bulk API