org.apache.cassandra.service

Interface StorageServiceMBean

All Superinterfaces:

javax.management.NotificationBroadcaster, javax.management.NotificationEmitter

All Known Implementing Classes:

StorageService

public interface StorageServiceMBean
extends javax.management.NotificationEmitter

Method Summary

Modifier and Type	Method and Description
void	bulkLoad(java.lang.String directory) Starts a bulk load and blocks until it completes.
java.lang.String	bulkLoadAsync(java.lang.String directory) Starts a bulk load asynchronously and returns the String representation of the planID for the new streaming session.
void	cleanupSizeEstimates() Removes extraneous entries in system.size_estimates.
void	clearSnapshot(java.lang.String tag, java.lang.String... keyspaceNames) Remove the snapshot with the given name from the given keyspaces.
void	decommission() transfer this node's data to other machines and remove it from service.
void	deliverHints(java.lang.String host)
java.util.List<java.lang.String>	describeRingJMX(java.lang.String keyspace) The same as describeRing(String) but converts TokenRange to the String for JMX compatibility
void	disableAutoCompaction(java.lang.String ks, java.lang.String... tables)
void	drain() makes node unavailable for writes, flushes memtables and replays commitlog.
java.util.Map<java.net.InetAddress,java.lang.Float>	effectiveOwnership(java.lang.String keyspace) Effective ownership is % of the data each node owns given the keyspace we calculate the percentage using replication factor.
void	enableAutoCompaction(java.lang.String ks, java.lang.String... tables)
int	forceKeyspaceCleanup(int jobs, java.lang.String keyspaceName, java.lang.String... tables)
int	forceKeyspaceCleanup(java.lang.String keyspaceName, java.lang.String... tables) Deprecated.
void	forceKeyspaceCompaction(boolean splitOutput, java.lang.String keyspaceName, java.lang.String... tableNames) Forces major compaction of a single keyspace
void	forceKeyspaceCompactionForTokenRange(java.lang.String keyspaceName, java.lang.String startToken, java.lang.String endToken, java.lang.String... tableNames) Forces major compaction of specified token range in a single keyspace.
void	forceKeyspaceFlush(java.lang.String keyspaceName, java.lang.String... tableNames) Flush all memtables for the given column families, or all columnfamilies for the given keyspace if none are explicitly listed.
void	forceRemoveCompletion() Force a remove operation to finish.
int	forceRepairAsync(java.lang.String keyspace, boolean isSequential, boolean isLocal, boolean primaryRange, boolean fullRepair, java.lang.String... tableNames) Deprecated. use repairAsync(String keyspace, Map options) instead.
int	forceRepairAsync(java.lang.String keyspace, boolean isSequential, java.util.Collection<java.lang.String> dataCenters, java.util.Collection<java.lang.String> hosts, boolean primaryRange, boolean fullRepair, java.lang.String... tableNames) Deprecated. use repairAsync(String keyspace, Map options) instead.
int	forceRepairAsync(java.lang.String keyspace, int parallelismDegree, java.util.Collection<java.lang.String> dataCenters, java.util.Collection<java.lang.String> hosts, boolean primaryRange, boolean fullRepair, java.lang.String... tableNames) Deprecated. use repairAsync(String keyspace, Map options) instead.
int	forceRepairRangeAsync(java.lang.String beginToken, java.lang.String endToken, java.lang.String keyspaceName, boolean isSequential, boolean isLocal, boolean fullRepair, java.lang.String... tableNames) Deprecated. use repairAsync(String keyspace, Map options) instead.
int	forceRepairRangeAsync(java.lang.String beginToken, java.lang.String endToken, java.lang.String keyspaceName, boolean isSequential, java.util.Collection<java.lang.String> dataCenters, java.util.Collection<java.lang.String> hosts, boolean fullRepair, java.lang.String... tableNames) Deprecated. use repairAsync(String keyspace, Map options) instead.
int	forceRepairRangeAsync(java.lang.String beginToken, java.lang.String endToken, java.lang.String keyspaceName, int parallelismDegree, java.util.Collection<java.lang.String> dataCenters, java.util.Collection<java.lang.String> hosts, boolean fullRepair, java.lang.String... tableNames) Deprecated. use repairAsync(String keyspace, Map options) instead.
void	forceTerminateAllRepairSessions()
int	garbageCollect(java.lang.String tombstoneOption, int jobs, java.lang.String keyspaceName, java.lang.String... tableNames) Rewrites all sstables from the given tables to remove deleted data.
java.lang.String[]	getAllDataFileLocations() Get the list of all data file locations from conf
int	getBatchSizeFailureThreshold() Returns the threshold for rejecting queries due to a large batch size
int	getCachedReplicaRowsFailThreshold() Returns the number of rows cached at the coordinator before filtering/index queries fail outright.
int	getCachedReplicaRowsWarnThreshold() Returns the number of rows cached at the coordinator before filtering/index queries log a warning.
long	getCasContentionTimeout()
java.lang.String	getClusterName() Returns the name of the cluster
java.lang.String	getCommitLogLocation() Get location of the commit log
int	getCompactionThroughputMbPerSec()
int	getConcurrentCompactors()
long	getCounterWriteRpcTimeout()
int	getCurrentGenerationNumber() Return the generation value for this node.
java.lang.String	getDrainProgress() get the progress of a drain operation
int	getDynamicUpdateInterval()
java.util.Map<java.lang.String,java.lang.String>	getEndpointToHostId() Retrieve the mapping of endpoint to host ID
java.util.Map<java.lang.String,java.lang.String>	getHostIdMap() Deprecated.
java.util.Map<java.lang.String,java.lang.String>	getHostIdToEndpoint() Retrieve the mapping of host ID to endpoint
int	getInterDCStreamThroughputMbPerSec()
java.util.List<java.lang.String>	getJoiningNodes() Retrieve the list of nodes currently bootstrapping into the ring.
java.lang.String	getKeyspaceReplicationInfo(java.lang.String keyspaceName) Fetch the replication factor for a given keyspace.
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.
java.util.Map<java.lang.String,java.lang.String>	getLoadMap() Human-readable load value.
java.lang.String	getLoadString() Human-readable load value
java.lang.String	getLocalHostId() Retrieve this hosts unique ID
java.util.Map<java.lang.String,java.lang.String>	getLoggingLevels() get the runtime logging levels
int	getMaxNativeProtocolVersion() Returns the max version that this node will negotiate for native protocol connections
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 keyspaceName, java.nio.ByteBuffer key)
java.util.List<java.net.InetAddress>	getNaturalEndpoints(java.lang.String keyspaceName, java.lang.String cf, java.lang.String key) This method returns the N endpoints that are responsible for storing the specified key i.e for replication.
java.util.List<java.lang.String>	getNonLocalStrategyKeyspaces()
java.util.List<java.lang.String>	getNonSystemKeyspaces()
java.lang.String	getOperationMode() get the operational mode (leaving, joining, normal, decommissioned, client)
java.util.Map<java.lang.String,java.util.Set<java.net.InetAddress>>	getOutstandingSchemaVersions() Returns a map of schema version -> list of endpoints reporting that version that we need schema updates for
java.util.Map<java.net.InetAddress,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.lang.String	getPartitionerName() Returns the cluster partitioner
java.util.Map<java.util.List<java.lang.String>,java.util.List<java.lang.String>>	getPendingRangeToEndpointMap(java.lang.String keyspace) Retrieve a map of pending ranges to endpoints that describe the ring topology
long	getRangeRpcTimeout()
java.util.Map<java.util.List<java.lang.String>,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.util.Map<java.util.List<java.lang.String>,java.util.List<java.lang.String>>	getRangeToRpcaddressMap(java.lang.String keyspace) Retrieve a map of range to rpc addresses that describe the ring topology of a Cassandra cluster.
long	getReadRpcTimeout()
java.lang.String	getReleaseVersion() Fetch a string representation of the Cassandra version.
java.lang.String	getRemovalStatus() Get the status of a token removal.
int	getRepairSessionMaxTreeDepth()
long	getRpcTimeout()
java.lang.String	getSavedCachesLocation() Get location of the saved caches dir
java.lang.String	getSchemaVersion() Fetch a string representation of the current Schema version.
java.util.Map<java.lang.String,javax.management.openmbean.TabularData>	getSnapshotDetails() Get the details of all the snapshot
int	getStreamingSocketTimeout()
int	getStreamThroughputMbPerSec()
java.util.List<java.lang.String>	getTokens() Fetch string representations of the tokens for this node.
java.util.List<java.lang.String>	getTokens(java.lang.String endpoint) Fetch string representations of the tokens for a specified node.
java.util.Map<java.lang.String,java.lang.String>	getTokenToEndpointMap() Retrieve a map of tokens to endpoints, including the bootstrapping ones.
int	getTombstoneFailureThreshold() Returns the threshold for abandoning queries with many tombstones
int	getTombstoneWarnThreshold() Returns the threshold for warning of queries with many tombstones
double	getTraceProbability() Returns the configured tracing probability.
long	getTruncateRpcTimeout()
java.util.List<java.lang.String>	getUnreachableNodes() Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.
java.util.Map<java.lang.String,java.lang.String>	getViewBuildStatuses(java.lang.String keyspace, java.lang.String view)
long	getWriteRpcTimeout()
boolean	isBootstrapMode() Check if currently bootstrapping.
boolean	isDrained()
boolean	isDraining()
boolean	isGossipRunning()
boolean	isIncrementalBackupsEnabled()
boolean	isInitialized()
boolean	isJoined()
boolean	isNativeTransportRunning()
boolean	isRPCServerRunning()
boolean	isStarting() Returns whether the storage service is starting or not
void	joinRing()
void	loadNewSSTables(java.lang.String ksName, java.lang.String tableName) Load new SSTables to the given keyspace/table
void	move(java.lang.String newToken)
void	rebuild(java.lang.String sourceDc) Initiate a process of streaming data for which we are responsible from other nodes.
void	rebuild(java.lang.String sourceDc, java.lang.String keyspace, java.lang.String tokens, java.lang.String specificSources) Same as rebuild(String), but only for specified keyspace and ranges.
void	rebuildSecondaryIndex(java.lang.String ksName, java.lang.String cfName, java.lang.String... idxNames) rebuild the specified indexes
void	refreshSizeEstimates() Forces refresh of values stored in system.size_estimates of all column families.
void	reloadLocalSchema()
int	relocateSSTables(int jobs, java.lang.String keyspace, java.lang.String... cfnames)
int	relocateSSTables(java.lang.String keyspace, java.lang.String... cfnames) Deprecated.
void	removeNode(java.lang.String token) removeToken removes token (and all data associated with enpoint that had it) from the ring
int	repairAsync(java.lang.String keyspace, java.util.Map<java.lang.String,java.lang.String> options) Invoke repair asynchronously.
void	rescheduleFailedDeletions()
void	resetLocalSchema()
boolean	resumeBootstrap() Resume bootstrap streaming when there is failed data streaming.
java.util.List<java.lang.String>	sampleKeyRange() Return a List of Tokens representing a sample of keys across all ColumnFamilyStores.
int	scrub(boolean disableSnapshot, boolean skipCorrupted, boolean checkData, boolean reinsertOverflowedTTL, int jobs, java.lang.String keyspaceName, java.lang.String... columnFamilies)
int	scrub(boolean disableSnapshot, boolean skipCorrupted, boolean checkData, int jobs, java.lang.String keyspaceName, java.lang.String... columnFamilies) Deprecated.
int	scrub(boolean disableSnapshot, boolean skipCorrupted, boolean checkData, java.lang.String keyspaceName, java.lang.String... tableNames) Deprecated.
int	scrub(boolean disableSnapshot, boolean skipCorrupted, java.lang.String keyspaceName, java.lang.String... tableNames) Deprecated.
void	setBatchSizeFailureThreshold(int batchSizeDebugThreshold) Sets the threshold for rejecting queries due to a large batch size
void	setCachedReplicaRowsFailThreshold(int threshold) Sets the number of rows cached at the coordinator before filtering/index queries fail outright.
void	setCachedReplicaRowsWarnThreshold(int threshold) Sets the number of rows cached at the coordinator before filtering/index queries log a warning.
void	setCasContentionTimeout(long value)
void	setCompactionThroughputMbPerSec(int value)
void	setConcurrentCompactors(int value)
void	setCounterWriteRpcTimeout(long value)
void	setDynamicUpdateInterval(int dynamicUpdateInterval)
void	setHintedHandoffThrottleInKB(int throttleInKB) Sets the hinted handoff throttle in kb per second, per delivery thread.
void	setIncrementalBackupsEnabled(boolean value)
void	setInterDCStreamThroughputMbPerSec(int value)
void	setLoggingLevel(java.lang.String classQualifier, java.lang.String level) set the logging level at runtime If both classQualifer and level are empty/null, it will reload the configuration to reset. If classQualifer is not empty but level is empty/null, it will set the level to null for the defined classQualifer If level cannot be parsed, then the level will be defaulted to DEBUG The logback configuration should have < jmxConfigurator /> set
void	setRangeRpcTimeout(long value)
void	setReadRpcTimeout(long value)
void	setRepairSessionMaxTreeDepth(int depth)
void	setRpcTimeout(long value)
void	setStreamingSocketTimeout(int value)
void	setStreamThroughputMbPerSec(int value)
void	setTombstoneFailureThreshold(int tombstoneDebugThreshold) Sets the threshold for abandoning queries with many tombstones
void	setTombstoneWarnThreshold(int tombstoneDebugThreshold) Sets the threshold for warning queries with many tombstones
void	setTraceProbability(double probability) Enables/Disables tracing for the whole system.
void	setTruncateRpcTimeout(long value)
void	setWriteRpcTimeout(long value)
void	startGossiping()
void	startNativeTransport()
void	startRPCServer()
void	stopDaemon()
void	stopGossiping()
void	stopNativeTransport()
void	stopRPCServer()
void	takeMultipleTableSnapshot(java.lang.String tag, java.lang.String... tableList) Deprecated. use takeSnapshot(String tag, Map options, String... entities) instead.
void	takeSnapshot(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> options, java.lang.String... entities) Takes the snapshot of a multiple column family from different keyspaces.
void	takeSnapshot(java.lang.String tag, java.lang.String... keyspaceNames) Deprecated. use takeSnapshot(String tag, Map options, String... entities) instead.
void	takeTableSnapshot(java.lang.String keyspaceName, java.lang.String tableName, java.lang.String tag) Deprecated. use takeSnapshot(String tag, Map options, String... entities) instead.
long	trueSnapshotsSize() Get the true size taken by all snapshots across all keyspaces.
void	truncate(java.lang.String keyspace, java.lang.String table) Truncates (deletes) the given table 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.
int	upgradeSSTables(java.lang.String keyspaceName, boolean excludeCurrentVersion, int jobs, java.lang.String... tableNames)
int	upgradeSSTables(java.lang.String keyspaceName, boolean excludeCurrentVersion, java.lang.String... tableNames) Deprecated.
int	verify(boolean extendedVerify, java.lang.String keyspaceName, java.lang.String... tableNames) Verify (checksums of) the given keyspace.

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

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

getTokens

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

Fetch string representations of the tokens for this node.

Returns:

a collection of tokens formatted as strings

getTokens

java.util.List<java.lang.String> getTokens(java.lang.String endpoint)
                                    throws java.net.UnknownHostException

Fetch string representations of the tokens for a specified node.

Parameters:

endpoint - string representation of an node

Returns:

a collection of tokens formatted as strings

Throws:

java.net.UnknownHostException

getReleaseVersion

java.lang.String getReleaseVersion()

Fetch a string representation of the Cassandra version.

Returns:

A string representation of the Cassandra version.

getSchemaVersion

java.lang.String getSchemaVersion()

Fetch a string representation of the current Schema version.

Returns:

A string representation of the Schema version.

getKeyspaceReplicationInfo

java.lang.String getKeyspaceReplicationInfo(java.lang.String keyspaceName)

Fetch the replication factor for a given keyspace.

Returns:

string representation of replication information

getAllDataFileLocations

java.lang.String[] getAllDataFileLocations()

Get the list of all data file locations from conf

Returns:

String array of all locations

getCommitLogLocation

java.lang.String getCommitLogLocation()

Get location of the commit log

Returns:

a string path

getSavedCachesLocation

java.lang.String getSavedCachesLocation()

Get location of the saved caches dir

Returns:

a string path

getRangeToEndpointMap

java.util.Map<java.util.List<java.lang.String>,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

getRangeToRpcaddressMap

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

Retrieve a map of range to rpc addresses that describe the ring topology of a Cassandra cluster.

Returns:

mapping of ranges to rpc addresses

describeRingJMX

java.util.List<java.lang.String> describeRingJMX(java.lang.String keyspace)
                                          throws java.io.IOException

The same as describeRing(String) but converts TokenRange to the String for JMX compatibility

Parameters:

keyspace - The keyspace to fetch information about

Returns:

a List of TokenRange(s) converted to String for the given keyspace

Throws:

java.io.IOException

getPendingRangeToEndpointMap

java.util.Map<java.util.List<java.lang.String>,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<java.lang.String,java.lang.String> getTokenToEndpointMap()

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

Returns:

a map of tokens to endpoints in ascending order

getLocalHostId

java.lang.String getLocalHostId()

Retrieve this hosts unique ID

getHostIdMap

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getHostIdMap()

Deprecated.

getEndpointToHostId()

getEndpointToHostId

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

Retrieve the mapping of endpoint to host ID

getHostIdToEndpoint

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

Retrieve the mapping of host ID to endpoint

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 keyspaceName,
                                                         java.lang.String cf,
                                                         java.lang.String key)

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

Parameters:

keyspaceName - keyspace name

cf - Column family name

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 keyspaceName,
                                                         java.nio.ByteBuffer key)

takeSnapshot

@Deprecated
void takeSnapshot(java.lang.String tag,
                              java.lang.String... keyspaceNames)
                       throws java.io.IOException

Deprecated. use takeSnapshot(String tag, Map options, String... entities) instead.

Throws:

java.io.IOException

takeTableSnapshot

@Deprecated
void takeTableSnapshot(java.lang.String keyspaceName,
                                   java.lang.String tableName,
                                   java.lang.String tag)
                            throws java.io.IOException

Deprecated. use takeSnapshot(String tag, Map options, String... entities) instead.

Throws:

java.io.IOException

takeMultipleTableSnapshot

@Deprecated
void takeMultipleTableSnapshot(java.lang.String tag,
                                           java.lang.String... tableList)
                                    throws java.io.IOException

Deprecated. use takeSnapshot(String tag, Map options, String... entities) instead.

Throws:

java.io.IOException

takeSnapshot

void takeSnapshot(java.lang.String tag,
                  java.util.Map<java.lang.String,java.lang.String> options,
                  java.lang.String... entities)
           throws java.io.IOException

Takes the snapshot of a multiple column family from different keyspaces. A snapshot name must be specified.

Parameters:

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

options - Map of options (skipFlush is the only supported option for now)

entities - list of keyspaces / tables in the form of empty | ks1 ks2 ... | ks1.cf1,ks2.cf2,...

Throws:

java.io.IOException

clearSnapshot

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

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

Throws:

java.io.IOException

getSnapshotDetails

java.util.Map<java.lang.String,javax.management.openmbean.TabularData> getSnapshotDetails()

Get the details of all the snapshot

Returns:

A map of snapshotName to all its details in Tabular form.

trueSnapshotsSize

long trueSnapshotsSize()

Get the true size taken by all snapshots across all keyspaces.

Returns:

True size taken by all the snapshots.

refreshSizeEstimates

void refreshSizeEstimates()
                   throws java.util.concurrent.ExecutionException

Forces refresh of values stored in system.size_estimates of all column families.

Throws:

java.util.concurrent.ExecutionException

cleanupSizeEstimates

void cleanupSizeEstimates()

Removes extraneous entries in system.size_estimates.

forceKeyspaceCompaction

void forceKeyspaceCompaction(boolean splitOutput,
                             java.lang.String keyspaceName,
                             java.lang.String... tableNames)
                      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

relocateSSTables

@Deprecated
int relocateSSTables(java.lang.String keyspace,
                                 java.lang.String... cfnames)
                          throws java.io.IOException,
                                 java.util.concurrent.ExecutionException,
                                 java.lang.InterruptedException

Deprecated.

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

relocateSSTables

int relocateSSTables(int jobs,
                     java.lang.String keyspace,
                     java.lang.String... cfnames)
              throws java.io.IOException,
                     java.util.concurrent.ExecutionException,
                     java.lang.InterruptedException

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceKeyspaceCompactionForTokenRange

void forceKeyspaceCompactionForTokenRange(java.lang.String keyspaceName,
                                          java.lang.String startToken,
                                          java.lang.String endToken,
                                          java.lang.String... tableNames)
                                   throws java.io.IOException,
                                          java.util.concurrent.ExecutionException,
                                          java.lang.InterruptedException

Forces major compaction of specified token range in a single keyspace.

Parameters:

keyspaceName - the name of the keyspace to be compacted

startToken - the token at which the compaction range starts (inclusive)

endToken - the token at which compaction range ends (inclusive)

tableNames - the names of the tables to be compacted

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceKeyspaceCleanup

@Deprecated
int forceKeyspaceCleanup(java.lang.String keyspaceName,
                                     java.lang.String... tables)
                              throws java.io.IOException,
                                     java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException

Deprecated.

Trigger a cleanup of keys on a single keyspace

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceKeyspaceCleanup

int forceKeyspaceCleanup(int jobs,
                         java.lang.String keyspaceName,
                         java.lang.String... tables)
                  throws java.io.IOException,
                         java.util.concurrent.ExecutionException,
                         java.lang.InterruptedException

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

scrub

@Deprecated
int scrub(boolean disableSnapshot,
                      boolean skipCorrupted,
                      java.lang.String keyspaceName,
                      java.lang.String... tableNames)
               throws java.io.IOException,
                      java.util.concurrent.ExecutionException,
                      java.lang.InterruptedException

Deprecated.

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

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

scrub

@Deprecated
int scrub(boolean disableSnapshot,
                      boolean skipCorrupted,
                      boolean checkData,
                      java.lang.String keyspaceName,
                      java.lang.String... tableNames)
               throws java.io.IOException,
                      java.util.concurrent.ExecutionException,
                      java.lang.InterruptedException

Deprecated.

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

scrub

@Deprecated
int scrub(boolean disableSnapshot,
                      boolean skipCorrupted,
                      boolean checkData,
                      int jobs,
                      java.lang.String keyspaceName,
                      java.lang.String... columnFamilies)
               throws java.io.IOException,
                      java.util.concurrent.ExecutionException,
                      java.lang.InterruptedException

Deprecated.

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

scrub

int scrub(boolean disableSnapshot,
          boolean skipCorrupted,
          boolean checkData,
          boolean reinsertOverflowedTTL,
          int jobs,
          java.lang.String keyspaceName,
          java.lang.String... columnFamilies)
   throws java.io.IOException,
          java.util.concurrent.ExecutionException,
          java.lang.InterruptedException

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

verify

int verify(boolean extendedVerify,
           java.lang.String keyspaceName,
           java.lang.String... tableNames)
    throws java.io.IOException,
           java.util.concurrent.ExecutionException,
           java.lang.InterruptedException

Verify (checksums of) the given keyspace. If tableNames array is empty, all CFs are verified. The entire sstable will be read to ensure each cell validates if extendedVerify is true

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

upgradeSSTables

@Deprecated
int upgradeSSTables(java.lang.String keyspaceName,
                                boolean excludeCurrentVersion,
                                java.lang.String... tableNames)
                         throws java.io.IOException,
                                java.util.concurrent.ExecutionException,
                                java.lang.InterruptedException

Deprecated.

Rewrite all sstables to the latest version. Unlike scrub, it doesn't skip bad rows and do not snapshot sstables first.

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

upgradeSSTables

int upgradeSSTables(java.lang.String keyspaceName,
                    boolean excludeCurrentVersion,
                    int jobs,
                    java.lang.String... tableNames)
             throws java.io.IOException,
                    java.util.concurrent.ExecutionException,
                    java.lang.InterruptedException

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

garbageCollect

int garbageCollect(java.lang.String tombstoneOption,
                   int jobs,
                   java.lang.String keyspaceName,
                   java.lang.String... tableNames)
            throws java.io.IOException,
                   java.util.concurrent.ExecutionException,
                   java.lang.InterruptedException

Rewrites all sstables from the given tables to remove deleted data. The tombstone option defines the granularity of the procedure: ROW removes deleted partitions and rows, CELL also removes overwritten or deleted cells.

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceKeyspaceFlush

void forceKeyspaceFlush(java.lang.String keyspaceName,
                        java.lang.String... tableNames)
                 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 keyspace if none are explicitly listed.

Parameters:

keyspaceName -

tableNames -

Throws:

java.io.IOException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

repairAsync

int repairAsync(java.lang.String keyspace,
                java.util.Map<java.lang.String,java.lang.String> options)

Invoke repair asynchronously. You can track repair progress by subscribing JMX notification sent from this StorageServiceMBean. Notification format is: type: "repair" userObject: int array of length 2, [0]=command number, [1]=ordinal of ActiveRepairService.Status

Parameters:

keyspace - Keyspace name to repair. Should not be null.

options - repair option.

Returns:

Repair command number, or 0 if nothing to repair

forceRepairAsync

@Deprecated
int forceRepairAsync(java.lang.String keyspace,
                                 boolean isSequential,
                                 java.util.Collection<java.lang.String> dataCenters,
                                 java.util.Collection<java.lang.String> hosts,
                                 boolean primaryRange,
                                 boolean fullRepair,
                                 java.lang.String... tableNames)
                          throws java.io.IOException

Deprecated. use repairAsync(String keyspace, Map options) instead.

Throws:

java.io.IOException

forceRepairAsync

@Deprecated
int forceRepairAsync(java.lang.String keyspace,
                                 int parallelismDegree,
                                 java.util.Collection<java.lang.String> dataCenters,
                                 java.util.Collection<java.lang.String> hosts,
                                 boolean primaryRange,
                                 boolean fullRepair,
                                 java.lang.String... tableNames)

Deprecated. use repairAsync(String keyspace, Map options) instead.

Invoke repair asynchronously. You can track repair progress by subscribing JMX notification sent from this StorageServiceMBean. Notification format is: type: "repair" userObject: int array of length 2, [0]=command number, [1]=ordinal of ActiveRepairService.Status

Parameters:

parallelismDegree - 0: sequential, 1: parallel, 2: DC parallel

Returns:

Repair command number, or 0 if nothing to repair

forceRepairRangeAsync

@Deprecated
int forceRepairRangeAsync(java.lang.String beginToken,
                                      java.lang.String endToken,
                                      java.lang.String keyspaceName,
                                      boolean isSequential,
                                      java.util.Collection<java.lang.String> dataCenters,
                                      java.util.Collection<java.lang.String> hosts,
                                      boolean fullRepair,
                                      java.lang.String... tableNames)
                               throws java.io.IOException

Deprecated. use repairAsync(String keyspace, Map options) instead.

Throws:

java.io.IOException

forceRepairRangeAsync

@Deprecated
int forceRepairRangeAsync(java.lang.String beginToken,
                                      java.lang.String endToken,
                                      java.lang.String keyspaceName,
                                      int parallelismDegree,
                                      java.util.Collection<java.lang.String> dataCenters,
                                      java.util.Collection<java.lang.String> hosts,
                                      boolean fullRepair,
                                      java.lang.String... tableNames)

Deprecated. use repairAsync(String keyspace, Map options) instead.

Same as forceRepairAsync, but handles a specified range

Parameters:

parallelismDegree - 0: sequential, 1: parallel, 2: DC parallel

forceRepairAsync

@Deprecated
int forceRepairAsync(java.lang.String keyspace,
                                 boolean isSequential,
                                 boolean isLocal,
                                 boolean primaryRange,
                                 boolean fullRepair,
                                 java.lang.String... tableNames)

Deprecated. use repairAsync(String keyspace, Map options) instead.

forceRepairRangeAsync

@Deprecated
int forceRepairRangeAsync(java.lang.String beginToken,
                                      java.lang.String endToken,
                                      java.lang.String keyspaceName,
                                      boolean isSequential,
                                      boolean isLocal,
                                      boolean fullRepair,
                                      java.lang.String... tableNames)

Deprecated. use repairAsync(String keyspace, Map options) instead.

forceTerminateAllRepairSessions

void forceTerminateAllRepairSessions()

setRepairSessionMaxTreeDepth

void setRepairSessionMaxTreeDepth(int depth)

getRepairSessionMaxTreeDepth

int getRepairSessionMaxTreeDepth()

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

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

removeNode

void removeNode(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.

setLoggingLevel

void setLoggingLevel(java.lang.String classQualifier,
                     java.lang.String level)
              throws java.lang.Exception

set the logging level at runtime

If both classQualifer and level are empty/null, it will reload the configuration to reset.
If classQualifer is not empty but level is empty/null, it will set the level to null for the defined classQualifer
If level cannot be parsed, then the level will be defaulted to DEBUG

The logback configuration should have < jmxConfigurator /> set

Parameters:

classQualifier - The logger's classQualifer

level - The log level

Throws:

java.lang.Exception

See Also:

Level.toLevel(String)

getLoggingLevels

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

get the runtime logging levels

getOperationMode

java.lang.String getOperationMode()

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

isStarting

boolean isStarting()

Returns whether the storage service is starting or not

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 table)
       throws java.util.concurrent.TimeoutException,
              java.io.IOException

Truncates (deletes) the given table from the provided keyspace. Calling truncate results in actual deletion of all data in the cluster under the given table 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

table - The column family to delete data from.

Throws:

java.util.concurrent.TimeoutException

java.io.IOException

getOwnership

java.util.Map<java.net.InetAddress,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"

effectiveOwnership

java.util.Map<java.net.InetAddress,java.lang.Float> effectiveOwnership(java.lang.String keyspace)
                                                                throws java.lang.IllegalStateException

Effective ownership is % of the data each node owns given the keyspace we calculate the percentage using replication factor. If Keyspace == null, this method will try to verify if all the keyspaces in the cluster have the same replication strategies and if yes then we will use the first else a empty Map is returned.

Throws:

java.lang.IllegalStateException

getKeyspaces

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

getNonSystemKeyspaces

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

getNonLocalStrategyKeyspaces

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

getViewBuildStatuses

java.util.Map<java.lang.String,java.lang.String> getViewBuildStatuses(java.lang.String keyspace,
                                                                      java.lang.String view)

updateSnitch

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

Change endpointsnitch class and dynamic-ness (and dynamic attributes) at runtime. This method is used to change the snitch implementation and/or dynamic snitch parameters. If epSnitchClassName is specified, it will configure a new snitch instance and make it a 'dynamic snitch' if dynamic is specified and true. The parameters dynamicUpdateInterval, dynamicResetInterval and dynamicBadnessThreshold can be specified individually to update the parameters of the dynamic snitch during runtime.

Parameters:

epSnitchClassName - the canonical path name for a class implementing IEndpointSnitch

dynamic - boolean that decides whether dynamicsnitch is used or not - only valid, if epSnitchClassName is specified

dynamicUpdateInterval - integer, in ms (defaults to the value configured in cassandra.yaml, which defaults to 100)

dynamicResetInterval - integer, in ms (defaults to the value configured in cassandra.yaml, which defaults to 600,000)

dynamicBadnessThreshold - double, (defaults to the value configured in cassandra.yaml, which defaults to 0.0)

Throws:

java.lang.ClassNotFoundException

setDynamicUpdateInterval

void setDynamicUpdateInterval(int dynamicUpdateInterval)

getDynamicUpdateInterval

int getDynamicUpdateInterval()

stopGossiping

void stopGossiping()

startGossiping

void startGossiping()

isGossipRunning

boolean isGossipRunning()

stopDaemon

void stopDaemon()

isInitialized

boolean isInitialized()

stopRPCServer

void stopRPCServer()

startRPCServer

void startRPCServer()

isRPCServerRunning

boolean isRPCServerRunning()

stopNativeTransport

void stopNativeTransport()

startNativeTransport

void startNativeTransport()

isNativeTransportRunning

boolean isNativeTransportRunning()

joinRing

void joinRing()
       throws java.io.IOException

Throws:

java.io.IOException

isJoined

boolean isJoined()

isDrained

boolean isDrained()

isDraining

boolean isDraining()

isBootstrapMode

boolean isBootstrapMode()

Check if currently bootstrapping. Note this becomes false before SystemKeyspace.bootstrapComplete() is called, as setting bootstrap to complete is called only when the node joins the ring.

Returns:

True prior to bootstrap streaming completing. False prior to start of bootstrap and post streaming.

setRpcTimeout

void setRpcTimeout(long value)

getRpcTimeout

long getRpcTimeout()

setReadRpcTimeout

void setReadRpcTimeout(long value)

getReadRpcTimeout

long getReadRpcTimeout()

setRangeRpcTimeout

void setRangeRpcTimeout(long value)

getRangeRpcTimeout

long getRangeRpcTimeout()

setWriteRpcTimeout

void setWriteRpcTimeout(long value)

getWriteRpcTimeout

long getWriteRpcTimeout()

setCounterWriteRpcTimeout

void setCounterWriteRpcTimeout(long value)

getCounterWriteRpcTimeout

long getCounterWriteRpcTimeout()

setCasContentionTimeout

void setCasContentionTimeout(long value)

getCasContentionTimeout

long getCasContentionTimeout()

setTruncateRpcTimeout

void setTruncateRpcTimeout(long value)

getTruncateRpcTimeout

long getTruncateRpcTimeout()

setStreamingSocketTimeout

void setStreamingSocketTimeout(int value)

getStreamingSocketTimeout

int getStreamingSocketTimeout()

setStreamThroughputMbPerSec

void setStreamThroughputMbPerSec(int value)

getStreamThroughputMbPerSec

int getStreamThroughputMbPerSec()

setInterDCStreamThroughputMbPerSec

void setInterDCStreamThroughputMbPerSec(int value)

getInterDCStreamThroughputMbPerSec

int getInterDCStreamThroughputMbPerSec()

getCompactionThroughputMbPerSec

int getCompactionThroughputMbPerSec()

setCompactionThroughputMbPerSec

void setCompactionThroughputMbPerSec(int value)

getConcurrentCompactors

int getConcurrentCompactors()

setConcurrentCompactors

void setConcurrentCompactors(int value)

isIncrementalBackupsEnabled

boolean isIncrementalBackupsEnabled()

setIncrementalBackupsEnabled

void setIncrementalBackupsEnabled(boolean value)

rebuild

void rebuild(java.lang.String sourceDc)

Initiate a process of streaming data for which we are responsible from other nodes. It is similar to bootstrap except meant to be used on a node which is already in the cluster (typically containing no data) as an alternative to running repair.

Parameters:

sourceDc - Name of DC from which to select sources for streaming or null to pick any node

rebuild

void rebuild(java.lang.String sourceDc,
             java.lang.String keyspace,
             java.lang.String tokens,
             java.lang.String specificSources)

Same as rebuild(String), but only for specified keyspace and ranges.

Parameters:

sourceDc - Name of DC from which to select sources for streaming or null to pick any node

keyspace - Name of the keyspace which to rebuild or null to rebuild all keyspaces.

tokens - Range of tokens to rebuild or null to rebuild all token ranges. In the format of: "(start_token_1,end_token_1],(start_token_2,end_token_2],...(start_token_n,end_token_n]"

bulkLoad

void bulkLoad(java.lang.String directory)

Starts a bulk load and blocks until it completes.

bulkLoadAsync

java.lang.String bulkLoadAsync(java.lang.String directory)

Starts a bulk load asynchronously and returns the String representation of the planID for the new streaming session.

rescheduleFailedDeletions

void rescheduleFailedDeletions()

loadNewSSTables

void loadNewSSTables(java.lang.String ksName,
                     java.lang.String tableName)

Load new SSTables to the given keyspace/table

Parameters:

ksName - The parent keyspace name

tableName - The ColumnFamily name where SSTables belong

sampleKeyRange

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

Return a List of Tokens representing a sample of keys across all ColumnFamilyStores. Note: this should be left as an operation, not an attribute (methods starting with "get") to avoid sending potentially multiple MB of data when accessing this mbean by default. See CASSANDRA-4452.

Returns:

set of Tokens as Strings

rebuildSecondaryIndex

void rebuildSecondaryIndex(java.lang.String ksName,
                           java.lang.String cfName,
                           java.lang.String... idxNames)

rebuild the specified indexes

resetLocalSchema

void resetLocalSchema()
               throws java.io.IOException

Throws:

java.io.IOException

reloadLocalSchema

void reloadLocalSchema()

setTraceProbability

void setTraceProbability(double probability)

Enables/Disables tracing for the whole system. Only thrift requests can start tracing currently.

Parameters:

probability - ]0,1[ will enable tracing on a partial number of requests with the provided probability. 0 will disable tracing and 1 will enable tracing for all requests (which mich severely cripple the system)

getTraceProbability

double getTraceProbability()

Returns the configured tracing probability.

disableAutoCompaction

void disableAutoCompaction(java.lang.String ks,
                           java.lang.String... tables)
                    throws java.io.IOException

Throws:

java.io.IOException

enableAutoCompaction

void enableAutoCompaction(java.lang.String ks,
                          java.lang.String... tables)
                   throws java.io.IOException

Throws:

java.io.IOException

deliverHints

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

Throws:

java.net.UnknownHostException

getClusterName

java.lang.String getClusterName()

Returns the name of the cluster

getPartitionerName

java.lang.String getPartitionerName()

Returns the cluster partitioner

getTombstoneWarnThreshold

int getTombstoneWarnThreshold()

Returns the threshold for warning of queries with many tombstones

setTombstoneWarnThreshold

void setTombstoneWarnThreshold(int tombstoneDebugThreshold)

Sets the threshold for warning queries with many tombstones

getTombstoneFailureThreshold

int getTombstoneFailureThreshold()

Returns the threshold for abandoning queries with many tombstones

setTombstoneFailureThreshold

void setTombstoneFailureThreshold(int tombstoneDebugThreshold)

Sets the threshold for abandoning queries with many tombstones

getCachedReplicaRowsWarnThreshold

int getCachedReplicaRowsWarnThreshold()

Returns the number of rows cached at the coordinator before filtering/index queries log a warning.

setCachedReplicaRowsWarnThreshold

void setCachedReplicaRowsWarnThreshold(int threshold)

Sets the number of rows cached at the coordinator before filtering/index queries log a warning.

getCachedReplicaRowsFailThreshold

int getCachedReplicaRowsFailThreshold()

Returns the number of rows cached at the coordinator before filtering/index queries fail outright.

setCachedReplicaRowsFailThreshold

void setCachedReplicaRowsFailThreshold(int threshold)

Sets the number of rows cached at the coordinator before filtering/index queries fail outright.

getBatchSizeFailureThreshold

int getBatchSizeFailureThreshold()

Returns the threshold for rejecting queries due to a large batch size

setBatchSizeFailureThreshold

void setBatchSizeFailureThreshold(int batchSizeDebugThreshold)

Sets the threshold for rejecting queries due to a large batch size

setHintedHandoffThrottleInKB

void setHintedHandoffThrottleInKB(int throttleInKB)

Sets the hinted handoff throttle in kb per second, per delivery thread.

resumeBootstrap

boolean resumeBootstrap()

Resume bootstrap streaming when there is failed data streaming.

Returns:

true if the node successfully starts resuming. (this does not mean bootstrap streaming was success.)

getMaxNativeProtocolVersion

int getMaxNativeProtocolVersion()

Returns the max version that this node will negotiate for native protocol connections

getOutstandingSchemaVersions

java.util.Map<java.lang.String,java.util.Set<java.net.InetAddress>> getOutstandingSchemaVersions()

Returns a map of schema version -> list of endpoints reporting that version that we need schema updates for