Indexing a document (POST/PUT) in Elasticsearch - Step-by-Step Execution

Concept Flow - Indexing a document (POST/PUT)

Prepare JSON document

↓

Send POST or PUT request

↓

Elasticsearch receives request

↓

Store document in index

↓

Return response with status

↓

Client receives confirmation

This flow shows how a JSON document is sent to Elasticsearch using POST or PUT to store it in an index and get a confirmation response.

Execution Sample

Elasticsearch

PUT /my_index/_doc/1
{
  "name": "Alice",
  "age": 30
}

This code sends a PUT request to add or replace a document with id 1 in the 'my_index' index.

Execution Table

Step	Action	Request Content	Elasticsearch Action	Response
1	Client prepares JSON document	{"name": "Alice", "age": 30}	Waiting for request	No response yet
2	Client sends PUT request to /my_index/_doc/1	{"name": "Alice", "age": 30}	Receives request, parses JSON	Processing
3	Elasticsearch stores document in 'my_index' with id '1'	{"name": "Alice", "age": 30}	Document saved in index	Acknowledgement ready
4	Elasticsearch sends response	N/A	N/A	{"_index":"my_index","_id":"1","result":"created"}
5	Client receives response	N/A	N/A	Document indexed successfully

💡 Document is stored and response confirms success

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
document	empty	{"name": "Alice", "age": 30}	{"name": "Alice", "age": 30}	stored in index	stored in index
request_status	none	prepared	sent	received	response sent
response	none	none	none	ready	{"_index":"my_index","_id":"1","result":"created"}

Key Moments - 3 Insights

Why do we use POST or PUT to index a document?

POST adds a new document with an auto-generated or specified ID, while PUT creates or replaces a document at a specific ID. See execution_table steps 2 and 3.

What happens if the document ID already exists when using POST?

POST without specifying an ID creates a new document with a unique ID. If you specify an ID with POST, it will update the document. PUT always replaces or creates at the ID. This is shown in the request URL in step 2.

What does the response tell us?

The response confirms if the document was created or updated successfully. In step 4, the response shows 'result':'created' meaning the document was added.

Visual Quiz - 3 Questions

Look at the execution_table, what is the response content at step 4?

A {"_index":"my_index","_id":"1","result":"created"}

B Document saved in index

C Processing

D No response yet

💡 Hint

Check the 'Response' column in execution_table row for step 4

At which step does Elasticsearch store the document in the index?

A Step 1

B Step 2

C Step 3

D Step 5

💡 Hint

Look at the 'Elasticsearch Action' column to find when the document is saved

If the document JSON changes before sending, which variable in variable_tracker changes?

A request_status

B document

C response

D none

💡 Hint

Check the 'document' variable values across steps in variable_tracker

Concept Snapshot

Indexing a document in Elasticsearch:
- Use POST to add a new document (auto or specified ID)
- Use PUT to create or replace a document at a specific ID
- Send JSON body with document fields
- Elasticsearch stores document in the index
- Response confirms success or failure

Full Transcript

Indexing a document in Elasticsearch involves sending a JSON document using POST or PUT requests to a specific index and document ID. The client prepares the JSON data, sends it to Elasticsearch, which then stores the document in the index. Elasticsearch responds with a confirmation message indicating if the document was created or updated. POST can add new documents or update existing ones if an ID is specified, while PUT replaces or creates a document at the given ID. The response includes details like the index name, document ID, and result status. This process ensures data is stored and searchable in Elasticsearch.