org.elasticsearch.cluster.routing

Class RoutingTable

java.lang.Object

org.elasticsearch.cluster.routing.RoutingTable

All Implemented Interfaces:

Iterable<IndexRoutingTable>, Diffable<RoutingTable>, StreamableReader<RoutingTable>, Writeable<RoutingTable>

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 and Description
static class	RoutingTable.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static RoutingTable	EMPTY_ROUTING_TABLE
static RoutingTable	PROTO

Method Summary

Modifier and Type	Method and Description
GroupShardsIterator	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).
GroupShardsIterator	allActiveShardsGrouped(String[] indices, boolean includeEmpty)
GroupShardsIterator	allActiveShardsGrouped(String[] indices, boolean includeEmpty, boolean includeRelocationTargets) Return GroupShardsIterator where each active shard routing has it's own shard iterator.
GroupShardsIterator	allAssignedShardsGrouped(String[] indices, boolean includeEmpty)
GroupShardsIterator	allAssignedShardsGrouped(String[] indices, boolean includeEmpty, boolean includeRelocationTargets) 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)
Diff<RoutingTable>	diff(RoutingTable previousState) Returns serializable object representing differences between this and previousState
Map<String,IndexRoutingTable>	getIndicesRouting()
boolean	hasIndex(String index)
IndexRoutingTable	index(String index)
Map<String,IndexRoutingTable>	indicesRouting()
com.google.common.collect.UnmodifiableIterator<IndexRoutingTable>	iterator()
String	prettyPrint()
Diff<RoutingTable>	readDiffFrom(StreamInput in) Reads the Diff from StreamInput
RoutingTable	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
IndexShardRoutingTable	shardRoutingTable(String index, int shardId) All shards for the provided index and shard id
List<ShardRouting>	shardsWithState(ShardRoutingState state)
RoutingTableValidation	validate(MetaData metaData)
RoutingTable	validateRaiseException(MetaData metaData)
long	version() Returns the version of the RoutingTable.
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

PROTO

public static RoutingTable PROTO

EMPTY_ROUTING_TABLE

public static final RoutingTable EMPTY_ROUTING_TABLE

Method Detail

version

public long version()

Returns the version of the RoutingTable.

Returns:

version of the RoutingTable

iterator

public com.google.common.collect.UnmodifiableIterator<IndexRoutingTable> iterator()

Specified by:

iterator in interface Iterable<IndexRoutingTable>

hasIndex

public boolean hasIndex(String index)

index

public IndexRoutingTable index(String 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

validateRaiseException

public RoutingTable validateRaiseException(MetaData metaData)
                                    throws RoutingValidationException

Throws:

RoutingValidationException

validate

public RoutingTableValidation validate(MetaData metaData)

shardsWithState

public List<ShardRouting> shardsWithState(ShardRoutingState state)

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 allActiveShardsGrouped(String[] indices,
                                                  boolean includeEmpty)

allActiveShardsGrouped

public GroupShardsIterator allActiveShardsGrouped(String[] indices,
                                                  boolean includeEmpty,
                                                  boolean includeRelocationTargets)

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

includeRelocationTargets - if true, an extra shard iterator will be added for relocating shards. The extra iterator contains a single ShardRouting pointing at the relocating target

allAssignedShardsGrouped

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

allAssignedShardsGrouped

public GroupShardsIterator allAssignedShardsGrouped(String[] indices,
                                                    boolean includeEmpty,
                                                    boolean includeRelocationTargets)

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

includeRelocationTargets - if true, an extra shard iterator will be added for relocating shards. The extra iterator contains a single ShardRouting pointing at the relocating target

allShards

public ShardsIterator allShards(String[] indices)

allShardsIncludingRelocationTargets

public ShardsIterator allShardsIncludingRelocationTargets(String[] indices)

activePrimaryShardsGrouped

public GroupShardsIterator 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

See Also:

IndexRoutingTable.groupByAllIt()

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 Diff<RoutingTable> readDiffFrom(StreamInput in)
                                throws IOException

Description copied from interface: Diffable

Reads the Diff from StreamInput

Specified by:

readDiffFrom in interface Diffable<RoutingTable>

Throws:

IOException

readFrom

public RoutingTable readFrom(StreamInput in)
                      throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader<RoutingTable>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable<RoutingTable>

Throws:

IOException

builder

public static RoutingTable.Builder builder()

builder

public static RoutingTable.Builder builder(RoutingTable routingTable)

prettyPrint

public String prettyPrint()