java.lang.Object
- org.apache.cassandra.service.StorageProxy

All Implemented Interfaces:: StorageProxyMBean

public class StorageProxy
extends java.lang.Object
implements StorageProxyMBean

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class StorageProxy.LocalReadRunnable

static interface StorageProxy.WritePerformer

Field Summary

Fields
Modifier and Type Field Description

static StorageProxy instance

static java.lang.String MBEAN_NAME

static java.lang.String UNREACHABLE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`appliesLocally(Mutation mutation)`
`static AbstractWriteResponseHandler<IMutation>`	`applyCounterMutationOnCoordinator(CounterMutation cm, java.lang.String localDataCenter, Dispatcher.RequestTime requestTime)`
`static AbstractWriteResponseHandler<IMutation>`	`applyCounterMutationOnLeader(CounterMutation cm, java.lang.String localDataCenter, java.lang.Runnable callback, Dispatcher.RequestTime requestTime)`
`static RowIterator`	`cas(java.lang.String keyspaceName, java.lang.String cfName, DecoratedKey key, CASRequest request, ConsistencyLevel consistencyForPaxos, ConsistencyLevel consistencyForCommit, ClientState clientState, long nowInSeconds, Dispatcher.RequestTime requestTime)`	Apply @param updates if and only if the current values in the row for @param key match the provided @param conditions.
`static PartitionIterator`	`concatAndBlockOnRepair(java.util.List<PartitionIterator> iterators, java.util.List<ReadRepair<?,?>> repairs)`
`boolean`	`denylistKey(java.lang.String keyspace, java.lang.String table, java.lang.String partitionKeyAsString)`	Actively denies read and write access to the provided Partition Key
`static java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`describeSchemaVersions(boolean withPort)`	initiate a request/response session with each live node to check whether or not everybody is using the same migration id.
`void`	`disableCheckForDuplicateRowsDuringCompaction()`
`void`	`disableCheckForDuplicateRowsDuringReads()`
`void`	`disableHintsForDC(java.lang.String dc)`
`void`	`disableRepairedDataTrackingForPartitionReads()`
`void`	`disableRepairedDataTrackingForRangeReads()`
`void`	`disableReportingUnconfirmedRepairedDataMismatches()`
`void`	`disableSnapshotOnDuplicateRowDetection()`
`void`	`disableSnapshotOnRepairedDataMismatch()`
`void`	`enableCheckForDuplicateRowsDuringCompaction()`
`void`	`enableCheckForDuplicateRowsDuringReads()`
`void`	`enableHintsForDC(java.lang.String dc)`
`void`	`enableRepairedDataTrackingForPartitionReads()`
`void`	`enableRepairedDataTrackingForRangeReads()`	Tracking and reporting of variances in the repaired data set across replicas at read time
`void`	`enableReportingUnconfirmedRepairedDataMismatches()`
`void`	`enableSnapshotOnDuplicateRowDetection()`
`void`	`enableSnapshotOnRepairedDataMismatch()`
`java.lang.Long`	`getCasContentionTimeout()`
`boolean`	`getCheckForDuplicateRowsDuringCompaction()`
`boolean`	`getCheckForDuplicateRowsDuringReads()`
`boolean`	`getClientRequestSizeMetricsEnabled()`
`java.lang.Long`	`getCounterWriteRpcTimeout()`
`boolean`	`getDumpHeapOnUncaughtException()`
`java.util.Set<java.lang.String>`	`getHintedHandoffDisabledDCs()`
`boolean`	`getHintedHandoffEnabled()`
`int`	`getHintsInProgress()`
`java.lang.String`	`getIdealConsistencyLevel()`
`int`	`getMaxHintsInProgress()`
`int`	`getMaxHintsSizePerHostInMiB()`
`int`	`getMaxHintWindow()`
`java.lang.Long`	`getNativeTransportMaxConcurrentConnections()`
`java.lang.Long`	`getNativeTransportMaxConcurrentConnectionsPerIp()`
`int`	`getNumberOfTables()`
`int`	`getOtcBacklogExpirationInterval()`	Deprecated. See CASSANDRA-15066
`int`	`getPartitionDenylistLoadAttempts()`
`int`	`getPartitionDenylistLoadSuccesses()`
`java.lang.String`	`getPaxosContentionStrategy()`
`boolean`	`getPaxosCoordinatorLockingDisabled()`
`java.lang.String`	`getPaxosVariant()`
`java.lang.Long`	`getRangeRpcTimeout()`
`static PartitionIterator`	`getRangeSlice(PartitionRangeReadCommand command, ConsistencyLevel consistencyLevel, Dispatcher.RequestTime requestTime)`
`long`	`getReadRepairAttempted()`
`long`	`getReadRepairRepairedBackground()`
`long`	`getReadRepairRepairedBlocking()`
`long`	`getReadRepairRepairTimedOut()`
`java.lang.Long`	`getReadRpcTimeout()`
`boolean`	`getRepairedDataTrackingEnabledForPartitionReads()`
`boolean`	`getRepairedDataTrackingEnabledForRangeReads()`
`boolean`	`getReportingUnconfirmedRepairedDataMismatchesEnabled()`
`java.lang.Long`	`getRpcTimeout()`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getSchemaVersions()`	Returns each live node's schema version.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getSchemaVersionsWithPort()`
`boolean`	`getSnapshotOnDuplicateRowDetectionEnabled()`
`boolean`	`getSnapshotOnRepairedDataMismatchEnabled()`
`boolean`	`getSStableReadRatePersistenceEnabled()`
`long`	`getTotalHints()`
`java.lang.Long`	`getTruncateRpcTimeout()`
`boolean`	`getUseStatementsEnabled()`
`java.lang.Long`	`getWriteRpcTimeout()`
`void`	`initialLoadPartitionDenylist()`
`boolean`	`isKeyDenylisted(java.lang.String keyspace, java.lang.String table, java.lang.String partitionKeyAsString)`	A simple check for operators to determine what the denylisted value for a pk is on a node
`boolean`	`isLoggingReadRepairs()`
`static boolean`	`isSafeToPerformRead()`
`static boolean`	`isSafeToPerformRead(java.util.List<SinglePartitionReadCommand> queries)`
`static RowIterator`	`legacyCas(java.lang.String keyspaceName, java.lang.String cfName, DecoratedKey key, CASRequest request, ConsistencyLevel consistencyForPaxos, ConsistencyLevel consistencyForCommit, ClientState clientState, long nowInSeconds, Dispatcher.RequestTime requestTime)`
`void`	`loadPartitionDenylist()`
`void`	`logBlockingReadRepairAttemptsForNSeconds(int seconds)`
`static void`	`logRequestException(java.lang.Exception exception, java.util.Collection<? extends ReadCommand> commands)`
`static void`	`mutate(java.util.List<? extends IMutation> mutations, ConsistencyLevel consistencyLevel, Dispatcher.RequestTime requestTime)`	Use this method to have these Mutations applied across all replicas.
`static void`	`mutateAtomically(java.util.Collection<Mutation> mutations, ConsistencyLevel consistency_level, boolean requireQuorumForRemove, Dispatcher.RequestTime requestTime)`	See mutate.
`static AbstractWriteResponseHandler<IMutation>`	`mutateCounter(CounterMutation cm, java.lang.String localDataCenter, Dispatcher.RequestTime requestTime)`	Handle counter mutation on the coordinator host.
`static void`	`mutateMV(java.nio.ByteBuffer dataKey, java.util.Collection<Mutation> mutations, boolean writeCommitLog, java.util.concurrent.atomic.AtomicLong baseComplete, Dispatcher.RequestTime requestTime)`	Use this method to have these Mutations applied across all replicas.
`static void`	`mutateWithTriggers(java.util.List<? extends IMutation> mutations, ConsistencyLevel consistencyLevel, boolean mutateAtomically, Dispatcher.RequestTime requestTime)`
`static AbstractWriteResponseHandler<IMutation>`	`performWrite(IMutation mutation, ConsistencyLevel consistencyLevel, java.lang.String localDataCenter, StorageProxy.WritePerformer performer, java.lang.Runnable callback, WriteType writeType, Dispatcher.RequestTime requestTime)`	Perform the write of a mutation given a WritePerformer.
`static PartitionIterator`	`read(SinglePartitionReadCommand.Group group, ConsistencyLevel consistencyLevel, Dispatcher.RequestTime requestTime)`	Performs the actual reading of a row out of the StorageService, fetching a specific set of column names from a given column family.
`static RowIterator`	`readOne(SinglePartitionReadCommand command, ConsistencyLevel consistencyLevel, Dispatcher.RequestTime requestTime)`
`static void`	`recordReadRegularAbort(ConsistencyLevel consistencyLevel, java.lang.Throwable cause)`
`void`	`reloadTriggerClasses()`
`boolean`	`removeDenylistKey(java.lang.String keyspace, java.lang.String table, java.lang.String partitionKeyAsString)`	Attempts to remove the provided pk from the ks + table deny list
`static void`	`sendToHintedReplicas(Mutation mutation, ReplicaPlan.ForWrite plan, AbstractWriteResponseHandler<IMutation> responseHandler, java.lang.String localDataCenter, Stage stage, Dispatcher.RequestTime requestTime)`	Send the mutations to the right targets, write it locally if it corresponds or writes a hint when the node is not available.
`void`	`setCasContentionTimeout(java.lang.Long timeoutInMillis)`
`void`	`setClientRequestSizeMetricsEnabled(boolean enabled)`
`void`	`setCounterWriteRpcTimeout(java.lang.Long timeoutInMillis)`
`void`	`setDenylistMaxKeysPerTable(int value)`
`void`	`setDenylistMaxKeysTotal(int value)`
`void`	`setDumpHeapOnUncaughtException(boolean enabled)`
`void`	`setEnableDenylistRangeReads(boolean enabled)`
`void`	`setEnableDenylistReads(boolean enabled)`
`void`	`setEnableDenylistWrites(boolean enabled)`
`void`	`setEnablePartitionDenylist(boolean enabled)`
`void`	`setHintedHandoffEnabled(boolean b)`
`java.lang.String`	`setIdealConsistencyLevel(java.lang.String cl)`
`void`	`setMaxHintsInProgress(int qs)`
`void`	`setMaxHintsSizePerHostInMiB(int value)`
`void`	`setMaxHintWindow(int ms)`
`void`	`setNativeTransportMaxConcurrentConnections(java.lang.Long nativeTransportMaxConcurrentConnections)`
`void`	`setNativeTransportMaxConcurrentConnectionsPerIp(java.lang.Long nativeTransportMaxConcurrentConnections)`
`void`	`setOtcBacklogExpirationInterval(int intervalInMillis)`	Deprecated. See CASSANDRA-15066
`void`	`setPaxosContentionStrategy(java.lang.String spec)`
`void`	`setPaxosCoordinatorLockingDisabled(boolean disabled)`
`void`	`setPaxosVariant(java.lang.String variant)`
`void`	`setRangeRpcTimeout(java.lang.Long timeoutInMillis)`
`void`	`setReadRpcTimeout(java.lang.Long timeoutInMillis)`
`void`	`setRpcTimeout(java.lang.Long timeoutInMillis)`
`void`	`setSStableReadRatePersistenceEnabled(boolean enabled)`
`void`	`setTruncateRpcTimeout(java.lang.Long timeoutInMillis)`
`void`	`setUseStatementsEnabled(boolean enabled)`
`void`	`setWriteRpcTimeout(java.lang.Long timeoutInMillis)`
`static boolean`	`shouldHint(Replica replica)`
`static boolean`	`shouldHint(Replica replica, boolean tryEnablePersistentWindow)`	Determines whether a hint should be stored or not.
`static void`	`submitHint(Mutation mutation, Replica target, AbstractWriteResponseHandler<IMutation> responseHandler)`
`static void`	`truncateBlocking(java.lang.String keyspace, java.lang.String cfname)`	Performs the truncate operatoin, which effectively deletes all data from the column family cfname
`void`	`verifyNoHintsInProgress()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MBEAN_NAME

public static final java.lang.String MBEAN_NAME

See Also:: Constant Field Values

UNREACHABLE

public static final java.lang.String UNREACHABLE

See Also:: Constant Field Values

instance

public static final StorageProxy instance

Method Detail

cas
```
public static RowIterator cas(java.lang.String keyspaceName,
                              java.lang.String cfName,
                              DecoratedKey key,
                              CASRequest request,
                              ConsistencyLevel consistencyForPaxos,
                              ConsistencyLevel consistencyForCommit,
                              ClientState clientState,
                              long nowInSeconds,
                              Dispatcher.RequestTime requestTime)
                       throws UnavailableException,
                              IsBootstrappingException,
                              RequestFailureException,
                              RequestTimeoutException,
                              InvalidRequestException,
                              CasWriteUnknownResultException
```
Apply @param updates if and only if the current values in the row for @param key match the provided @param conditions. The algorithm is "raw" Paxos: that is, Paxos minus leader election -- any node in the cluster may propose changes for any row, which (that is, the row) is the unit of values being proposed, not single columns. The Paxos cohort is only the replicas for the given key, not the entire cluster. So we expect performance to be reasonable, but CAS is still intended to be used "when you really need it," not for all your updates. There are three phases to Paxos: 1. Prepare: the coordinator generates a ballot (timeUUID in our case) and asks replicas to (a) promise not to accept updates from older ballots and (b) tell us about the most recent update it has already accepted. 2. Accept: if a majority of replicas respond, the coordinator asks replicas to accept the value of the highest proposal ballot it heard about, or a new value if no in-progress proposals were reported. 3. Commit (Learn): if a majority of replicas acknowledge the accept request, we can commit the new value. Commit procedure is not covered in "Paxos Made Simple," and only briefly mentioned in "Paxos Made Live," so here is our approach: 3a. The coordinator sends a commit message to all replicas with the ballot and value. 3b. Because of 1-2, this will be the highest-seen commit ballot. The replicas will note that, and send it with subsequent promise replies. This allows us to discard acceptance records for successfully committed replicas, without allowing incomplete proposals to commit erroneously later on. Note that since we are performing a CAS rather than a simple update, we perform a read (of committed values) between the prepare and accept phases. This gives us a slightly longer window for another coordinator to come along and trump our own promise with a newer one but is otherwise safe.

Parameters:

keyspaceName - the keyspace for the CAS

cfName - the column family for the CAS

key - the row key for the row to CAS

request - the conditions for the CAS to apply as well as the update to perform if the conditions hold.

consistencyForPaxos - the consistency for the paxos prepare and propose round. This can only be either SERIAL or LOCAL_SERIAL.

consistencyForCommit - the consistency for write done during the commit phase. This can be anything, except SERIAL or LOCAL_SERIAL.

Returns:

null if the operation succeeds in updating the row, or the current values corresponding to conditions. (since, if the CAS doesn't succeed, it means the current value do not match the conditions).

Throws:

UnavailableException

IsBootstrappingException

RequestFailureException

RequestTimeoutException

InvalidRequestException

CasWriteUnknownResultException

legacyCas

public static RowIterator legacyCas(java.lang.String keyspaceName,
                                    java.lang.String cfName,
                                    DecoratedKey key,
                                    CASRequest request,
                                    ConsistencyLevel consistencyForPaxos,
                                    ConsistencyLevel consistencyForCommit,
                                    ClientState clientState,
                                    long nowInSeconds,
                                    Dispatcher.RequestTime requestTime)
                             throws UnavailableException,
                                    IsBootstrappingException,
                                    RequestFailureException,
                                    RequestTimeoutException,
                                    InvalidRequestException

Throws:: UnavailableException; IsBootstrappingException; RequestFailureException; RequestTimeoutException; InvalidRequestException

mutate

public static void mutate(java.util.List<? extends IMutation> mutations,
                          ConsistencyLevel consistencyLevel,
                          Dispatcher.RequestTime requestTime)
                   throws UnavailableException,
                          OverloadedException,
                          WriteTimeoutException,
                          WriteFailureException

Use this method to have these Mutations applied across all replicas. This method will take care of the possibility of a replica being down and hint the data across to some other replica.

Parameters:: mutations - the mutations to be applied across the replicas; consistencyLevel - the consistency level for the operation; requestTime - object holding times when request got enqueued and started execution
Throws:: UnavailableException; OverloadedException; WriteTimeoutException; WriteFailureException

appliesLocally

public boolean appliesLocally(Mutation mutation)

mutateMV

public static void mutateMV(java.nio.ByteBuffer dataKey,
                            java.util.Collection<Mutation> mutations,
                            boolean writeCommitLog,
                            java.util.concurrent.atomic.AtomicLong baseComplete,
                            Dispatcher.RequestTime requestTime)
                     throws UnavailableException,
                            OverloadedException,
                            WriteTimeoutException

Use this method to have these Mutations applied across all replicas.

Parameters:: mutations - the mutations to be applied across the replicas; writeCommitLog - if commitlog should be written; baseComplete - time from epoch in ms that the local base mutation was(or will be) completed; requestTime - object holding times when request got enqueued and started execution
Throws:: UnavailableException; OverloadedException; WriteTimeoutException

mutateWithTriggers

public static void mutateWithTriggers(java.util.List<? extends IMutation> mutations,
                                      ConsistencyLevel consistencyLevel,
                                      boolean mutateAtomically,
                                      Dispatcher.RequestTime requestTime)
                               throws WriteTimeoutException,
                                      WriteFailureException,
                                      UnavailableException,
                                      OverloadedException,
                                      InvalidRequestException

Throws:: WriteTimeoutException; WriteFailureException; UnavailableException; OverloadedException; InvalidRequestException

mutateAtomically
```
public static void mutateAtomically(java.util.Collection<Mutation> mutations,
                                    ConsistencyLevel consistency_level,
                                    boolean requireQuorumForRemove,
                                    Dispatcher.RequestTime requestTime)
                             throws UnavailableException,
                                    OverloadedException,
                                    WriteTimeoutException
```
See mutate. Adds additional steps before and after writing a batch. Before writing the batch (but after doing availability check against the FD for the row replicas): write the entire batch to a batchlog elsewhere in the cluster. After: remove the batchlog entry (after writing hints for the batch rows, if necessary).

Parameters:

mutations - the Mutations to be applied across the replicas

consistency_level - the consistency level for the operation

requireQuorumForRemove - at least a quorum of nodes will see update before deleting batchlog

requestTime - object holding times when request got enqueued and started execution

Throws:

UnavailableException

OverloadedException

WriteTimeoutException

performWrite

public static AbstractWriteResponseHandler<IMutation> performWrite(IMutation mutation,
                                                                   ConsistencyLevel consistencyLevel,
                                                                   java.lang.String localDataCenter,
                                                                   StorageProxy.WritePerformer performer,
                                                                   java.lang.Runnable callback,
                                                                   WriteType writeType,
                                                                   Dispatcher.RequestTime requestTime)

Perform the write of a mutation given a WritePerformer. Gather the list of write endpoints, apply locally and/or forward the mutation to said write endpoint (deletaged to the actual WritePerformer) and wait for the responses based on consistency level.

Parameters:: mutation - the mutation to be applied; consistencyLevel - the consistency level for the write operation; performer - the WritePerformer in charge of appliying the mutation given the list of write endpoints (either standardWritePerformer for standard writes or counterWritePerformer for counter writes).; callback - an optional callback to be run if and when the write is; requestTime - object holding times when request got enqueued and started execution

sendToHintedReplicas

public static void sendToHintedReplicas(Mutation mutation,
                                        ReplicaPlan.ForWrite plan,
                                        AbstractWriteResponseHandler<IMutation> responseHandler,
                                        java.lang.String localDataCenter,
                                        Stage stage,
                                        Dispatcher.RequestTime requestTime)
                                 throws OverloadedException

Send the mutations to the right targets, write it locally if it corresponds or writes a hint when the node is not available. Note about hints:

 
 | Hinted Handoff | Consist. Level |
 | on             |       >=1      | --> wait for hints. We DO NOT notify the handler with handler.response() for hints;
 | on             |       ANY      | --> wait for hints. Responses count towards consistency.
 | off            |       >=1      | --> DO NOT fire hints. And DO NOT wait for them to complete.
 | off            |       ANY      | --> DO NOT fire hints. And DO NOT wait for them to complete.

Throws:: OverloadedException - if the hints cannot be written/enqueued

mutateCounter
```
public static AbstractWriteResponseHandler<IMutation> mutateCounter(CounterMutation cm,
                                                                    java.lang.String localDataCenter,
                                                                    Dispatcher.RequestTime requestTime)
                                                             throws UnavailableException,
                                                                    OverloadedException
```
Handle counter mutation on the coordinator host. A counter mutation needs to first be applied to a replica (that we'll call the leader for the mutation) before being replicated to the other endpoint. To achieve so, there is two case: 1) the coordinator host is a replica: we proceed to applying the update locally and replicate throug applyCounterMutationOnCoordinator 2) the coordinator is not a replica: we forward the (counter)mutation to a chosen replica (that will proceed through applyCounterMutationOnLeader upon receive) and wait for its acknowledgment. Implementation note: We check if we can fulfill the CL on the coordinator host even if he is not a replica to allow quicker response and because the WriteResponseHandlers don't make it easy to send back an error. We also always gather the write latencies at the coordinator node to make gathering point similar to the case of standard writes.

Throws:

UnavailableException

OverloadedException

applyCounterMutationOnLeader

public static AbstractWriteResponseHandler<IMutation> applyCounterMutationOnLeader(CounterMutation cm,
                                                                                   java.lang.String localDataCenter,
                                                                                   java.lang.Runnable callback,
                                                                                   Dispatcher.RequestTime requestTime)
                                                                            throws UnavailableException,
                                                                                   OverloadedException

Throws:: UnavailableException; OverloadedException

applyCounterMutationOnCoordinator

public static AbstractWriteResponseHandler<IMutation> applyCounterMutationOnCoordinator(CounterMutation cm,
                                                                                        java.lang.String localDataCenter,
                                                                                        Dispatcher.RequestTime requestTime)
                                                                                 throws UnavailableException,
                                                                                        OverloadedException

Throws:: UnavailableException; OverloadedException

readOne

public static RowIterator readOne(SinglePartitionReadCommand command,
                                  ConsistencyLevel consistencyLevel,
                                  Dispatcher.RequestTime requestTime)
                           throws UnavailableException,
                                  IsBootstrappingException,
                                  ReadFailureException,
                                  ReadTimeoutException,
                                  InvalidRequestException

Throws:: UnavailableException; IsBootstrappingException; ReadFailureException; ReadTimeoutException; InvalidRequestException

read

public static PartitionIterator read(SinglePartitionReadCommand.Group group,
                                     ConsistencyLevel consistencyLevel,
                                     Dispatcher.RequestTime requestTime)
                              throws UnavailableException,
                                     IsBootstrappingException,
                                     ReadFailureException,
                                     ReadTimeoutException,
                                     InvalidRequestException

Performs the actual reading of a row out of the StorageService, fetching a specific set of column names from a given column family.

Throws:: UnavailableException; IsBootstrappingException; ReadFailureException; ReadTimeoutException; InvalidRequestException

isSafeToPerformRead

public static boolean isSafeToPerformRead(java.util.List<SinglePartitionReadCommand> queries)

isSafeToPerformRead

public static boolean isSafeToPerformRead()

recordReadRegularAbort

public static void recordReadRegularAbort(ConsistencyLevel consistencyLevel,
                                          java.lang.Throwable cause)

concatAndBlockOnRepair

public static PartitionIterator concatAndBlockOnRepair(java.util.List<PartitionIterator> iterators,
                                                       java.util.List<ReadRepair<?,?>> repairs)

getRangeSlice

public static PartitionIterator getRangeSlice(PartitionRangeReadCommand command,
                                              ConsistencyLevel consistencyLevel,
                                              Dispatcher.RequestTime requestTime)

getSchemaVersions
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSchemaVersions()
```
Description copied from interface: StorageProxyMBean

Returns each live node's schema version.

Specified by:

getSchemaVersions in interface StorageProxyMBean

getSchemaVersionsWithPort

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSchemaVersionsWithPort()

Specified by:: getSchemaVersionsWithPort in interface StorageProxyMBean

describeSchemaVersions
```
public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> describeSchemaVersions(boolean withPort)
```
initiate a request/response session with each live node to check whether or not everybody is using the same migration id. This is useful for determining if a schema change has propagated through the cluster. Disagreement is assumed if any node fails to respond.

getHintedHandoffEnabled
```
public boolean getHintedHandoffEnabled()
```
Specified by:

getHintedHandoffEnabled in interface StorageProxyMBean

setHintedHandoffEnabled
```
public void setHintedHandoffEnabled(boolean b)
```
Specified by:

setHintedHandoffEnabled in interface StorageProxyMBean

enableHintsForDC
```
public void enableHintsForDC(java.lang.String dc)
```
Specified by:

enableHintsForDC in interface StorageProxyMBean

disableHintsForDC
```
public void disableHintsForDC(java.lang.String dc)
```
Specified by:

disableHintsForDC in interface StorageProxyMBean

getHintedHandoffDisabledDCs
```
public java.util.Set<java.lang.String> getHintedHandoffDisabledDCs()
```
Specified by:

getHintedHandoffDisabledDCs in interface StorageProxyMBean

getMaxHintWindow
```
public int getMaxHintWindow()
```
Specified by:

getMaxHintWindow in interface StorageProxyMBean

setMaxHintWindow
```
public void setMaxHintWindow(int ms)
```
Specified by:

setMaxHintWindow in interface StorageProxyMBean

getMaxHintsSizePerHostInMiB
```
public int getMaxHintsSizePerHostInMiB()
```
Specified by:

getMaxHintsSizePerHostInMiB in interface StorageProxyMBean

setMaxHintsSizePerHostInMiB
```
public void setMaxHintsSizePerHostInMiB(int value)
```
Specified by:

setMaxHintsSizePerHostInMiB in interface StorageProxyMBean

shouldHint

public static boolean shouldHint(Replica replica)

shouldHint
```
public static boolean shouldHint(Replica replica,
                                 boolean tryEnablePersistentWindow)
```
Determines whether a hint should be stored or not. It rejects early if any of the condition is met: - Hints disabled entirely or for the belonging datacetner of the replica - The replica is transient or is the self node - The replica is no longer part of the ring - The hint window has expired - The hints have reached to the size limit for the node Otherwise, it permits.

Parameters:

replica - the replica for the hint

tryEnablePersistentWindow - true to consider hint_window_persistent_enabled; otherwise, ignores

Returns:

true to permit or false to reject hint

truncateBlocking

public static void truncateBlocking(java.lang.String keyspace,
                                    java.lang.String cfname)
                             throws UnavailableException,
                                    java.util.concurrent.TimeoutException

Performs the truncate operatoin, which effectively deletes all data from the column family cfname

Parameters:: keyspace -; cfname -
Throws:: UnavailableException - If some of the hosts in the ring are down.; java.util.concurrent.TimeoutException

logRequestException

public static void logRequestException(java.lang.Exception exception,
                                       java.util.Collection<? extends ReadCommand> commands)

getTotalHints
```
public long getTotalHints()
```
Specified by:

getTotalHints in interface StorageProxyMBean

getMaxHintsInProgress
```
public int getMaxHintsInProgress()
```
Specified by:

getMaxHintsInProgress in interface StorageProxyMBean

setMaxHintsInProgress
```
public void setMaxHintsInProgress(int qs)
```
Specified by:

setMaxHintsInProgress in interface StorageProxyMBean

getHintsInProgress
```
public int getHintsInProgress()
```
Specified by:

getHintsInProgress in interface StorageProxyMBean

verifyNoHintsInProgress
```
public void verifyNoHintsInProgress()
```

submitHint

public static void submitHint(Mutation mutation,
                              Replica target,
                              AbstractWriteResponseHandler<IMutation> responseHandler)

getRpcTimeout
```
public java.lang.Long getRpcTimeout()
```
Specified by:

getRpcTimeout in interface StorageProxyMBean

setRpcTimeout
```
public void setRpcTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setRpcTimeout in interface StorageProxyMBean

getReadRpcTimeout
```
public java.lang.Long getReadRpcTimeout()
```
Specified by:

getReadRpcTimeout in interface StorageProxyMBean

setReadRpcTimeout
```
public void setReadRpcTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setReadRpcTimeout in interface StorageProxyMBean

getWriteRpcTimeout
```
public java.lang.Long getWriteRpcTimeout()
```
Specified by:

getWriteRpcTimeout in interface StorageProxyMBean

setWriteRpcTimeout
```
public void setWriteRpcTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setWriteRpcTimeout in interface StorageProxyMBean

getCounterWriteRpcTimeout
```
public java.lang.Long getCounterWriteRpcTimeout()
```
Specified by:

getCounterWriteRpcTimeout in interface StorageProxyMBean

setCounterWriteRpcTimeout
```
public void setCounterWriteRpcTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setCounterWriteRpcTimeout in interface StorageProxyMBean

getCasContentionTimeout
```
public java.lang.Long getCasContentionTimeout()
```
Specified by:

getCasContentionTimeout in interface StorageProxyMBean

setCasContentionTimeout
```
public void setCasContentionTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setCasContentionTimeout in interface StorageProxyMBean

getRangeRpcTimeout
```
public java.lang.Long getRangeRpcTimeout()
```
Specified by:

getRangeRpcTimeout in interface StorageProxyMBean

setRangeRpcTimeout
```
public void setRangeRpcTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setRangeRpcTimeout in interface StorageProxyMBean

getTruncateRpcTimeout
```
public java.lang.Long getTruncateRpcTimeout()
```
Specified by:

getTruncateRpcTimeout in interface StorageProxyMBean

setTruncateRpcTimeout
```
public void setTruncateRpcTimeout(java.lang.Long timeoutInMillis)
```
Specified by:

setTruncateRpcTimeout in interface StorageProxyMBean

getNativeTransportMaxConcurrentConnections
```
public java.lang.Long getNativeTransportMaxConcurrentConnections()
```
Specified by:

getNativeTransportMaxConcurrentConnections in interface StorageProxyMBean

setNativeTransportMaxConcurrentConnections
```
public void setNativeTransportMaxConcurrentConnections(java.lang.Long nativeTransportMaxConcurrentConnections)
```
Specified by:

setNativeTransportMaxConcurrentConnections in interface StorageProxyMBean

getNativeTransportMaxConcurrentConnectionsPerIp

public java.lang.Long getNativeTransportMaxConcurrentConnectionsPerIp()

setNativeTransportMaxConcurrentConnectionsPerIp

public void setNativeTransportMaxConcurrentConnectionsPerIp(java.lang.Long nativeTransportMaxConcurrentConnections)

reloadTriggerClasses
```
public void reloadTriggerClasses()
```
Specified by:

reloadTriggerClasses in interface StorageProxyMBean

getReadRepairAttempted
```
public long getReadRepairAttempted()
```
Specified by:

getReadRepairAttempted in interface StorageProxyMBean

getReadRepairRepairedBlocking
```
public long getReadRepairRepairedBlocking()
```
Specified by:

getReadRepairRepairedBlocking in interface StorageProxyMBean

getReadRepairRepairedBackground
```
public long getReadRepairRepairedBackground()
```
Specified by:

getReadRepairRepairedBackground in interface StorageProxyMBean

getReadRepairRepairTimedOut
```
public long getReadRepairRepairTimedOut()
```
Specified by:

getReadRepairRepairTimedOut in interface StorageProxyMBean

getNumberOfTables
```
public int getNumberOfTables()
```
Specified by:

getNumberOfTables in interface StorageProxyMBean

getIdealConsistencyLevel
```
public java.lang.String getIdealConsistencyLevel()
```
Specified by:

getIdealConsistencyLevel in interface StorageProxyMBean

setIdealConsistencyLevel
```
public java.lang.String setIdealConsistencyLevel(java.lang.String cl)
```
Specified by:

setIdealConsistencyLevel in interface StorageProxyMBean

getOtcBacklogExpirationInterval
```
@Deprecated(since="4.0")
public int getOtcBacklogExpirationInterval()
```
Deprecated.
See CASSANDRA-15066

Specified by:

getOtcBacklogExpirationInterval in interface StorageProxyMBean

setOtcBacklogExpirationInterval
```
@Deprecated(since="4.0")
public void setOtcBacklogExpirationInterval(int intervalInMillis)
```
Deprecated.
See CASSANDRA-15066

Specified by:

setOtcBacklogExpirationInterval in interface StorageProxyMBean

enableRepairedDataTrackingForRangeReads
```
public void enableRepairedDataTrackingForRangeReads()
```
Description copied from interface: StorageProxyMBean

Tracking and reporting of variances in the repaired data set across replicas at read time

Specified by:

enableRepairedDataTrackingForRangeReads in interface StorageProxyMBean

disableRepairedDataTrackingForRangeReads
```
public void disableRepairedDataTrackingForRangeReads()
```
Specified by:

disableRepairedDataTrackingForRangeReads in interface StorageProxyMBean

getRepairedDataTrackingEnabledForRangeReads
```
public boolean getRepairedDataTrackingEnabledForRangeReads()
```
Specified by:

getRepairedDataTrackingEnabledForRangeReads in interface StorageProxyMBean

enableRepairedDataTrackingForPartitionReads
```
public void enableRepairedDataTrackingForPartitionReads()
```
Specified by:

enableRepairedDataTrackingForPartitionReads in interface StorageProxyMBean

disableRepairedDataTrackingForPartitionReads
```
public void disableRepairedDataTrackingForPartitionReads()
```
Specified by:

disableRepairedDataTrackingForPartitionReads in interface StorageProxyMBean

getRepairedDataTrackingEnabledForPartitionReads
```
public boolean getRepairedDataTrackingEnabledForPartitionReads()
```
Specified by:

getRepairedDataTrackingEnabledForPartitionReads in interface StorageProxyMBean

enableReportingUnconfirmedRepairedDataMismatches
```
public void enableReportingUnconfirmedRepairedDataMismatches()
```
Specified by:

enableReportingUnconfirmedRepairedDataMismatches in interface StorageProxyMBean

disableReportingUnconfirmedRepairedDataMismatches
```
public void disableReportingUnconfirmedRepairedDataMismatches()
```
Specified by:

disableReportingUnconfirmedRepairedDataMismatches in interface StorageProxyMBean

getReportingUnconfirmedRepairedDataMismatchesEnabled
```
public boolean getReportingUnconfirmedRepairedDataMismatchesEnabled()
```
Specified by:

getReportingUnconfirmedRepairedDataMismatchesEnabled in interface StorageProxyMBean

getSnapshotOnRepairedDataMismatchEnabled
```
public boolean getSnapshotOnRepairedDataMismatchEnabled()
```
Specified by:

getSnapshotOnRepairedDataMismatchEnabled in interface StorageProxyMBean

enableSnapshotOnRepairedDataMismatch
```
public void enableSnapshotOnRepairedDataMismatch()
```
Specified by:

enableSnapshotOnRepairedDataMismatch in interface StorageProxyMBean

disableSnapshotOnRepairedDataMismatch
```
public void disableSnapshotOnRepairedDataMismatch()
```
Specified by:

disableSnapshotOnRepairedDataMismatch in interface StorageProxyMBean

getSnapshotOnDuplicateRowDetectionEnabled
```
public boolean getSnapshotOnDuplicateRowDetectionEnabled()
```
Specified by:

getSnapshotOnDuplicateRowDetectionEnabled in interface StorageProxyMBean

enableSnapshotOnDuplicateRowDetection
```
public void enableSnapshotOnDuplicateRowDetection()
```
Specified by:

enableSnapshotOnDuplicateRowDetection in interface StorageProxyMBean

disableSnapshotOnDuplicateRowDetection
```
public void disableSnapshotOnDuplicateRowDetection()
```
Specified by:

disableSnapshotOnDuplicateRowDetection in interface StorageProxyMBean

getCheckForDuplicateRowsDuringReads
```
public boolean getCheckForDuplicateRowsDuringReads()
```
Specified by:

getCheckForDuplicateRowsDuringReads in interface StorageProxyMBean

enableCheckForDuplicateRowsDuringReads
```
public void enableCheckForDuplicateRowsDuringReads()
```
Specified by:

enableCheckForDuplicateRowsDuringReads in interface StorageProxyMBean

disableCheckForDuplicateRowsDuringReads
```
public void disableCheckForDuplicateRowsDuringReads()
```
Specified by:

disableCheckForDuplicateRowsDuringReads in interface StorageProxyMBean

getCheckForDuplicateRowsDuringCompaction
```
public boolean getCheckForDuplicateRowsDuringCompaction()
```
Specified by:

getCheckForDuplicateRowsDuringCompaction in interface StorageProxyMBean

enableCheckForDuplicateRowsDuringCompaction
```
public void enableCheckForDuplicateRowsDuringCompaction()
```
Specified by:

enableCheckForDuplicateRowsDuringCompaction in interface StorageProxyMBean

disableCheckForDuplicateRowsDuringCompaction
```
public void disableCheckForDuplicateRowsDuringCompaction()
```
Specified by:

disableCheckForDuplicateRowsDuringCompaction in interface StorageProxyMBean

initialLoadPartitionDenylist

public void initialLoadPartitionDenylist()

loadPartitionDenylist
```
public void loadPartitionDenylist()
```
Specified by:

loadPartitionDenylist in interface StorageProxyMBean

getPartitionDenylistLoadAttempts
```
public int getPartitionDenylistLoadAttempts()
```
Specified by:

getPartitionDenylistLoadAttempts in interface StorageProxyMBean

getPartitionDenylistLoadSuccesses
```
public int getPartitionDenylistLoadSuccesses()
```
Specified by:

getPartitionDenylistLoadSuccesses in interface StorageProxyMBean

setEnablePartitionDenylist
```
public void setEnablePartitionDenylist(boolean enabled)
```
Specified by:

setEnablePartitionDenylist in interface StorageProxyMBean

setEnableDenylistWrites
```
public void setEnableDenylistWrites(boolean enabled)
```
Specified by:

setEnableDenylistWrites in interface StorageProxyMBean

setEnableDenylistReads
```
public void setEnableDenylistReads(boolean enabled)
```
Specified by:

setEnableDenylistReads in interface StorageProxyMBean

setEnableDenylistRangeReads
```
public void setEnableDenylistRangeReads(boolean enabled)
```
Specified by:

setEnableDenylistRangeReads in interface StorageProxyMBean

setDenylistMaxKeysPerTable
```
public void setDenylistMaxKeysPerTable(int value)
```
Specified by:

setDenylistMaxKeysPerTable in interface StorageProxyMBean

setDenylistMaxKeysTotal
```
public void setDenylistMaxKeysTotal(int value)
```
Specified by:

setDenylistMaxKeysTotal in interface StorageProxyMBean

denylistKey
```
public boolean denylistKey(java.lang.String keyspace,
                           java.lang.String table,
                           java.lang.String partitionKeyAsString)
```
Actively denies read and write access to the provided Partition Key

Specified by:

denylistKey in interface StorageProxyMBean

Parameters:

keyspace - Name of keyspace containing the PK you wish to deny access to

table - Name of table containing the PK you wish to deny access to

partitionKeyAsString - String representation of the PK you want to deny access to

Returns:

true if successfully added, false if failure

removeDenylistKey
```
public boolean removeDenylistKey(java.lang.String keyspace,
                                 java.lang.String table,
                                 java.lang.String partitionKeyAsString)
```
Attempts to remove the provided pk from the ks + table deny list

Specified by:

removeDenylistKey in interface StorageProxyMBean

Parameters:

keyspace - Keyspace containing the pk to remove the denylist entry for

table - Table containing the pk to remove denylist entry for

partitionKeyAsString - String representation of the PK you want to re-allow access to

Returns:

true if found and removed, false if not

isKeyDenylisted

public boolean isKeyDenylisted(java.lang.String keyspace,
                               java.lang.String table,
                               java.lang.String partitionKeyAsString)

A simple check for operators to determine what the denylisted value for a pk is on a node

Specified by:: isKeyDenylisted in interface StorageProxyMBean

logBlockingReadRepairAttemptsForNSeconds
```
public void logBlockingReadRepairAttemptsForNSeconds(int seconds)
```
Specified by:

logBlockingReadRepairAttemptsForNSeconds in interface StorageProxyMBean

isLoggingReadRepairs
```
public boolean isLoggingReadRepairs()
```
Specified by:

isLoggingReadRepairs in interface StorageProxyMBean

setPaxosVariant
```
public void setPaxosVariant(java.lang.String variant)
```
Specified by:

setPaxosVariant in interface StorageProxyMBean

getPaxosVariant
```
public java.lang.String getPaxosVariant()
```
Specified by:

getPaxosVariant in interface StorageProxyMBean

getUseStatementsEnabled
```
public boolean getUseStatementsEnabled()
```
Specified by:

getUseStatementsEnabled in interface StorageProxyMBean

setUseStatementsEnabled
```
public void setUseStatementsEnabled(boolean enabled)
```
Specified by:

setUseStatementsEnabled in interface StorageProxyMBean

setPaxosContentionStrategy
```
public void setPaxosContentionStrategy(java.lang.String spec)
```
Specified by:

setPaxosContentionStrategy in interface StorageProxyMBean

getPaxosContentionStrategy
```
public java.lang.String getPaxosContentionStrategy()
```
Specified by:

getPaxosContentionStrategy in interface StorageProxyMBean

setPaxosCoordinatorLockingDisabled
```
public void setPaxosCoordinatorLockingDisabled(boolean disabled)
```
Specified by:

setPaxosCoordinatorLockingDisabled in interface StorageProxyMBean

getPaxosCoordinatorLockingDisabled
```
public boolean getPaxosCoordinatorLockingDisabled()
```
Specified by:

getPaxosCoordinatorLockingDisabled in interface StorageProxyMBean

getDumpHeapOnUncaughtException
```
public boolean getDumpHeapOnUncaughtException()
```
Specified by:

getDumpHeapOnUncaughtException in interface StorageProxyMBean

setDumpHeapOnUncaughtException
```
public void setDumpHeapOnUncaughtException(boolean enabled)
```
Specified by:

setDumpHeapOnUncaughtException in interface StorageProxyMBean

getSStableReadRatePersistenceEnabled
```
public boolean getSStableReadRatePersistenceEnabled()
```
Specified by:

getSStableReadRatePersistenceEnabled in interface StorageProxyMBean

setSStableReadRatePersistenceEnabled
```
public void setSStableReadRatePersistenceEnabled(boolean enabled)
```
Specified by:

setSStableReadRatePersistenceEnabled in interface StorageProxyMBean

getClientRequestSizeMetricsEnabled
```
public boolean getClientRequestSizeMetricsEnabled()
```
Specified by:

getClientRequestSizeMetricsEnabled in interface StorageProxyMBean

setClientRequestSizeMetricsEnabled
```
public void setClientRequestSizeMetricsEnabled(boolean enabled)
```
Specified by:

setClientRequestSizeMetricsEnabled in interface StorageProxyMBean

Modifier and Type	Class	Description
`static class`	`StorageProxy.LocalReadRunnable`
`static interface`	`StorageProxy.WritePerformer`

Modifier and Type	Field	Description
`static StorageProxy`	`instance`
`static java.lang.String`	`MBEAN_NAME`
`static java.lang.String`	`UNREACHABLE`

Class StorageProxy

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MBEAN_NAME

UNREACHABLE

instance

Method Detail

cas

legacyCas

mutate

appliesLocally

mutateMV

mutateWithTriggers

mutateAtomically

performWrite

sendToHintedReplicas

mutateCounter

applyCounterMutationOnLeader

applyCounterMutationOnCoordinator

readOne

read

isSafeToPerformRead

isSafeToPerformRead

recordReadRegularAbort

concatAndBlockOnRepair

getRangeSlice

getSchemaVersions

getSchemaVersionsWithPort

describeSchemaVersions

getHintedHandoffEnabled

setHintedHandoffEnabled

enableHintsForDC

disableHintsForDC

getHintedHandoffDisabledDCs

getMaxHintWindow

setMaxHintWindow

getMaxHintsSizePerHostInMiB

setMaxHintsSizePerHostInMiB

shouldHint

shouldHint

truncateBlocking

logRequestException

getTotalHints

getMaxHintsInProgress

setMaxHintsInProgress

getHintsInProgress

verifyNoHintsInProgress

submitHint

getRpcTimeout

setRpcTimeout

getReadRpcTimeout

setReadRpcTimeout

getWriteRpcTimeout

setWriteRpcTimeout

getCounterWriteRpcTimeout

setCounterWriteRpcTimeout

getCasContentionTimeout

setCasContentionTimeout

getRangeRpcTimeout

setRangeRpcTimeout

getTruncateRpcTimeout

setTruncateRpcTimeout

getNativeTransportMaxConcurrentConnections

setNativeTransportMaxConcurrentConnections

getNativeTransportMaxConcurrentConnectionsPerIp

setNativeTransportMaxConcurrentConnectionsPerIp

reloadTriggerClasses

getReadRepairAttempted

getReadRepairRepairedBlocking

getReadRepairRepairedBackground

getReadRepairRepairTimedOut

getNumberOfTables

getIdealConsistencyLevel

setIdealConsistencyLevel

getOtcBacklogExpirationInterval

setOtcBacklogExpirationInterval

enableRepairedDataTrackingForRangeReads