Document versioning in Elasticsearch

Introduction

Document versioning helps keep track of changes to data in Elasticsearch. It prevents conflicts when multiple users update the same document.

When multiple users or systems update the same document at the same time.

To avoid overwriting changes accidentally in a shared database.

When you want to ensure updates happen only if the document is at a specific version.

To keep a simple history of document changes for consistency.

When building applications that require safe concurrent updates.

Syntax

Elasticsearch

PUT /index/_doc/document_id?version=version_number
{
  "field": "value"
}

The version parameter specifies the expected version of the document.

If the version does not match the current document version, Elasticsearch rejects the update to avoid conflicts.

Examples

This updates the document with ID 1 in the products index only if its current version is 3.

Elasticsearch

PUT /products/_doc/1?version=3
{
  "name": "Coffee Mug",
  "price": 12.99
}

You can check the current version of a document before updating it.

Elasticsearch

GET /products/_doc/1

# Response includes "_version" field showing current version

Another way to control updates is using sequence number and primary term for optimistic concurrency control.

Elasticsearch

POST /products/_update/1
{
  "doc": {"price": 14.99},
  "if_seq_no": 5,
  "if_primary_term": 1
}

Sample Program

This example shows creating a document, checking its version, updating it with the correct version, and then trying to update again with an old version which fails to prevent conflicts.

Elasticsearch

PUT /library/_doc/42
{
  "title": "Learn Elasticsearch",
  "author": "Jane Doe"
}

# Get the document to see its version
GET /library/_doc/42

# Update the document only if version is 1
PUT /library/_doc/42?version=1
{
  "title": "Learn Elasticsearch - Updated",
  "author": "Jane Doe"
}

# Try to update again with old version (1) - this will fail
PUT /library/_doc/42?version=1
{
  "title": "Another Update",
  "author": "Jane Doe"
}

Important Notes

Always check the current document version before updating to avoid conflicts.

Versioning is useful for optimistic concurrency control in distributed systems.

Using if_seq_no and if_primary_term is a more advanced and recommended way for concurrency control in Elasticsearch.

Summary

Document versioning helps avoid update conflicts in Elasticsearch.

Use the version parameter to update only if the document is at a specific version.

Check the document's current version before updating to keep data safe.

Practice

1. What is the main purpose of document versioning in Elasticsearch?

easy

A. To compress documents for storage efficiency

B. To prevent update conflicts by ensuring updates apply only to the expected document version

C. To increase the speed of document retrieval

D. To create backups of documents automatically

Solution

1. Step 1: Understand document versioning concept

   Document versioning is used to avoid conflicts when multiple updates happen simultaneously.

2. Step 2: Identify the main purpose

   It ensures updates only apply if the document is at the expected version, preventing overwriting newer changes.

3. Final Answer:

   To prevent update conflicts by ensuring updates apply only to the expected document version -> Option B

4. Quick Check:

   Versioning prevents conflicts = C [OK]

Hint: Versioning avoids conflicting updates by checking document version [OK]

Common Mistakes:

• Thinking versioning speeds up retrieval
• Confusing versioning with backup creation
• Assuming versioning compresses data

2. Which of the following is the correct way to specify a version when updating a document in Elasticsearch?

easy

A. POST /index/_update/1?version=3 { "doc": {"field": "value"} }

B. POST /index/_update/1 { "doc": {"field": "value"}, "version_number": 3 }

C. POST /index/_update/1 { "doc": {"field": "value"}, "ver": 3 }

D. POST /index/_update/1 { "doc": {"field": "value"}, "version": 3 }

Solution

1. Step 1: Recall Elasticsearch update syntax with version

   The version parameter is passed as a query parameter, not inside the JSON body.

2. Step 2: Identify correct syntax

   POST /index/_update/1?version=3 { "doc": {"field": "value"} } uses ?version=3 in the URL, which is the correct way to specify version for update.

3. Final Answer:

   POST /index/_update/1?version=3 { "doc": {"field": "value"} } -> Option A

4. Quick Check:

   Version is a query parameter, not in body [OK]

Hint: Use ?version=number in URL, not inside JSON body [OK]

Common Mistakes:

• Putting version inside JSON body
• Using wrong parameter names like ver or version_number
• Omitting the version parameter

3. Given the following update request, what will happen if the current document version is 5?

POST /myindex/_update/42?version=4
{
  "doc": {"status": "active"}
}

medium

A. The update will succeed and document version will become 5

B. The update will succeed but version will remain 4

C. The update will fail due to version conflict

D. The update will create a new document with version 4

Solution

1. Step 1: Check the version parameter against current document version

   The update request specifies version=4 but current version is 5.

2. Step 2: Understand version conflict behavior

   Elasticsearch rejects updates if the version does not match the current document version to avoid conflicts.

3. Final Answer:

   The update will fail due to version conflict -> Option C

4. Quick Check:

   Version mismatch causes update failure [OK]

Hint: Update only succeeds if version matches current document version [OK]

Common Mistakes:

• Assuming update succeeds despite version mismatch
• Thinking version resets after update
• Confusing version with document ID

4. You wrote this update request but it always fails with a version conflict error:

POST /products/_update/10?version=2
{
  "doc": {"price": 19.99}
}

What is the most likely cause?

medium

A. The update syntax is incorrect

B. The document with ID 10 does not exist

C. The field name 'price' is invalid

D. The current document version is not 2

Solution

1. Step 1: Understand version conflict error meaning

   Version conflict means the version specified does not match the document's current version.

2. Step 2: Check other options

   Document existence or field name errors cause different errors; syntax is correct here.

3. Final Answer:

   The current document version is not 2 -> Option D

4. Quick Check:

   Version conflict means version mismatch [OK]

Hint: Version conflict means your version number is outdated [OK]

Common Mistakes:

• Assuming document absence causes version conflict
• Blaming field names for version errors
• Ignoring correct syntax

5. You want to update a document only if it has not been changed since you last read it. Which approach correctly uses document versioning to achieve this?

hard

A. Fetch the document, note its version, then update using that version parameter

B. Update the document without specifying any version parameter

C. Use the document ID as the version parameter in the update request

D. Delete the document first, then create a new one with the updated data

Solution

1. Step 1: Understand optimistic concurrency control

   You must check the document's current version before updating to avoid overwriting changes.

2. Step 2: Apply versioning correctly

   Fetch the document, get its version, then update specifying that version to ensure no changes happened in between.

3. Final Answer:

   Fetch the document, note its version, then update using that version parameter -> Option A

4. Quick Check:

   Use version to update only if unchanged [OK]

Hint: Always update with the version you last read to avoid conflicts [OK]

Common Mistakes:

• Updating without version check causes silent overwrites
• Using document ID as version parameter
• Deleting instead of updating