cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>StorageService (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <div class="topNav"><a name="navbar_top">  </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/StorageService.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/cassandra/service/StorageProxyMBean.html" title="interface in org.apache.cassandra.service"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html" title="interface in org.apache.cassandra.service"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/service/StorageService.html" target="_top">Frames</a></li> <li><a href="StorageService.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.service</div> <h2 title="Class StorageService" class="title">Class StorageService</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>javax.management.NotificationBroadcasterSupport</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.service.StorageService</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, <a href="../../../../org/apache/cassandra/gms/IEndpointStateChangeSubscriber.html" title="interface in org.apache.cassandra.gms">IEndpointStateChangeSubscriber</a>, <a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html" title="interface in org.apache.cassandra.service">StorageServiceMBean</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">StorageService</span> extends javax.management.NotificationBroadcasterSupport implements <a href="../../../../org/apache/cassandra/gms/IEndpointStateChangeSubscriber.html" title="interface in org.apache.cassandra.gms">IEndpointStateChangeSubscriber</a>, <a href="../../../../org/apache/cassandra/service/StorageServiceMBean.html" title="interface in org.apache.cassandra.service">StorageServiceMBean</a></pre> <div class="block">This abstraction contains the token/identifier of this node on the identifier space. This token gets gossiped around. This class will also maintain histograms of the load information of other nodes in the cluster.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/service/StorageService.html" title="class in org.apache.cassandra.service">StorageService</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#instance">instance</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/concurrent/DebuggableScheduledThreadPoolExecutor.html" title="class in org.apache.cassandra.concurrent">DebuggableScheduledThreadPoolExecutor</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#optionalTasks">optionalTasks</a></strong></code> <div class="block">tasks that do not need to be waited for on shutdown/drain</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#RING_DELAY">RING_DELAY</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/concurrent/DebuggableScheduledThreadPoolExecutor.html" title="class in org.apache.cassandra.concurrent">DebuggableScheduledThreadPoolExecutor</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#scheduledTasks">scheduledTasks</a></strong></code> <div class="block">This pool is used for periodic short (sub-second) tasks.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/concurrent/DebuggableScheduledThreadPoolExecutor.html" title="class in org.apache.cassandra.concurrent">DebuggableScheduledThreadPoolExecutor</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#tasks">tasks</a></strong></code> <div class="block">This pool is used by tasks that can have longer execution times, and usually are non periodic.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/gms/VersionedValue.VersionedValueFactory.html" title="class in org.apache.cassandra.gms">VersionedValue.VersionedValueFactory</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#valueFactory">valueFactory</a></strong></code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_summary">  </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#StorageService()">StorageService</a></strong>()</code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_summary">  </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#addExpireTimeIfFound(java.net.InetAddress,%20long)">addExpireTimeIfFound</a></strong>(java.net.InetAddress endpoint, long expireTime)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#beforeChange(java.net.InetAddress,%20org.apache.cassandra.gms.EndpointState,%20org.apache.cassandra.gms.ApplicationState,%20org.apache.cassandra.gms.VersionedValue)">beforeChange</a></strong>(java.net.InetAddress endpoint, <a href="../../../../org/apache/cassandra/gms/EndpointState.html" title="class in org.apache.cassandra.gms">EndpointState</a> currentState, <a href="../../../../org/apache/cassandra/gms/ApplicationState.html" title="enum in org.apache.cassandra.gms">ApplicationState</a> newStateKey, <a href="../../../../org/apache/cassandra/gms/VersionedValue.html" title="class in org.apache.cassandra.gms">VersionedValue</a> newValue)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#bulkLoad(java.lang.String)">bulkLoad</a></strong>(java.lang.String directory)</code> <div class="block">Starts a bulk load and blocks until it completes.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#bulkLoadAsync(java.lang.String)">bulkLoadAsync</a></strong>(java.lang.String directory)</code> <div class="block">Starts a bulk load asynchronously and returns the String representation of the planID for the new streaming session.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.util.Set<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>>,java.util.Set<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#calculateStreamAndFetchRanges(java.util.Collection,%20java.util.Collection)">calculateStreamAndFetchRanges</a></strong>(java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> current, java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> updated)</code> <div class="block">Calculate pair of ranges to stream/fetch for given two range collections (current ranges for keyspace and ranges after move to new token)</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#checkForEndpointCollision()">checkForEndpointCollision</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#clearSnapshot(java.lang.String,%20java.lang.String...)">clearSnapshot</a></strong>(java.lang.String tag, java.lang.String... keyspaceNames)</code> <div class="block">Remove the snapshot with the given name from the given keyspaces.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#confirmReplication(java.net.InetAddress)">confirmReplication</a></strong>(java.net.InetAddress node)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#decommission()">decommission</a></strong>()</code> <div class="block">transfer this node's data to other machines and remove it from service.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#deliverHints(java.lang.String)">deliverHints</a></strong>(java.lang.String host)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/thrift/TokenRange.html" title="class in org.apache.cassandra.thrift">TokenRange</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#describeLocalRing(java.lang.String)">describeLocalRing</a></strong>(java.lang.String keyspace)</code> <div class="block">The same as <code>describeRing(String)</code> but considers only the part of the ring formed by nodes in the local DC.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/thrift/TokenRange.html" title="class in org.apache.cassandra.thrift">TokenRange</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#describeRing(java.lang.String)">describeRing</a></strong>(java.lang.String keyspace)</code> <div class="block">The TokenRange for a given keyspace.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#describeRingJMX(java.lang.String)">describeRingJMX</a></strong>(java.lang.String keyspace)</code> <div class="block">The same as <code>describeRing(String)</code> but converts TokenRange to the String for JMX compatibility</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#disableAutoCompaction(java.lang.String,%20java.lang.String...)">disableAutoCompaction</a></strong>(java.lang.String ks, java.lang.String... columnFamilies)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#drain()">drain</a></strong>()</code> <div class="block">Shuts node off to writes, empties memtables and the commit log.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.LinkedHashMap<java.net.InetAddress,java.lang.Float></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#effectiveOwnership(java.lang.String)">effectiveOwnership</a></strong>(java.lang.String keyspace)</code> <div class="block">Calculates ownership.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#enableAutoCompaction(java.lang.String,%20java.lang.String...)">enableAutoCompaction</a></strong>(java.lang.String ks, java.lang.String... columnFamilies)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#extractExpireTime(java.lang.String[])">extractExpireTime</a></strong>(java.lang.String[] pieces)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#finishBootstrapping()">finishBootstrapping</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceKeyspaceCleanup(java.lang.String,%20java.lang.String...)">forceKeyspaceCleanup</a></strong>(java.lang.String keyspaceName, java.lang.String... columnFamilies)</code> <div class="block">Trigger a cleanup of keys on a single keyspace</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceKeyspaceCompaction(java.lang.String,%20java.lang.String...)">forceKeyspaceCompaction</a></strong>(java.lang.String keyspaceName, java.lang.String... columnFamilies)</code> <div class="block">Forces major compaction of a single keyspace</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceKeyspaceFlush(java.lang.String,%20java.lang.String...)">forceKeyspaceFlush</a></strong>(java.lang.String keyspaceName, java.lang.String... columnFamilies)</code> <div class="block">Flush all memtables for a keyspace and column families.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRemoveCompletion()">forceRemoveCompletion</a></strong>()</code> <div class="block">Force a remove operation to complete.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRepairAsync(java.lang.String,%20boolean,%20boolean,%20boolean,%20boolean,%20java.lang.String...)">forceRepairAsync</a></strong>(java.lang.String keyspace, boolean isSequential, boolean isLocal, boolean primaryRange, boolean fullRepair, java.lang.String... columnFamilies)</code> <div class="block">Invoke repair asynchronously.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRepairAsync(java.lang.String,%20boolean,%20boolean,%20java.util.Collection,%20boolean,%20java.lang.String...)">forceRepairAsync</a></strong>(java.lang.String keyspace, boolean isSequential, boolean isLocal, java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> ranges, boolean fullRepair, java.lang.String... columnFamilies)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRepairAsync(java.lang.String,%20boolean,%20java.util.Collection,%20java.util.Collection,%20boolean,%20boolean,%20java.lang.String...)">forceRepairAsync</a></strong>(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... columnFamilies)</code> <div class="block">Invoke repair asynchronously.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRepairAsync(java.lang.String,%20boolean,%20java.util.Collection,%20java.util.Collection,%20java.util.Collection,%20boolean,%20java.lang.String...)">forceRepairAsync</a></strong>(java.lang.String keyspace, boolean isSequential, java.util.Collection<java.lang.String> dataCenters, java.util.Collection<java.lang.String> hosts, java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>> ranges, boolean fullRepair, java.lang.String... columnFamilies)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRepairRangeAsync(java.lang.String,%20java.lang.String,%20java.lang.String,%20boolean,%20boolean,%20boolean,%20java.lang.String...)">forceRepairRangeAsync</a></strong>(java.lang.String beginToken, java.lang.String endToken, java.lang.String keyspaceName, boolean isSequential, boolean isLocal, boolean fullRepair, java.lang.String... columnFamilies)</code> <div class="block">Same as forceRepairAsync, but handles a specified range</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceRepairRangeAsync(java.lang.String,%20java.lang.String,%20java.lang.String,%20boolean,%20java.util.Collection,%20java.util.Collection,%20boolean,%20java.lang.String...)">forceRepairRangeAsync</a></strong>(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... columnFamilies)</code> <div class="block">Same as forceRepairAsync, but handles a specified range</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#forceTerminateAllRepairSessions()">forceTerminateAllRepairSessions</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getAllDataFileLocations()">getAllDataFileLocations</a></strong>()</code> <div class="block">Get the list of all data file locations from conf</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getAllRanges(java.util.List)">getAllRanges</a></strong>(java.util.List<<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> sortedTokens)</code> <div class="block">Get all ranges that span the ring given a set of tokens.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getClusterName()">getClusterName</a></strong>()</code> <div class="block">Returns the name of the cluster</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getCommitLogLocation()">getCommitLogLocation</a></strong>()</code> <div class="block">Get location of the commit log</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getCompactionThroughputMbPerSec()">getCompactionThroughputMbPerSec</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getCurrentGenerationNumber()">getCurrentGenerationNumber</a></strong>()</code> <div class="block">Return the generation value for this node.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getDrainProgress()">getDrainProgress</a></strong>()</code> <div class="block">get the progress of a drain operation</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getExceptionCount()">getExceptionCount</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getHostIdMap()">getHostIdMap</a></strong>()</code> <div class="block">Retrieve the mapping of endpoint to host ID</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getJoiningNodes()">getJoiningNodes</a></strong>()</code> <div class="block">Retrieve the list of nodes currently bootstrapping into the ring.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getKeyspaces()">getKeyspaces</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLeavingNodes()">getLeavingNodes</a></strong>()</code> <div class="block">Retrieve the list of nodes currently leaving the ring.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.net.InetAddress></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLiveNaturalEndpoints(org.apache.cassandra.db.Keyspace,%20java.nio.ByteBuffer)">getLiveNaturalEndpoints</a></strong>(<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace, java.nio.ByteBuffer key)</code> <div class="block">This method attempts to return N endpoints that are responsible for storing the specified key i.e for replication.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.net.InetAddress></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLiveNaturalEndpoints(org.apache.cassandra.db.Keyspace,%20org.apache.cassandra.dht.RingPosition)">getLiveNaturalEndpoints</a></strong>(<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace, <a href="../../../../org/apache/cassandra/dht/RingPosition.html" title="interface in org.apache.cassandra.dht">RingPosition</a> pos)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLiveNodes()">getLiveNodes</a></strong>()</code> <div class="block">Retrieve the list of live nodes in the cluster, where "liveness" is determined by the failure detector of the node being queried.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLoad()">getLoad</a></strong>()</code> <div class="block">raw load value</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLoadMap()">getLoadMap</a></strong>()</code> <div class="block">Human-readable load value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLoadString()">getLoadString</a></strong>()</code> <div class="block">Human-readable load value</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLocalHostId()">getLocalHostId</a></strong>()</code> <div class="block">Retrieve this hosts unique ID</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLocalPrimaryRanges(java.lang.String)">getLocalPrimaryRanges</a></strong>(java.lang.String keyspace)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLocalRanges(java.lang.String)">getLocalRanges</a></strong>(java.lang.String keyspaceName)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLocalTokens()">getLocalTokens</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getLoggingLevels()">getLoggingLevels</a></strong>()</code> <div class="block">get the runtime logging levels</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getMovingNodes()">getMovingNodes</a></strong>()</code> <div class="block">Retrieve the list of nodes currently moving in the ring.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.net.InetAddress></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getNaturalEndpoints(java.lang.String,%20java.nio.ByteBuffer)">getNaturalEndpoints</a></strong>(java.lang.String keyspaceName, java.nio.ByteBuffer key)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.net.InetAddress></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getNaturalEndpoints(java.lang.String,%20org.apache.cassandra.dht.RingPosition)">getNaturalEndpoints</a></strong>(java.lang.String keyspaceName, <a href="../../../../org/apache/cassandra/dht/RingPosition.html" title="interface in org.apache.cassandra.dht">RingPosition</a> pos)</code> <div class="block">This method returns the N endpoints that are responsible for storing the specified key i.e for replication.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.net.InetAddress></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getNaturalEndpoints(java.lang.String,%20java.lang.String,%20java.lang.String)">getNaturalEndpoints</a></strong>(java.lang.String keyspaceName, java.lang.String cf, java.lang.String key)</code> <div class="block">This method returns the N endpoints that are responsible for storing the specified key i.e for replication.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getOperationMode()">getOperationMode</a></strong>()</code> <div class="block">get the operational mode (leaving, joining, normal, decommissioned, client)</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.net.InetAddress,java.lang.Float></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getOwnership()">getOwnership</a></strong>()</code> <div class="block">given a list of tokens (representing the nodes in the cluster), returns a mapping from "token -> %age of cluster owned by that token"</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getPartitioner()">getPartitioner</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getPartitionerName()">getPartitionerName</a></strong>()</code> <div class="block">Returns the cluster partitioner</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map<java.util.List<java.lang.String>,java.util.List<java.lang.String>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getPendingRangeToEndpointMap(java.lang.String)">getPendingRangeToEndpointMap</a></strong>(java.lang.String keyspace)</code> <div class="block">Retrieve a map of pending ranges to endpoints that describe the ring topology</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getPrimaryRangeForEndpoint(java.net.InetAddress)">getPrimaryRangeForEndpoint</a></strong>(java.net.InetAddress ep)</code> <div class="block"><strong>Deprecated.</strong>  </div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getPrimaryRangesForEndpoint(java.lang.String,%20java.net.InetAddress)">getPrimaryRangesForEndpoint</a></strong>(java.lang.String keyspace, java.net.InetAddress ep)</code> <div class="block">Get the "primary ranges" for the specified keyspace and endpoint.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>,java.util.List<java.net.InetAddress>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getRangeToAddressMap(java.lang.String)">getRangeToAddressMap</a></strong>(java.lang.String keyspace)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>,java.util.List<java.net.InetAddress>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getRangeToAddressMapInLocalDC(java.lang.String)">getRangeToAddressMapInLocalDC</a></strong>(java.lang.String keyspace)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.util.List<java.lang.String>,java.util.List<java.lang.String>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getRangeToEndpointMap(java.lang.String)">getRangeToEndpointMap</a></strong>(java.lang.String keyspace)</code> <div class="block">for a keyspace, return the ranges and corresponding listen addresses.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map<java.util.List<java.lang.String>,java.util.List<java.lang.String>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getRangeToRpcaddressMap(java.lang.String)">getRangeToRpcaddressMap</a></strong>(java.lang.String keyspace)</code> <div class="block">for a keyspace, return the ranges and corresponding RPC addresses for a given keyspace.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getReleaseVersion()">getReleaseVersion</a></strong>()</code> <div class="block">Fetch a string representation of the Cassandra version.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getRemovalStatus()">getRemovalStatus</a></strong>()</code> <div class="block">Get the status of a token removal.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getRpcaddress(java.net.InetAddress)">getRpcaddress</a></strong>(java.net.InetAddress endpoint)</code> <div class="block">Return the rpc address associated with an endpoint as a string.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getSavedCachesLocation()">getSavedCachesLocation</a></strong>()</code> <div class="block">Get location of the saved caches dir</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getSchemaVersion()">getSchemaVersion</a></strong>()</code> <div class="block">Fetch a string representation of the current Schema version.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getSeverity(java.net.InetAddress)">getSeverity</a></strong>(java.net.InetAddress endpoint)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,javax.management.openmbean.TabularData></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getSnapshotDetails()">getSnapshotDetails</a></strong>()</code> <div class="block">Get the details of all the snapshot</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>>,java.lang.Long>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getSplits(java.lang.String,%20java.lang.String,%20org.apache.cassandra.dht.Range,%20int)">getSplits</a></strong>(java.lang.String keyspaceName, java.lang.String cfName, <a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> range, int keysPerSplit)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getStreamThroughputMbPerSec()">getStreamThroughputMbPerSec</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/locator/TokenMetadata.html" title="class in org.apache.cassandra.locator">TokenMetadata</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTokenMetadata()">getTokenMetadata</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTokens()">getTokens</a></strong>()</code> <div class="block">Fetch string representations of the tokens for this node.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTokens(java.lang.String)">getTokens</a></strong>(java.lang.String endpoint)</code> <div class="block">Fetch string representations of the tokens for a specified node.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTokenToEndpointMap()">getTokenToEndpointMap</a></strong>()</code> <div class="block">Retrieve a map of tokens to endpoints, including the bootstrapping ones.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTombstoneFailureThreshold()">getTombstoneFailureThreshold</a></strong>()</code> <div class="block">Returns the threshold for abandoning queries with many tombstones</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTombstoneWarnThreshold()">getTombstoneWarnThreshold</a></strong>()</code> <div class="block">Returns the threshold for warning of queries with many tombstones</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getTracingProbability()">getTracingProbability</a></strong>()</code> <div class="block">Returns the configured tracing probability.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getUnreachableNodes()">getUnreachableNodes</a></strong>()</code> <div class="block">Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.Iterable<<a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#getValidColumnFamilies(boolean,%20boolean,%20java.lang.String,%20java.lang.String...)">getValidColumnFamilies</a></strong>(boolean allowIndexes, boolean autoAddIndexes, java.lang.String keyspaceName, java.lang.String... cfNames)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#gossipSnitchInfo()">gossipSnitchInfo</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#initClient()">initClient</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#initClient(int)">initClient</a></strong>(int ringDelay)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#initServer()">initServer</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#initServer(int)">initServer</a></strong>(int delay)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/service/StorageService.html#isBootstrapMode()">isBootstrapMode</a>