Partial updates in Elasticsearch - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a partial update in Elasticsearch?

A partial update changes only specific fields of a document without replacing the entire document. It saves time and resources by updating just what is needed.

beginner

How do you perform a partial update using the Elasticsearch API?

You use the _update endpoint with a doc field containing only the fields you want to change.

intermediate

What happens if the field you want to update does not exist in the document?

Elasticsearch adds the new field to the document during the partial update.

intermediate

Can you use scripts in partial updates? Why would you use them?

Yes, scripts let you modify fields dynamically, like incrementing a number or appending to a list, during a partial update.

beginner

What is the difference between a full document update and a partial update in Elasticsearch?

A full update replaces the entire document, while a partial update changes only specified fields, keeping the rest unchanged.

Which Elasticsearch endpoint is used for partial updates?

A /_search

B /_delete

C /_update

D /_index

The /_update endpoint is specifically designed for partial updates.

What must you include in the request body to update only specific fields?

A The full document

B A <code>doc</code> object with fields to update

C Only the document ID

D A <code>query</code> object

The doc object holds the fields you want to change in a partial update.

If a field does not exist in the document, what does a partial update do?

A Throws an error

B Deletes the document

C Ignores the field

D Adds the new field to the document

Elasticsearch adds new fields during partial updates if they don't exist.

Why might you use a script in a partial update?

A To dynamically modify field values

B To delete the document

C To replace the whole document

D To search documents

Scripts allow dynamic changes like incrementing or appending during updates.

What is a benefit of partial updates over full document updates?

A They reduce network and processing load

B They require sending the entire document

C They are slower

D They delete old fields automatically

Partial updates send only changed fields, saving bandwidth and processing.

Explain how to perform a partial update in Elasticsearch and why it is useful.

Think about updating only what you need.

Describe the role of scripts in partial updates and give an example use case.

Scripts help when simple field replacement is not enough.

Practice

1. What is the main purpose of using partial updates in Elasticsearch?

easy

A. To delete a document completely from the index

B. To create a new document with all fields specified

C. To update only specific fields of a document without replacing the whole document

D. To retrieve documents matching a query

Solution

1. Step 1: Understand partial update concept

   Partial updates allow changing only some fields of a document instead of replacing the entire document.

2. Step 2: Identify the main purpose

   This saves bandwidth and time by sending only the changed fields, not the whole document.

3. Final Answer:

   To update only specific fields of a document without replacing the whole document -> Option C

4. Quick Check:

   Partial update = update some fields only [OK]

Hint: Partial updates change only some fields, not whole document [OK]

Common Mistakes:

• Confusing partial update with document deletion
• Thinking partial update creates new documents
• Believing partial update retrieves documents

2. Which of the following is the correct syntax to perform a partial update on a document with ID '1' in index 'products'?

easy

A. POST /products/_doc/1 { "price": 20 }

B. POST /products/_update/1 { "doc": { "price": 20 } }

C. PUT /products/_update/1 { "price": 20 }

D. GET /products/_update/1 { "doc": { "price": 20 } }

Solution

1. Step 1: Identify correct HTTP method and endpoint

   Partial updates use POST method on the _update API with the document ID.

2. Step 2: Check request body format

   The update body must include a "doc" key with the fields to update.

3. Final Answer:

   POST /products/_update/1 { "doc": { "price": 20 } } -> Option B

4. Quick Check:

   Use POST + _update + doc key [OK]

Hint: Use POST with _update and doc key for partial updates [OK]

Common Mistakes:

• Using GET instead of POST for update
• Omitting the 'doc' key in request body
• Using PUT on _update endpoint incorrectly
• Updating with _doc endpoint instead of _update

3. Given this partial update request on document ID '2' in index 'users':

POST /users/_update/2
{
  "doc": {
    "age": 30
  }
}

If the original document was {"name": "Alice", "age": 25}, what will be the document after the update?

medium

A. {"name": "Alice", "age": 30}

B. {"age": 30}

C. {"name": "Alice"}

D. {"name": "Alice", "age": 25, "updated": true}

Solution

1. Step 1: Understand partial update effect

   The partial update changes only the "age" field to 30, keeping other fields unchanged.

2. Step 2: Apply update to original document

   Original document {"name": "Alice", "age": 25} becomes {"name": "Alice", "age": 30} after update.

3. Final Answer:

   {"name": "Alice", "age": 30} -> Option A

4. Quick Check:

   Partial update changes only specified fields [OK]

Hint: Partial update changes only given fields, others stay same [OK]

Common Mistakes:

• Thinking update replaces whole document
• Assuming fields not in doc are removed
• Adding extra fields not in update request

4. You try this partial update:

POST /orders/_update/5
{
  "doc": {
    "status": "shipped"
  }
}

But you get an error. Which is the most likely cause?

medium

A. The document with ID '5' does not exist in 'orders' index

B. You used GET instead of POST

C. You forgot to include the 'doc' key in the body

D. The 'status' field cannot be updated

Solution

1. Step 1: Check common update errors

   Partial update errors often happen if the document ID does not exist.

2. Step 2: Analyze given request and error cause

   The syntax is correct, so the likely cause is missing document with ID '5'.

3. Final Answer:

   The document with ID '5' does not exist in 'orders' index -> Option A

4. Quick Check:

   Missing document ID causes update error [OK]

Hint: Check if document ID exists before updating [OK]

Common Mistakes:

• Confusing HTTP method errors with missing document
• Assuming all fields are immutable
• Omitting 'doc' key causing syntax errors

5. You want to increase the 'stock' field by 10 in a product document with ID '10' using a partial update. Which request body correctly achieves this?

hard

A. { "update": { "stock": 10 } }

B. { "doc": { "stock": 10 } }

C. { "doc": { "stock": "stock + 10" } }

D. { "script": { "source": "ctx._source.stock += params.count", "params": { "count": 10 } } }

Solution

1. Step 1: Understand increment operation in partial update

   To increase a numeric field, use a script that adds the value to the existing field.

2. Step 2: Identify correct syntax for scripted update

   { "script": { "source": "ctx._source.stock += params.count", "params": { "count": 10 } } } uses the 'script' key with source code to add 10 to 'stock'.

3. Final Answer:

   { "script": { "source": "ctx._source.stock += params.count", "params": { "count": 10 } } } -> Option D

4. Quick Check:

   Use script to increment numeric fields [OK]

Hint: Use script with ctx._source to increment fields [OK]

Common Mistakes:

• Trying to update with doc key using expression string
• Using 'update' key instead of 'doc' or 'script'
• Assigning value directly instead of incrementing