org.apache.cassandra.service
Interface StorageServiceMBean

All Known Implementing Classes:

StorageService

public interface StorageServiceMBean

Method Summary

void	bulkLoad(java.lang.String directory)
void	clearSnapshot(java.lang.String tag, java.lang.String... tableNames) Remove the snapshot with the given name from the given tables.
void	decommission() transfer this node's data to other machines and remove it from service.
void	deliverHints(java.lang.String host) force hint delivery to an endpoint
void	drain() makes node unavailable for writes, flushes memtables and replays commitlog.
void	forceRemoveCompletion() Force a remove operation to finish.
void	forceTableCleanup(java.lang.String tableName, java.lang.String... columnFamilies) Trigger a cleanup of keys on a single keyspace
void	forceTableCompaction(java.lang.String tableName, java.lang.String... columnFamilies) Forces major compaction of a single keyspace
void	forceTableFlush(java.lang.String tableName, java.lang.String... columnFamilies) Flush all memtables for the given column families, or all columnfamilies for the given table if none are explicitly listed.
void	forceTableRepair(java.lang.String tableName, java.lang.String... columnFamilies) Triggers proactive repair for given column families, or all columnfamilies for the given table if none are explicitly listed.
int	getCurrentGenerationNumber() Return the generation value for this node.
java.lang.String	getDrainProgress() get the progress of a drain operation
java.util.List<java.lang.String>	getJoiningNodes() Retrieve the list of nodes currently bootstrapping into the ring.
java.util.List<java.lang.String>	getKeyspaces()
java.util.List<java.lang.String>	getLeavingNodes() Retrieve the list of nodes currently leaving the ring.
java.util.List<java.lang.String>	getLiveNodes() Retrieve the list of live nodes in the cluster, where "liveness" is determined by the failure detector of the node being queried.
double	getLoad() Numeric load value.
java.util.Map<java.lang.String,java.lang.String>	getLoadMap() Human-readable load value.
java.lang.String	getLoadString() Human-readable load value
java.util.List<java.lang.String>	getMovingNodes() Retrieve the list of nodes currently moving in the ring.
java.util.List<java.net.InetAddress>	getNaturalEndpoints(java.lang.String table, byte[] key) This method returns the N endpoints that are responsible for storing the specified key i.e for replication.
java.util.List<java.net.InetAddress>	getNaturalEndpoints(java.lang.String table, java.nio.ByteBuffer key)
java.lang.String	getOperationMode() get the operational mode (leaving, joining, normal, decommissioned, client)
java.util.Map<Token,java.lang.Float>	getOwnership() given a list of tokens (representing the nodes in the cluster), returns a mapping from "token -> %age of cluster owned by that token"
java.util.Map<Range,java.util.List<java.lang.String>>	getPendingRangeToEndpointMap(java.lang.String keyspace) Retrieve a map of pending ranges to endpoints that describe the ring topology
java.util.Map<Range,java.util.List<java.lang.String>>	getRangeToEndpointMap(java.lang.String keyspace) Retrieve a map of range to end points that describe the ring topology of a Cassandra cluster.
java.lang.String	getReleaseVersion() Fetch a string representation of the Cassandra version.
java.lang.String	getRemovalStatus() Get the status of a token removal.
java.lang.String	getToken() Fetch a string representation of the token.
java.util.Map<Token,java.lang.String>	getTokenToEndpointMap() Retrieve a map of tokens to endpoints, including the bootstrapping ones.
java.util.List<java.lang.String>	getUnreachableNodes() Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.
void	invalidateKeyCaches(java.lang.String ks, java.lang.String... cfs)
void	invalidateRowCaches(java.lang.String ks, java.lang.String... cfs)
boolean	isInitialized()
boolean	isJoined()
boolean	isRPCServerRunning()
void	joinRing()
void	move(java.lang.String newToken)
void	removeToken(java.lang.String token) removeToken removes token (and all data associated with enpoint that had it) from the ring
void	saveCaches() save row and key caches
void	scrub(java.lang.String tableName, java.lang.String... columnFamilies) Scrub (deserialize + reserialize at the latest version, skipping bad rows if any) the given keyspace.
void	setCompactionThroughputMbPerSec(int value)
void	setLog4jLevel(java.lang.String classQualifier, java.lang.String level) set the logging level at runtime
void	startGossiping()
void	startRPCServer()
void	stopGossiping()
void	stopRPCServer()
void	takeSnapshot(java.lang.String tag, java.lang.String... tableNames) Takes the snapshot for the given tables.
void	truncate(java.lang.String keyspace, java.lang.String columnFamily) Truncates (deletes) the given columnFamily from the provided keyspace.
void	updateSnitch(java.lang.String epSnitchClassName, java.lang.Boolean dynamic, java.lang.Integer dynamicUpdateInterval, java.lang.Integer dynamicResetInterval, java.lang.Double dynamicBadnessThreshold) Change endpointsnitch class and dynamic-ness (and dynamic attributes) at runtime

Method Detail

getLiveNodes

java.util.List<java.lang.String> getLiveNodes()

Retrieve the list of live nodes in the cluster, where "liveness" is determined by the failure detector of the node being queried.

Returns:

set of IP addresses, as Strings

getUnreachableNodes

java.util.List<java.lang.String> getUnreachableNodes()

Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.

Returns:

set of IP addresses, as Strings

getJoiningNodes

java.util.List<java.lang.String> getJoiningNodes()

Retrieve the list of nodes currently bootstrapping into the ring.

Returns:

set of IP addresses, as Strings

getLeavingNodes

java.util.List<java.lang.String> getLeavingNodes()

Retrieve the list of nodes currently leaving the ring.

Returns:

set of IP addresses, as Strings

getMovingNodes

java.util.List<java.lang.String> getMovingNodes()

Retrieve the list of nodes currently moving in the ring.

Returns:

set of IP addresses, as Strings

getToken

java.lang.String getToken()

Fetch a string representation of the token.

Returns:

a string token

getReleaseVersion

java.lang.String getReleaseVersion()

Fetch a string representation of the Cassandra version.

Returns:

A string representation of the Cassandra version.

getRangeToEndpointMap

java.util.Map<Range,java.util.List<java.lang.String>> getRangeToEndpointMap(java.lang.String keyspace)

Retrieve a map of range to end points that describe the ring topology of a Cassandra cluster.

Returns:

mapping of ranges to end points

getPendingRangeToEndpointMap

java.util.Map<Range,java.util.List<java.lang.String>> getPendingRangeToEndpointMap(java.lang.String keyspace)

Retrieve a map of pending ranges to endpoints that describe the ring topology

Parameters:

keyspace - the keyspace to get the pending range map for.

Returns:

a map of pending ranges to endpoints

getTokenToEndpointMap

java.util.Map<Token,java.lang.String> getTokenToEndpointMap()

Retrieve a map of tokens to endpoints, including the bootstrapping ones.

Returns:

a map of tokens to endpoints

getLoad

double getLoad()

Numeric load value.

getLoadString

java.lang.String getLoadString()

Human-readable load value

getLoadMap

java.util.Map<java.lang.String,java.lang.String> getLoadMap()

Human-readable load value. Keys are IP addresses.

getCurrentGenerationNumber

int getCurrentGenerationNumber()

Return the generation value for this node.

Returns:

generation number

getNaturalEndpoints

java.util.List<java.net.InetAddress> getNaturalEndpoints(java.lang.String table,
                                                         byte[] key)

This method returns the N endpoints that are responsible for storing the specified key i.e for replication.

Parameters:

key - - key for which we need to find the endpoint return value - the endpoint responsible for this key

getNaturalEndpoints

java.util.List<java.net.InetAddress> getNaturalEndpoints(java.lang.String table,
                                                         java.nio.ByteBuffer key)

takeSnapshot

void takeSnapshot(java.lang.String tag,
                  java.lang.String... tableNames)
                  throws java.io.IOException

Takes the snapshot for the given tables. A snapshot name must be specified.

Parameters:

tag - the tag given to the snapshot; may not be null or empty

tableNames - the name of the tables to snapshot; empty means "all."

Throws:

java.io.IOException

clearSnapshot

void clearSnapshot(java.lang.String tag,
                   java.lang.String... tableNames)
                   throws java.io.IOException

Remove the snapshot with the given name from the given tables. If no tag is specified we will remove all snapshots.

Throws:

java.io.IOException

forceTableCompaction

void forceTableCompaction(java.lang.String tableName,
                          java.lang.String... columnFamilies)
                          throws java.io.IOException,
                                 java.util.concurrent.ExecutionException,
                                 java.lang.InterruptedException

Forces major compaction of a single keyspace

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceTableCleanup

void forceTableCleanup(java.lang.String tableName,
                       java.lang.String... columnFamilies)
                       throws java.io.IOException,
                              java.util.concurrent.ExecutionException,
                              java.lang.InterruptedException

Trigger a cleanup of keys on a single keyspace

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

scrub

void scrub(java.lang.String tableName,
           java.lang.String... columnFamilies)
           throws java.io.IOException,
                  java.util.concurrent.ExecutionException,
                  java.lang.InterruptedException

Scrub (deserialize + reserialize at the latest version, skipping bad rows if any) the given keyspace. If columnFamilies array is empty, all CFs are scrubbed. Scrubbed CFs will be snapshotted first.

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceTableFlush

void forceTableFlush(java.lang.String tableName,
                     java.lang.String... columnFamilies)
                     throws java.io.IOException,
                            java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Flush all memtables for the given column families, or all columnfamilies for the given table if none are explicitly listed.

Parameters:

tableName -

columnFamilies -

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceTableRepair

void forceTableRepair(java.lang.String tableName,
                      java.lang.String... columnFamilies)
                      throws java.io.IOException

Triggers proactive repair for given column families, or all columnfamilies for the given table if none are explicitly listed.

Parameters:

tableName -

columnFamilies -

Throws:

java.io.IOException

decommission

void decommission()
                  throws java.lang.InterruptedException

transfer this node's data to other machines and remove it from service.

Throws:

java.lang.InterruptedException

move

void move(java.lang.String newToken)
          throws java.io.IOException,
                 java.lang.InterruptedException

Parameters:

newToken - token to move this node to. This node will unload its data onto its neighbors, and bootstrap to the new token.

Throws:

java.io.IOException

java.lang.InterruptedException

removeToken

void removeToken(java.lang.String token)

removeToken removes token (and all data associated with enpoint that had it) from the ring

getRemovalStatus

java.lang.String getRemovalStatus()

Get the status of a token removal.

forceRemoveCompletion

void forceRemoveCompletion()

Force a remove operation to finish.

setLog4jLevel

void setLog4jLevel(java.lang.String classQualifier,
                   java.lang.String level)

set the logging level at runtime

getOperationMode

java.lang.String getOperationMode()

get the operational mode (leaving, joining, normal, decommissioned, client)

getDrainProgress

java.lang.String getDrainProgress()

get the progress of a drain operation

drain

void drain()
           throws java.io.IOException,
                  java.lang.InterruptedException,
                  java.util.concurrent.ExecutionException

makes node unavailable for writes, flushes memtables and replays commitlog.

Throws:

java.io.IOException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

truncate

void truncate(java.lang.String keyspace,
              java.lang.String columnFamily)
              throws org.apache.cassandra.thrift.UnavailableException,
                     java.util.concurrent.TimeoutException,
                     java.io.IOException

Truncates (deletes) the given columnFamily from the provided keyspace. Calling truncate results in actual deletion of all data in the cluster under the given columnFamily and it will fail unless all hosts are up. All data in the given column family will be deleted, but its definition will not be affected.

Parameters:

keyspace - The keyspace to delete from

columnFamily - The column family to delete data from.

Throws:

org.apache.cassandra.thrift.UnavailableException - if some of the hosts in the ring are down.

java.util.concurrent.TimeoutException

java.io.IOException

deliverHints

void deliverHints(java.lang.String host)
                  throws java.net.UnknownHostException

force hint delivery to an endpoint

Throws:

java.net.UnknownHostException

saveCaches

void saveCaches()
                throws java.util.concurrent.ExecutionException,
                       java.lang.InterruptedException

save row and key caches

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

getOwnership

java.util.Map<Token,java.lang.Float> getOwnership()

given a list of tokens (representing the nodes in the cluster), returns a mapping from "token -> %age of cluster owned by that token"

getKeyspaces

java.util.List<java.lang.String> getKeyspaces()

updateSnitch

void updateSnitch(java.lang.String epSnitchClassName,
                  java.lang.Boolean dynamic,
                  java.lang.Integer dynamicUpdateInterval,
                  java.lang.Integer dynamicResetInterval,
                  java.lang.Double dynamicBadnessThreshold)
                  throws ConfigurationException

Change endpointsnitch class and dynamic-ness (and dynamic attributes) at runtime

Parameters:

epSnitchClassName - the canonical path name for a class implementing IEndpointSnitch

dynamic - boolean that decides whether dynamicsnitch is used or not

dynamicUpdateInterval - integer, in ms (default 100)

dynamicResetInterval - integer, in ms (default 600,000)

dynamicBadnessThreshold - double, (default 0.0)

Throws:

ConfigurationException - classname not found on classpath

stopGossiping

void stopGossiping()

startGossiping

void startGossiping()

isInitialized

boolean isInitialized()

stopRPCServer

void stopRPCServer()

startRPCServer

void startRPCServer()

isRPCServerRunning

boolean isRPCServerRunning()

invalidateKeyCaches

void invalidateKeyCaches(java.lang.String ks,
                         java.lang.String... cfs)
                         throws java.io.IOException

Throws:

java.io.IOException

invalidateRowCaches

void invalidateRowCaches(java.lang.String ks,
                         java.lang.String... cfs)
                         throws java.io.IOException

Throws:

java.io.IOException

joinRing

void joinRing()
              throws java.io.IOException,
                     ConfigurationException

Throws:

java.io.IOException

ConfigurationException

isJoined

boolean isJoined()

setCompactionThroughputMbPerSec

void setCompactionThroughputMbPerSec(int value)

bulkLoad

void bulkLoad(java.lang.String directory)