Elasticsearch Routing

By Opster Team

Updated: Mar 21, 2023

| 1 min read

Overview

In Elasticsearch, routing refers to document routing. When you index a document, Elasticsearch will determine which shard the document should be routed to for indexing

The shard is selected based on the following formula:

shard = hash(_routing) % number_of_primary_shards

Where the default value of _routing is _id.
It is important to know which shard the document is routed to, because Elasticsearch will need to determine where to find that document later on for document retrieval requests. 

Examples

In twitter index with 2 primary shards, the document with _id equal to “440” gets routed to the shard number:   

shard = hash( 440 ) % 2
PUT twitter/_doc/440
{
...
}

Notes and good things to know

  • In order to improve search speed, you can create custom routing. For example, you can enable custom routing that will ensure that only a single shard will be queried (the shard that contains your data).
  • To create custom routing in Elasticsearch, you will need to configure and define that not all routing will be completed by default settings. ( v <= 5.0)
PUT my_index/customer/_mapping
{
   "order":{
      "_routing":{
         "required":true
      }
   }
}
  •  This will ensure that every document in the “customer” type must specify a custom routing. For Elasticsearch version 6 or above you will need to update the same mapping as:
PUT my_index/_mapping
{
   "order":{
      "_routing":{
         "required":true
      }
   }
}

How helpful was this guide?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?


Related log errors to this ES concept


Rerouting shards
Has a wrong value defaulting to indices all active
After allocating node would have less than the required threshold of
After allocating node would have more than the allowed
High disk watermark no longer exceeded on but low disk watermark is still exceeded
Low disk watermark no longer exceeded on
Releasing read-only-allow-delete block on indices
Failing shard with unassigned info
Unexpected failure during %s current state n%s
Failing shard failedShardEntry
Processing new cluster info
Rerouting because disk usage info received from new nodes

< Page: 2 of 7 >