com.datastax.oss.driver.api.core.metadata

Interface TokenMap

public interface TokenMap

Utility component to work with the tokens of a given driver instance.

Note that the methods that take a keyspace argument are based on schema metadata, which can be disabled or restricted to a subset of keyspaces; therefore these methods might return empty results for some or all of the keyspaces.

See Also:

DefaultDriverOption.METADATA_SCHEMA_ENABLED, Session.setSchemaMetadataEnabled(Boolean), DefaultDriverOption.METADATA_SCHEMA_REFRESHED_KEYSPACES

Method Summary

Modifier and Type	Method and Description
String	format(Token token) Formats a token into a string representation appropriate for concatenation in a CQL query.
String	getPartitionerName() The name of the partitioner class in use, as reported by the Cassandra nodes.
default Set<Node>	getReplicas(CqlIdentifier keyspace, ByteBuffer partitionKey) Shortcut for getReplicas(keyspace, null, partitionKey).
Set<Node>	getReplicas(CqlIdentifier keyspace, Partitioner partitioner, ByteBuffer partitionKey) The replicas for a given partition key in the given keyspace.
Set<Node>	getReplicas(CqlIdentifier keyspace, Token token) The replicas for a given token in the given keyspace.
default Set<Node>	getReplicas(CqlIdentifier keyspace, TokenRange range) The replicas for a given range in the given keyspace.
default Set<Node>	getReplicas(String keyspaceName, ByteBuffer partitionKey) Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), null, partitionKey).
default Set<Node>	getReplicas(String keyspaceName, Partitioner partitioner, ByteBuffer partitionKey) Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), partitioner, partitionKey).
default Set<Node>	getReplicas(String keyspaceName, Token token) Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), token).
default Set<Node>	getReplicas(String keyspaceName, TokenRange range) Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), range).
Set<TokenRange>	getTokenRanges() The token ranges that define data distribution on the ring.
Set<TokenRange>	getTokenRanges(CqlIdentifier keyspace, Node replica) The token ranges that are replicated on the given node, for the given keyspace.
Set<TokenRange>	getTokenRanges(Node node) The token ranges for which a given node is the primary replica.
default Set<TokenRange>	getTokenRanges(String keyspaceName, Node replica) Shortcut for getTokenRanges(CqlIdentifier.fromCql(keyspaceName), replica).
default Set<Token>	getTokens(Node node) The tokens owned by the given node.
default Token	newToken(ByteBuffer... partitionKey) Shortcut for newToken(null, partitionKey).
Token	newToken(Partitioner partitioner, ByteBuffer... partitionKey) Builds a token from a partition key.
TokenRange	newTokenRange(Token start, Token end)
Token	parse(String tokenString) Builds a token from its string representation.

Method Detail

parse

@NonNull
Token parse(@NonNull
                     String tokenString)

Builds a token from its string representation.

format

@NonNull
String format(@NonNull
                       Token token)

Formats a token into a string representation appropriate for concatenation in a CQL query.

newToken

@NonNull
Token newToken(@Nullable
                        Partitioner partitioner,
                        @NonNull
                        ByteBuffer... partitionKey)

Builds a token from a partition key.

Parameters:

partitioner - the partitioner to use or null for this TokenMap's partitioner.

partitionKey - the partition key components, in their serialized form (which can be obtained with TypeCodec.encode(Object, ProtocolVersion). Neither the individual components, nor the vararg array itself, can be null.

newToken

@NonNull
default Token newToken(@NonNull
                                ByteBuffer... partitionKey)

Shortcut for newToken(null, partitionKey).

newTokenRange

@NonNull
TokenRange newTokenRange(@NonNull
                                  Token start,
                                  @NonNull
                                  Token end)

getTokenRanges

@NonNull
Set<TokenRange> getTokenRanges()

The token ranges that define data distribution on the ring.

getTokenRanges

@NonNull
Set<TokenRange> getTokenRanges(Node node)

The token ranges for which a given node is the primary replica.

getTokens

@NonNull
default Set<Token> getTokens(@NonNull
                                      Node node)

The tokens owned by the given node.

This is functionally equivalent to getTokenRanges(node).map(r -> r.getEnd()). Note that the set is rebuilt every time you call this method.

getTokenRanges

@NonNull
Set<TokenRange> getTokenRanges(@NonNull
                                        CqlIdentifier keyspace,
                                        @NonNull
                                        Node replica)

The token ranges that are replicated on the given node, for the given keyspace.

getTokenRanges

@NonNull
default Set<TokenRange> getTokenRanges(@NonNull
                                                String keyspaceName,
                                                @NonNull
                                                Node replica)

Shortcut for getTokenRanges(CqlIdentifier.fromCql(keyspaceName), replica).

getReplicas

@NonNull
Set<Node> getReplicas(@NonNull
                               CqlIdentifier keyspace,
                               @Nullable
                               Partitioner partitioner,
                               @NonNull
                               ByteBuffer partitionKey)

The replicas for a given partition key in the given keyspace.

getReplicas

@NonNull
default Set<Node> getReplicas(@NonNull
                                       CqlIdentifier keyspace,
                                       @NonNull
                                       ByteBuffer partitionKey)

Shortcut for getReplicas(keyspace, null, partitionKey).

getReplicas

@NonNull
default Set<Node> getReplicas(@NonNull
                                       String keyspaceName,
                                       @Nullable
                                       Partitioner partitioner,
                                       @NonNull
                                       ByteBuffer partitionKey)

Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), partitioner, partitionKey).

getReplicas

@NonNull
default Set<Node> getReplicas(@NonNull
                                       String keyspaceName,
                                       @NonNull
                                       ByteBuffer partitionKey)

Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), null, partitionKey).

getReplicas

@NonNull
Set<Node> getReplicas(@NonNull
                               CqlIdentifier keyspace,
                               @NonNull
                               Token token)

The replicas for a given token in the given keyspace.

getReplicas

@NonNull
default Set<Node> getReplicas(@NonNull
                                       String keyspaceName,
                                       @NonNull
                                       Token token)

Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), token).

getReplicas

@NonNull
default Set<Node> getReplicas(@NonNull
                                       CqlIdentifier keyspace,
                                       @NonNull
                                       TokenRange range)

The replicas for a given range in the given keyspace.

It is assumed that the input range does not overlap across multiple node ranges. If the range extends over multiple nodes, it only returns the nodes that are replicas for the last token of the range. In other words, this method is a shortcut for getReplicas(keyspace, range.getEnd()).

getReplicas

@NonNull
default Set<Node> getReplicas(@NonNull
                                       String keyspaceName,
                                       @NonNull
                                       TokenRange range)

Shortcut for getReplicas(CqlIdentifier.fromCql(keyspaceName), range).

getPartitionerName

@NonNull
String getPartitionerName()

The name of the partitioner class in use, as reported by the Cassandra nodes.