Module org.elasticsearch.server

Package org.elasticsearch.cluster.routing

Class RoutingTable

java.lang.Object

org.elasticsearch.cluster.routing.RoutingTable

All Implemented Interfaces:

Iterable<IndexRoutingTable>, Diffable<RoutingTable>, Writeable

public class RoutingTable
extends Object
implements Iterable<IndexRoutingTable>, Diffable<RoutingTable>

Represents a global cluster-wide routing table for all indices including the version of the current routing state.

See Also:

• IndexRoutingTable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoutingTable.Builder	Builder for the routing table.

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final RoutingTable	EMPTY_ROUTING_TABLE

Method Summary

Modifier and Type	Method	Description
GroupShardsIterator<ShardIterator>	activePrimaryShardsGrouped(String[] indices, boolean includeEmpty)	All the *active* primary shards for the provided indices grouped (each group is a single element, consisting of the primary shard).
ShardsIterator	allActiveShards(String[] indices)
GroupShardsIterator<ShardIterator>	allActiveShardsGrouped(String[] indices, boolean includeEmpty)	Return GroupShardsIterator where each active shard routing has it's own shard iterator.
GroupShardsIterator<ShardIterator>	allAssignedShardsGrouped(String[] indices, boolean includeEmpty)	Return GroupShardsIterator where each assigned shard routing has it's own shard iterator.
List<ShardRouting>	allShards()	All the shards (replicas) for all indices in this routing table.
List<ShardRouting>	allShards(String index)	All the shards (replicas) for the provided index.
ShardsIterator	allShards(String[] indices)
ShardsIterator	allShardsIncludingRelocationTargets(String[] indices)
static RoutingTable.Builder	builder()
static RoutingTable.Builder	builder(RoutingTable routingTable)
static RoutingTable.Builder	builder(ShardRoutingRoleStrategy shardRoutingRoleStrategy)
static RoutingTable.Builder	builder(ShardRoutingRoleStrategy shardRoutingRoleStrategy, RoutingTable routingTable)
ShardRouting	deduplicate(ShardRouting shardRouting)	Try to deduplicate the given shard routing with an equal instance found in this routing table.
Diff<RoutingTable>	diff(RoutingTable previousState)	Returns serializable object representing differences between this and previousState
ShardRouting	getByAllocationId(ShardId shardId, String allocationId)
Map<String,IndexRoutingTable>	getIndicesRouting()
boolean	hasIndex(String index)
boolean	hasIndex(Index index)
IndexRoutingTable	index(String index)
IndexRoutingTable	index(Index index)
Map<String,IndexRoutingTable>	indicesRouting()
Iterator<IndexRoutingTable>	iterator()
static RoutingTable	of(long version, RoutingNodes routingNodes)
static Diff<RoutingTable>	readDiffFrom(StreamInput in)
static RoutingTable	readFrom(StreamInput in)
IndexShardRoutingTable	shardRoutingTable(String index, int shardId)	All shards for the provided index and shard id
static IndexShardRoutingTable	shardRoutingTable(IndexRoutingTable indexRouting, int shardId)	Get's the IndexShardRoutingTable for the given shard id from the given IndexRoutingTable or throws a ShardNotFoundException if no shard by the given id is found in the IndexRoutingTable.
IndexShardRoutingTable	shardRoutingTable(ShardId shardId)	All shards for the provided ShardId
String	toString()
boolean	validate(Metadata metadata)
long	version()	Returns the version of the RoutingTable.
RoutingTable	withIncrementedVersion()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

EMPTY_ROUTING_TABLE

public static final RoutingTable EMPTY_ROUTING_TABLE

Method Details

withIncrementedVersion

public RoutingTable withIncrementedVersion()

shardRoutingTable

public static IndexShardRoutingTable shardRoutingTable(IndexRoutingTable indexRouting,
 int shardId)

Get's the IndexShardRoutingTable for the given shard id from the given IndexRoutingTable or throws a ShardNotFoundException if no shard by the given id is found in the IndexRoutingTable.

Parameters:

indexRouting - IndexRoutingTable

shardId - ShardId

Returns:

IndexShardRoutingTable

version

public long version()

Returns the version of the RoutingTable.

Returns:

version of the RoutingTable

iterator

public Iterator<IndexRoutingTable> iterator()

Specified by:

iterator in interface Iterable<IndexRoutingTable>

hasIndex

public boolean hasIndex(String index)

hasIndex

public boolean hasIndex(Index index)

index

public IndexRoutingTable index(String index)

index

public IndexRoutingTable index(Index index)

indicesRouting

public Map<String,IndexRoutingTable> indicesRouting()

getIndicesRouting

public Map<String,IndexRoutingTable> getIndicesRouting()

shardRoutingTable

public IndexShardRoutingTable shardRoutingTable(String index,
 int shardId)

All shards for the provided index and shard id

Returns:

All the shard routing entries for the given index and shard id

Throws:

IndexNotFoundException - if provided index does not exist

ShardNotFoundException - if provided shard id is unknown

shardRoutingTable

public IndexShardRoutingTable shardRoutingTable(ShardId shardId)

All shards for the provided ShardId

Returns:

All the shard routing entries for the given index and shard id

Throws:

IndexNotFoundException - if provided index does not exist

ShardNotFoundException - if provided shard id is unknown

deduplicate

public ShardRouting deduplicate(ShardRouting shardRouting)

Try to deduplicate the given shard routing with an equal instance found in this routing table. This is used by the logic of the DiskThresholdDecider and InternalClusterInfoService to deduplicate instances created by a master node and those read from the network to speed up the use of ShardRouting as a map key in ClusterInfo.getDataPath(org.elasticsearch.cluster.routing.ShardRouting).

Parameters:

shardRouting - shard routing to deduplicate

Returns:

deduplicated shard routing from this routing table if an equivalent shard routing was found or the given instance otherwise

getByAllocationId

@Nullable
public ShardRouting getByAllocationId(ShardId shardId,
 String allocationId)

validate

public boolean validate(Metadata metadata)

allShards

public List<ShardRouting> allShards()

All the shards (replicas) for all indices in this routing table.

Returns:

All the shards

allShards

public List<ShardRouting> allShards(String index)

All the shards (replicas) for the provided index.

Parameters:

index - The index to return all the shards (replicas).

Returns:

All the shards matching the specific index

Throws:

IndexNotFoundException - If the index passed does not exists

allActiveShardsGrouped

public GroupShardsIterator<ShardIterator> allActiveShardsGrouped(String[] indices,
 boolean includeEmpty)

Return GroupShardsIterator where each active shard routing has it's own shard iterator.

Parameters:

includeEmpty - if true, a shard iterator will be added for non-assigned shards as well

allAssignedShardsGrouped

public GroupShardsIterator<ShardIterator> allAssignedShardsGrouped(String[] indices,
 boolean includeEmpty)

Return GroupShardsIterator where each assigned shard routing has it's own shard iterator.

Parameters:

includeEmpty - if true, a shard iterator will be added for non-assigned shards as well

allShards

public ShardsIterator allShards(String[] indices)

allActiveShards

public ShardsIterator allActiveShards(String[] indices)

allShardsIncludingRelocationTargets

public ShardsIterator allShardsIncludingRelocationTargets(String[] indices)

activePrimaryShardsGrouped

public GroupShardsIterator<ShardIterator> activePrimaryShardsGrouped(String[] indices,
 boolean includeEmpty)

All the *active* primary shards for the provided indices grouped (each group is a single element, consisting of the primary shard). This is handy for components that expect to get group iterators, but still want in some cases to iterate over all primary shards (and not just one shard in replication group).

Parameters:

indices - The indices to return all the shards (replicas)

Returns:

All the primary shards grouped into a single shard element group each

Throws:

IndexNotFoundException - If an index passed does not exists

diff

public Diff<RoutingTable> diff(RoutingTable previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<RoutingTable>

readDiffFrom

public static Diff<RoutingTable> readDiffFrom(StreamInput in)
                                       throws IOException

Throws:

IOException

readFrom

public static RoutingTable readFrom(StreamInput in)
                             throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

of

public static RoutingTable of(long version,
 RoutingNodes routingNodes)

builder

public static RoutingTable.Builder builder()

builder

public static RoutingTable.Builder builder(RoutingTable routingTable)

builder

public static RoutingTable.Builder builder(ShardRoutingRoleStrategy shardRoutingRoleStrategy)

builder

public static RoutingTable.Builder builder(ShardRoutingRoleStrategy shardRoutingRoleStrategy,
 RoutingTable routingTable)

toString

public String toString()

Overrides:

toString in class Object