Interface StorageServiceMBean

  • All Superinterfaces:
    javax.management.NotificationBroadcaster, javax.management.NotificationEmitter
    All Known Implementing Classes:
    StorageService

    public interface StorageServiceMBean
    extends javax.management.NotificationEmitter
    • Method Detail

      • getLiveNodes

        @Deprecated
        java.util.List<java.lang.String> getLiveNodes()
        Deprecated.
        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
      • getLiveNodesWithPort

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

        @Deprecated
        java.util.List<java.lang.String> getUnreachableNodes()
        Deprecated.
        Retrieve the list of unreachable nodes in the cluster, as determined by this node's failure detector.
        Returns:
        set of IP addresses, as Strings
      • getUnreachableNodesWithPort

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

        @Deprecated
        java.util.List<java.lang.String> getJoiningNodes()
        Deprecated.
        Retrieve the list of nodes currently bootstrapping into the ring.
        Returns:
        set of IP addresses, as Strings
      • getJoiningNodesWithPort

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

        @Deprecated
        java.util.List<java.lang.String> getLeavingNodes()
        Deprecated.
        Retrieve the list of nodes currently leaving the ring.
        Returns:
        set of IP addresses, as Strings
      • getLeavingNodesWithPort

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

        @Deprecated
        java.util.List<java.lang.String> getMovingNodes()
        Deprecated.
        Retrieve the list of nodes currently moving in the ring.
        Returns:
        set of IP addresses, as Strings
      • getMovingNodesWithPort

        java.util.List<java.lang.String> getMovingNodesWithPort()
      • 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:
        An integer that represents replication factor for the given keyspace.
      • getAllDataFileLocations

        java.lang.String[] getAllDataFileLocations()
        Get the list of all data file locations from conf
        Returns:
        String array of all locations
      • getLocalSystemKeyspacesDataFileLocations

        java.lang.String[] getLocalSystemKeyspacesDataFileLocations()
        Returns the locations where the local system keyspaces data should be stored.
        Returns:
        the locations where the local system keyspaces data should be stored
      • getNonLocalSystemKeyspacesDataFileLocations

        java.lang.String[] getNonLocalSystemKeyspacesDataFileLocations()
        Returns the locations where should be stored the non system keyspaces data.
        Returns:
        the locations where should be stored the non system keyspaces data
      • 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

        @Deprecated
        java.util.Map<java.util.List<java.lang.String>,​java.util.List<java.lang.String>> getRangeToEndpointMap​(java.lang.String keyspace)
        Deprecated.
        Retrieve a map of range to end points that describe the ring topology of a Cassandra cluster.
        Returns:
        mapping of ranges to end points
      • getRangeToEndpointWithPortMap

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

        @Deprecated
        java.util.Map<java.util.List<java.lang.String>,​java.util.List<java.lang.String>> getRangeToRpcaddressMap​(java.lang.String keyspace)
        Deprecated.
        Retrieve a map of range to rpc addresses that describe the ring topology of a Cassandra cluster.
        Returns:
        mapping of ranges to rpc addresses
      • getRangeToNativeaddressWithPortMap

        java.util.Map<java.util.List<java.lang.String>,​java.util.List<java.lang.String>> getRangeToNativeaddressWithPortMap​(java.lang.String keyspace)
      • describeRingJMX

        @Deprecated
        java.util.List<java.lang.String> describeRingJMX​(java.lang.String keyspace)
                                                  throws java.io.IOException
        Deprecated.
        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
      • describeRingWithPortJMX

        java.util.List<java.lang.String> describeRingWithPortJMX​(java.lang.String keyspace)
                                                          throws java.io.IOException
        Throws:
        java.io.IOException
      • getPendingRangeToEndpointMap

        @Deprecated
        java.util.Map<java.util.List<java.lang.String>,​java.util.List<java.lang.String>> getPendingRangeToEndpointMap​(java.lang.String keyspace)
        Deprecated.
        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
      • getPendingRangeToEndpointWithPortMap

        java.util.Map<java.util.List<java.lang.String>,​java.util.List<java.lang.String>> getPendingRangeToEndpointWithPortMap​(java.lang.String keyspace)
      • getTokenToEndpointMap

        @Deprecated
        java.util.Map<java.lang.String,​java.lang.String> getTokenToEndpointMap()
        Deprecated.
        Retrieve a map of tokens to endpoints, including the bootstrapping ones.
        Returns:
        a map of tokens to endpoints in ascending order
      • getTokenToEndpointWithPortMap

        java.util.Map<java.lang.String,​java.lang.String> getTokenToEndpointWithPortMap()
      • getLocalHostId

        java.lang.String getLocalHostId()
        Retrieve this hosts unique ID
      • getHostIdMap

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

        @Deprecated
        java.util.Map<java.lang.String,​java.lang.String> getEndpointToHostId()
        Deprecated.
        Retrieve the mapping of endpoint to host ID
      • getEndpointWithPortToHostId

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

        @Deprecated
        java.util.Map<java.lang.String,​java.lang.String> getHostIdToEndpoint()
        Deprecated.
        Retrieve the mapping of host ID to endpoint
      • getHostIdToEndpointWithPort

        java.util.Map<java.lang.String,​java.lang.String> getHostIdToEndpointWithPort()
      • getLoadString

        java.lang.String getLoadString()
        Human-readable load value
      • getLoadMap

        @Deprecated
        java.util.Map<java.lang.String,​java.lang.String> getLoadMap()
        Deprecated.
        Human-readable load value. Keys are IP addresses.
      • getLoadMapWithPort

        java.util.Map<java.lang.String,​java.lang.String> getLoadMapWithPort()
      • getCurrentGenerationNumber

        int getCurrentGenerationNumber()
        Return the generation value for this node.
        Returns:
        generation number
      • getNaturalEndpoints

        @Deprecated
        java.util.List<java.net.InetAddress> getNaturalEndpoints​(java.lang.String keyspaceName,
                                                                 java.lang.String cf,
                                                                 java.lang.String key)
        Deprecated.
        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
      • getNaturalEndpointsWithPort

        java.util.List<java.lang.String> getNaturalEndpointsWithPort​(java.lang.String keyspaceName,
                                                                     java.lang.String cf,
                                                                     java.lang.String key)
      • getNaturalEndpoints

        @Deprecated
        java.util.List<java.net.InetAddress> getNaturalEndpoints​(java.lang.String keyspaceName,
                                                                 java.nio.ByteBuffer key)
        Deprecated.
      • getNaturalEndpointsWithPort

        java.util.List<java.lang.String> getNaturalEndpointsWithPort​(java.lang.String keysapceName,
                                                                     java.nio.ByteBuffer key)
      • 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.
      • setSnapshotLinksPerSecond

        void setSnapshotLinksPerSecond​(long throttle)
        Set the current hardlink-per-second throttle for snapshots A setting of zero indicates no throttling
        Parameters:
        throttle -
      • getSnapshotLinksPerSecond

        long getSnapshotLinksPerSecond()
        Get the current hardlink-per-second throttle for snapshots A setting of zero indicates no throttling.
        Returns:
        snapshot links-per-second throttle
      • 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
      • verify

        int verify​(boolean extendedVerify,
                   boolean checkVersion,
                   boolean diskFailurePolicy,
                   boolean mutateRepairStatus,
                   boolean checkOwnsTokens,
                   boolean quick,
                   java.lang.String keyspaceName,
                   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
      • 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
      • forceTerminateAllRepairSessions

        void forceTerminateAllRepairSessions()
      • setRepairSessionMaxTreeDepth

        void setRepairSessionMaxTreeDepth​(int depth)
      • getRepairSessionMaxTreeDepth

        int getRepairSessionMaxTreeDepth()
      • getParentRepairStatus

        @Nullable
        java.util.List<java.lang.String> getParentRepairStatus​(int cmd)
        Get the status of a given parent repair session.
        Parameters:
        cmd - the int reference returned when issuing the repair
        Returns:
        status of parent repair from enum org.apache.cassandra.repair.RepairRunnable.Status followed by final message or messages of the session
      • decommission

        void decommission​(boolean force)
                   throws java.lang.InterruptedException
        transfer this node's data to other machines and remove it from service.
        Parameters:
        force - Decommission even if this will reduce N to be less than RF.
        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

        @Deprecated
        java.lang.String getRemovalStatus()
        Deprecated.
        Get the status of a token removal.
      • getRemovalStatusWithPort

        java.lang.String getRemovalStatusWithPort()
      • 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

        @Deprecated
        java.util.Map<java.net.InetAddress,​java.lang.Float> getOwnership()
        Deprecated.
        given a list of tokens (representing the nodes in the cluster), returns a mapping from "token -> %age of cluster owned by that token"
      • getOwnershipWithPort

        java.util.Map<java.lang.String,​java.lang.Float> getOwnershipWithPort()
      • effectiveOwnership

        @Deprecated
        java.util.Map<java.net.InetAddress,​java.lang.Float> effectiveOwnership​(java.lang.String keyspace)
                                                                              throws java.lang.IllegalStateException
        Deprecated.
        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
      • effectiveOwnershipWithPort

        java.util.Map<java.lang.String,​java.lang.Float> effectiveOwnershipWithPort​(java.lang.String keyspace)
                                                                                  throws java.lang.IllegalStateException
        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

        @Deprecated
        java.util.Map<java.lang.String,​java.lang.String> getViewBuildStatuses​(java.lang.String keyspace,
                                                                                    java.lang.String view)
        Deprecated.
      • getViewBuildStatusesWithPort

        java.util.Map<java.lang.String,​java.lang.String> getViewBuildStatusesWithPort​(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()
      • stopNativeTransport

        void stopNativeTransport()
      • startNativeTransport

        void startNativeTransport()
      • isNativeTransportRunning

        boolean isNativeTransportRunning()
      • enableNativeTransportOldProtocolVersions

        void enableNativeTransportOldProtocolVersions()
      • disableNativeTransportOldProtocolVersions

        void disableNativeTransportOldProtocolVersions()
      • getNativeTransportMaxConcurrentRequestsInBytes

        long getNativeTransportMaxConcurrentRequestsInBytes()
      • setNativeTransportMaxConcurrentRequestsInBytes

        void setNativeTransportMaxConcurrentRequestsInBytes​(long newLimit)
      • getNativeTransportMaxConcurrentRequestsInBytesPerIp

        long getNativeTransportMaxConcurrentRequestsInBytesPerIp()
      • setNativeTransportMaxConcurrentRequestsInBytesPerIp

        void setNativeTransportMaxConcurrentRequestsInBytesPerIp​(long newLimit)
      • 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()
      • setInternodeTcpConnectTimeoutInMS

        void setInternodeTcpConnectTimeoutInMS​(int value)
      • getInternodeTcpConnectTimeoutInMS

        int getInternodeTcpConnectTimeoutInMS()
      • setInternodeTcpUserTimeoutInMS

        void setInternodeTcpUserTimeoutInMS​(int value)
      • getInternodeTcpUserTimeoutInMS

        int getInternodeTcpUserTimeoutInMS()
      • setInternodeStreamingTcpUserTimeoutInMS

        void setInternodeStreamingTcpUserTimeoutInMS​(int value)
      • getInternodeStreamingTcpUserTimeoutInMS

        int getInternodeStreamingTcpUserTimeoutInMS()
      • setCounterWriteRpcTimeout

        void setCounterWriteRpcTimeout​(long value)
      • getCounterWriteRpcTimeout

        long getCounterWriteRpcTimeout()
      • setCasContentionTimeout

        void setCasContentionTimeout​(long value)
      • getCasContentionTimeout

        long getCasContentionTimeout()
      • setTruncateRpcTimeout

        void setTruncateRpcTimeout​(long value)
      • getTruncateRpcTimeout

        long getTruncateRpcTimeout()
      • setStreamThroughputMbPerSec

        void setStreamThroughputMbPerSec​(int value)
      • getStreamThroughputMbPerSec

        int getStreamThroughputMbPerSec()
      • setInterDCStreamThroughputMbPerSec

        void setInterDCStreamThroughputMbPerSec​(int value)
      • getInterDCStreamThroughputMbPerSec

        int getInterDCStreamThroughputMbPerSec()
      • getCompactionThroughputMbPerSec

        int getCompactionThroughputMbPerSec()
      • setCompactionThroughputMbPerSec

        void setCompactionThroughputMbPerSec​(int value)
      • getBatchlogReplayThrottleInKB

        int getBatchlogReplayThrottleInKB()
      • setBatchlogReplayThrottleInKB

        void setBatchlogReplayThrottleInKB​(int value)
      • getConcurrentCompactors

        int getConcurrentCompactors()
      • setConcurrentCompactors

        void setConcurrentCompactors​(int value)
      • bypassConcurrentValidatorsLimit

        void bypassConcurrentValidatorsLimit()
      • enforceConcurrentValidatorsLimit

        void enforceConcurrentValidatorsLimit()
      • isConcurrentValidatorsLimitEnforced

        boolean isConcurrentValidatorsLimitEnforced()
      • getConcurrentValidators

        int getConcurrentValidators()
      • setConcurrentValidators

        void setConcurrentValidators​(int value)
      • getSSTablePreemptiveOpenIntervalInMB

        int getSSTablePreemptiveOpenIntervalInMB()
      • setSSTablePreemptiveOpenIntervalInMB

        void setSSTablePreemptiveOpenIntervalInMB​(int intervalInMB)
      • getMigrateKeycacheOnCompaction

        boolean getMigrateKeycacheOnCompaction()
      • setMigrateKeycacheOnCompaction

        void setMigrateKeycacheOnCompaction​(boolean invalidateKeyCacheOnCompaction)
      • getConcurrentViewBuilders

        int getConcurrentViewBuilders()
      • setConcurrentViewBuilders

        void setConcurrentViewBuilders​(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

        @Deprecated
        void loadNewSSTables​(java.lang.String ksName,
                             java.lang.String tableName)
        Deprecated.
        Load new SSTables to the given keyspace/table
        Parameters:
        ksName - The parent keyspace name
        tableName - The ColumnFamily name where SSTables belong
        See Also:
        ColumnFamilyStoreMBean.loadNewSSTables()
      • 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.
        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)
      • samplePartitions

        java.util.Map<java.lang.String,​java.util.List<javax.management.openmbean.CompositeData>> samplePartitions​(int duration,
                                                                                                                        int capacity,
                                                                                                                        int count,
                                                                                                                        java.util.List<java.lang.String> samplers)
                                                                                                                 throws javax.management.openmbean.OpenDataException
        Throws:
        javax.management.openmbean.OpenDataException
      • 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
      • getAutoCompactionStatus

        java.util.Map<java.lang.String,​java.lang.Boolean> getAutoCompactionStatus​(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.
      • getColumnIndexCacheSize

        int getColumnIndexCacheSize()
        Returns the threshold for skipping the column index when caching partition info
      • setColumnIndexCacheSize

        void setColumnIndexCacheSize​(int cacheSizeInKB)
        Sets the threshold for skipping the column index when caching partition info
      • 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
      • getBatchSizeWarnThreshold

        int getBatchSizeWarnThreshold()
        Returns the threshold for warning queries due to a large batch size
      • setBatchSizeWarnThreshold

        void setBatchSizeWarnThreshold​(int batchSizeDebugThreshold)
        Sets the threshold for warning 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.)
      • getConcurrency

        java.util.Map<java.lang.String,​java.util.List<java.lang.Integer>> getConcurrency​(java.util.List<java.lang.String> stageNames)
      • setConcurrency

        void setConcurrency​(java.lang.String threadPoolName,
                            int newCorePoolSize,
                            int newMaximumPoolSize)
        Sets the concurrency setting for processing stages
      • clearConnectionHistory

        void clearConnectionHistory()
        Clears the history of clients that have connected in the past
      • disableAuditLog

        void disableAuditLog()
      • enableAuditLog

        void enableAuditLog​(java.lang.String loggerName,
                            java.util.Map<java.lang.String,​java.lang.String> parameters,
                            java.lang.String includedKeyspaces,
                            java.lang.String excludedKeyspaces,
                            java.lang.String includedCategories,
                            java.lang.String excludedCategories,
                            java.lang.String includedUsers,
                            java.lang.String excludedUsers)
                     throws ConfigurationException
        Throws:
        ConfigurationException
      • enableAuditLog

        void enableAuditLog​(java.lang.String loggerName,
                            java.lang.String includedKeyspaces,
                            java.lang.String excludedKeyspaces,
                            java.lang.String includedCategories,
                            java.lang.String excludedCategories,
                            java.lang.String includedUsers,
                            java.lang.String excludedUsers)
                     throws ConfigurationException
        Throws:
        ConfigurationException
      • isAuditLogEnabled

        boolean isAuditLogEnabled()
      • getCorruptedTombstoneStrategy

        java.lang.String getCorruptedTombstoneStrategy()
      • setCorruptedTombstoneStrategy

        void setCorruptedTombstoneStrategy​(java.lang.String strategy)
      • enableFullQueryLogger

        void enableFullQueryLogger​(java.lang.String path,
                                   java.lang.String rollCycle,
                                   java.lang.Boolean blocking,
                                   int maxQueueWeight,
                                   long maxLogSize,
                                   @Nullable
                                   java.lang.String archiveCommand,
                                   int maxArchiveRetries)
        Start the fully query logger.
        Parameters:
        path - Path where the full query log will be stored. If null cassandra.yaml value is used.
        rollCycle - How often to create a new file for query data (MINUTELY, DAILY, HOURLY)
        blocking - Whether threads submitting queries to the query log should block if they can't be drained to the filesystem or alternatively drops samples and log
        maxQueueWeight - How many bytes of query data to queue before blocking or dropping samples
        maxLogSize - How many bytes of log data to store before dropping segments. Might not be respected if a log file hasn't rolled so it can be deleted.
        archiveCommand - executable archiving the rolled log files,
        maxArchiveRetries - max number of times to retry a failing archive command
      • resetFullQueryLogger

        void resetFullQueryLogger()
        Disable the full query logger if it is enabled. Also delete any generated files in the last used full query log path as well as the one configure in cassandra.yaml
      • stopFullQueryLogger

        void stopFullQueryLogger()
        Stop logging queries but leave any generated files on disk.
      • isFullQueryLogEnabled

        boolean isFullQueryLogEnabled()
      • getFullQueryLoggerOptions

        javax.management.openmbean.CompositeData getFullQueryLoggerOptions()
        Returns the current state of FQL.
      • setInitialRangeTombstoneListAllocationSize

        void setInitialRangeTombstoneListAllocationSize​(int size)
        Sets the initial allocation size of backing arrays for new RangeTombstoneList objects
      • getInitialRangeTombstoneListAllocationSize

        int getInitialRangeTombstoneListAllocationSize()
        Returns the initial allocation size of backing arrays for new RangeTombstoneList objects
      • setRangeTombstoneListResizeGrowthFactor

        void setRangeTombstoneListResizeGrowthFactor​(double growthFactor)
        Sets the resize factor to use when growing/resizing a RangeTombstoneList
      • getRangeTombstoneResizeListGrowthFactor

        double getRangeTombstoneResizeListGrowthFactor()
        Returns the resize factor to use when growing/resizing a RangeTombstoneList
      • getOutstandingSchemaVersions

        @Deprecated
        java.util.Map<java.lang.String,​java.util.Set<java.net.InetAddress>> getOutstandingSchemaVersions()
        Deprecated.
        Returns a map of schema version -> list of endpoints reporting that version that we need schema updates for
      • getOutstandingSchemaVersionsWithPort

        java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> getOutstandingSchemaVersionsWithPort()
      • autoOptimiseIncRepairStreams

        boolean autoOptimiseIncRepairStreams()
      • setAutoOptimiseIncRepairStreams

        void setAutoOptimiseIncRepairStreams​(boolean enabled)
      • autoOptimiseFullRepairStreams

        boolean autoOptimiseFullRepairStreams()
      • setAutoOptimiseFullRepairStreams

        void setAutoOptimiseFullRepairStreams​(boolean enabled)
      • autoOptimisePreviewRepairStreams

        boolean autoOptimisePreviewRepairStreams()
      • setAutoOptimisePreviewRepairStreams

        void setAutoOptimisePreviewRepairStreams​(boolean enabled)
      • getTableCountWarnThreshold

        int getTableCountWarnThreshold()
      • setTableCountWarnThreshold

        void setTableCountWarnThreshold​(int value)
      • getKeyspaceCountWarnThreshold

        int getKeyspaceCountWarnThreshold()
      • setKeyspaceCountWarnThreshold

        void setKeyspaceCountWarnThreshold​(int value)
      • getRepairRpcTimeout

        java.lang.Long getRepairRpcTimeout()
      • setRepairRpcTimeout

        void setRepairRpcTimeout​(java.lang.Long timeoutInMillis)