Package org.apache.cassandra.config
Enum Class CassandraRelevantProperties
- All Implemented Interfaces:
Serializable,Comparable<CassandraRelevantProperties>,Constable
A class that extracts system properties for the cassandra node it runs within.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceNested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIf we should allow having duplicate keys in the config file, default to true for legacy reasonsIf we should allow having both new (post CASSANDRA-15234) and old config keys for the same config item in the yaml2 ** GENSALT_LOG2_ROUNDS rounds of hashing will be performed.We expect default values on cache retries and interval to be sufficient for everyone but have this escape hatch just in case.When true, checks that all nodes are above the minimum supported version before running auto-repairWhen false, completely disables the auto-repair feature including schema changes and JMX registrationWhen bootstraping how long to wait for schema versions to be seen.When bootstraping we wait for all schema versions found in gossip to be seen, and if not seen in time we fail the bootstrap; this property will avoid failing and allow bootstrap to continue if set to true.Represents the maximum size (in bytes) of a serialized mutation that can be cachedThe classpath storage configuration file.The cassandra-foreground option will tell CassandraDaemon whether to close stdout/stderr, but it's up to us not to background.Cassandra jmx remote and local portdefault heartbeating period is 1 minuteThis property indicates the location for the access file.This property indicates whether password authentication for remote monitoring is enabled.This property indicates the path to the password file - com.sun.management.jmxremote.password.filePort number to enable JMX RMI connections - com.sun.management.jmxremote.portThe port number to which the RMI connector will be bound - com.sun.management.jmxremote.rmi.port.This property indicates whether SSL is enabled for monitoring remotely.A comma-delimited list of SSL/TLS cipher suites to enable.A comma-delimited list of SSL/TLS protocol versions to enable.This property indicates whether SSL client authentication is enabled - com.sun.management.jmxremote.ssl.need.client.auth.Entities to replay mutations for upon commit log replay, property is meant to contain comma-separated entities which are either names of keyspaces or keyspaces and tables or their mix.Defaults to false for 4.1 but plan to switch to true in a later release the thinking is that environments may not work right off the bat so safer to add this feature disabled by defaultControls the type of bufffer (heap/direct) used for shared scratch buffersdeterminism properties for testingproperties to disable certain behaviours for testingproperty for the rate of the scheduled task that monitors disk usageproperty for the interval on which the repeated client warnings and diagnostic events about disk usage are ignoredWhen draining, how long to wait for mutating executors to shutdown.This property indicates if the code is running under the in-jvm dtest frameworkIn_JVM dtest property indicating that the test should use "latest" configurationWhetherConsistencyLevel.NODE_LOCALshould be allowed.Deprecated.See CASSANDRA-17797Deprecated.See CASSANDRA-17797Deprecated.See CASSANDRA-17797Used when running in Client mode and the system and schema keyspaces need to be initialized outside of their normal initialization pathDelay before checking if gossip is settled.Interval delay between checking gossip is settled.Number of polls without gossip state change to consider gossip as settled.Gossip quarantine delay is used while evaluating membership changes and should only be changed with extreme care.Deprecated.See CASSANDRA-17797Deprecated.See CASSANDRA-17797Java class path.Indicates the temporary directory used by the Java Virtual Machine (JVM) to create and store temporary files.Path from which to load native libraries.Controls the distributed garbage collector lease time for JMX objects.The value of this property represents the host name string that should be associated with remote stubs for locally created remote objects, in order to allow clients to invoke methods on the remote object.If this value is true, object identifiers for remote objects exported by this VM will be generated by using a cryptographically secure random number generator.Java Runtime Environment versionJava Virtual Machine implementation namestartup checks propertiesLine separator ("\n" on UNIX).Load persistence ring state.Directory where Cassandra puts its logs, defaults to "." which is current directory.Directory where Cassandra persists logs from audit logging.Maximum number of rows in system_views.logs tableLoosen the definition of "empty" for gossip state, for use during host replacements if things go awrywhat class to use for mbean registerationDefines the maximum number of unique timed out queries that will be reported in the logs.Defines the interval for reporting any operations that have timed out.mx4jaddressmx4jportThis is the port used with RPC address for the native protocol to communicate with clients.If set,MessagingServiceis shutdown abrtuptly without waiting for anything.This property indicates whether disable_mbean_registration is trueOperating system architecture.Operating system name.Enabled/disable TCP_NODELAY for intradc connections.When doing a host replacement its possible that the gossip state is "empty" meaning that the endpoint is known but the current state isn't known.Number of replicas required to store batchlog for atomicity, only accepts values of 1 or 2.Whether we reset any found data from previously run bootstraps.How often a role's password can be changedControls the maximum number of index query intersections that will take part in a queryLatest version to be used for SAI index writingMinimum number of reachable leaves for a given node to be eligible for an auxiliary posting listSkip, or the sampling interval, for selecting a balanced tree level that is eligible for an auxiliary posting list.Used to determine the block size and block mask for the clustering sorted terms.Used to determine the block size and block mask for the partition sorted terms.Whether to allow the user to specify custom options to the hnsw indexThe maximum number of primary keys that a WHERE clause may materialize before the query planner switches from a search-then-sort execution strategy to an order-by-then-filter strategy.Controls the maximum top-k limit for vector searchThe maximum number of seeds returned by a seed provider before emmitting a warning.Do not try to calculate optimal streaming candidates.If necessary for operational purposes, permit certain keyspaces to be ignored for paxos topology repairs.snapshots ttl cleanup initial delay in secondssnapshots ttl cleanup period in secondsminimum allowed TTL for snapshotsPlatform word size sun.arch.data.model.Controls the JMX server threadpool keap-alive time.A property for various mechanisms for syncing files that makes it possible it intercept and skip syncing.Flush changes ofSchemaKeyspaceafter each schema modification.properties for debugging simulator ASM outputStorageCompatibilityModemode sets how the node will behave, sstable or messaging versions to use etc.Turns some warnings into exceptions for testing.Not to be used in production, this causes a Netty logging handler to be added to the pipeline, which will throttle a system under any normal load.Activate write survey mode.When enabled, recursive directory deletion will be executed using a unix command `rm -rf` instead of traversing and removing individual files.User's home directory.Gossiper compute expiration timeout.Controls output format for Collection-type settings in system_views.settings table -
Method Summary
Modifier and TypeMethodDescriptionvoidClears the value set in the system property.<T> Tconvert(CassandraRelevantProperties.PropertyConverter<T> converter) static StringconvertToString(Object value) booleanGets the value of a system property as a boolean.booleangetBoolean(boolean overrideDefaultValue) Gets the value of a system property as a boolean.Returns default value.doubleGets the value of a system property as a double.doublegetDouble(double overrideDefaultValue) Gets the value of a system property as a double.<T extends Enum<T>>
TGets the value of a system property as an enum, optionally callingString.toUpperCase()first.<T extends Enum<T>>
TgetEnum(boolean toUppercase, T defaultValue) Gets the value of a system property as a enum, optionally callingString.toUpperCase()first.<T extends Enum<T>>
TgetEnum(T defaultValue) Gets the value of a system property as a enum, callingString.toUpperCase()first.intgetInt()Gets the value of a system property as a int.intgetInt(int overrideDefaultValue) Gets the value of a system property as an int.getKey()longgetLong()Gets the value of a system property as a long.longgetLong(long overrideDefaultValue) Gets the value of a system property as a long.longGets the value of a system property, given as a human-readable size in bytes (e.g.longgetSizeInBytes(long overrideDefaultValue) Gets the value of a system property, given as a human-readable size in bytes (e.g.Gets the value of the indicated system property.Gets the value of a system property as a String.booleanvoidreset()Sets the property to its default value if a default value was specified.setBoolean(boolean value) Sets the value into system properties.voidSets the value into system properties.setInt(int value) Sets the value into system properties.setLong(long value) Sets the value into system properties.Sets the value into system properties.static CassandraRelevantPropertiesReturns the enum constant of this class with the specified name.static CassandraRelevantProperties[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ACQUIRE_RETRY_SECONDS
-
ACQUIRE_SLEEP_MS
-
ALLOCATE_TOKENS_FOR_KEYSPACE
-
ALLOW_ALTER_RF_DURING_RANGE_MOVEMENT
-
ALLOW_DUPLICATE_CONFIG_KEYS
If we should allow having duplicate keys in the config file, default to true for legacy reasons -
ALLOW_NEW_OLD_CONFIG_KEYS
If we should allow having both new (post CASSANDRA-15234) and old config keys for the same config item in the yaml -
ALLOW_UNLIMITED_CONCURRENT_VALIDATIONS
-
ALLOW_UNSAFE_AGGRESSIVE_SSTABLE_EXPIRATION
-
ALLOW_UNSAFE_JOIN
-
ALLOW_UNSAFE_REPLACE
-
ALLOW_UNSAFE_TRANSIENT_CHANGES
-
APPROXIMATE_TIME_PRECISION_MS
-
AUTH_BCRYPT_GENSALT_LOG2_ROUNDS
2 ** GENSALT_LOG2_ROUNDS rounds of hashing will be performed. -
AUTH_CACHE_WARMING_MAX_RETRIES
We expect default values on cache retries and interval to be sufficient for everyone but have this escape hatch just in case. -
AUTH_CACHE_WARMING_RETRY_INTERVAL_MS
-
AUTOCOMPACTION_ON_STARTUP_ENABLED
-
AUTOREPAIR_CHECK_MIN_VERSION
When true, checks that all nodes are above the minimum supported version before running auto-repair -
AUTOREPAIR_ENABLE
When false, completely disables the auto-repair feature including schema changes and JMX registration -
AUTO_BOOTSTRAP
-
AUTO_REPAIR_FREQUENCY_SECONDS
-
BATCHLOG_REPLAY_TIMEOUT_IN_MS
-
BATCH_COMMIT_LOG_SYNC_INTERVAL
-
BOOTSTRAP_SCHEMA_DELAY_MS
When bootstraping how long to wait for schema versions to be seen. -
BOOTSTRAP_SKIP_SCHEMA_CHECK
When bootstraping we wait for all schema versions found in gossip to be seen, and if not seen in time we fail the bootstrap; this property will avoid failing and allow bootstrap to continue if set to true. -
BROADCAST_INTERVAL_MS
-
BTREE_BRANCH_SHIFT
-
BTREE_FAN_FACTOR
-
CACHEABLE_MUTATION_SIZE_LIMIT
Represents the maximum size (in bytes) of a serialized mutation that can be cached -
CASSANDRA_ALLOW_SIMPLE_STRATEGY
-
CASSANDRA_AVAILABLE_PROCESSORS
-
CASSANDRA_CONFIG
The classpath storage configuration file. -
CASSANDRA_FOREGROUND
The cassandra-foreground option will tell CassandraDaemon whether to close stdout/stderr, but it's up to us not to background. yes/null -
CASSANDRA_JMX_AUTHORIZER
-
CASSANDRA_JMX_LOCAL_PORT
-
CASSANDRA_JMX_REMOTE_LOGIN_CONFIG
-
CASSANDRA_JMX_REMOTE_PORT
Cassandra jmx remote and local port -
CASSANDRA_MAX_HINT_TTL
-
CASSANDRA_MINIMUM_REPLICATION_FACTOR
-
CASSANDRA_NETTY_USE_HEAP_ALLOCATOR
-
CASSANDRA_PID_FILE
-
CASSANDRA_RACKDC_PROPERTIES
-
CASSANDRA_SKIP_AUTOMATIC_UDT_FIX
-
CASSANDRA_STREAMING_DEBUG_STACKTRACE_LIMIT
-
CASSANDRA_UNSAFE_TIME_UUID_NODE
-
CASSANDRA_VERSION
-
CHECK_DATA_RESURRECTION_HEARTBEAT_PERIOD
default heartbeating period is 1 minute -
CHRONICLE_ANALYTICS_DISABLE
-
CHRONICLE_ANNOUNCER_DISABLE
-
CLOCK_GLOBAL
-
CLOCK_MONOTONIC_APPROX
-
CLOCK_MONOTONIC_PRECISE
-
COMMITLOG_ALLOW_IGNORE_SYNC_CRC
-
COMMITLOG_IGNORE_REPLAY_ERRORS
-
COMMITLOG_MAX_OUTSTANDING_REPLAY_BYTES
-
COMMITLOG_MAX_OUTSTANDING_REPLAY_COUNT
-
COMMITLOG_STOP_ON_ERRORS
-
COMMIT_LOG_REPLAY_LIST
Entities to replay mutations for upon commit log replay, property is meant to contain comma-separated entities which are either names of keyspaces or keyspaces and tables or their mix. Examples: just keyspaces -Dcassandra.replayList=ks1,ks2,ks3 specific tables -Dcassandra.replayList=ks1.tb1,ks2.tb2 mix of tables and keyspaces -Dcassandra.replayList=ks1.tb1,ks2 If only keyspaces are specified, mutations for all tables in such keyspace will be replayed -
COM_SUN_MANAGEMENT_JMXREMOTE_ACCESS_FILE
This property indicates the location for the access file. If com.sun.management.jmxremote.authenticate is false, then this property and the password and access files, are ignored. Otherwise, the access file must exist and be in the valid format. If the access file is empty or nonexistent, then no access is allowed. -
COM_SUN_MANAGEMENT_JMXREMOTE_AUTHENTICATE
This property indicates whether password authentication for remote monitoring is enabled. By default it is disabled - com.sun.management.jmxremote.authenticate -
COM_SUN_MANAGEMENT_JMXREMOTE_PASSWORD_FILE
This property indicates the path to the password file - com.sun.management.jmxremote.password.file -
COM_SUN_MANAGEMENT_JMXREMOTE_PORT
Port number to enable JMX RMI connections - com.sun.management.jmxremote.port -
COM_SUN_MANAGEMENT_JMXREMOTE_RMI_PORT
The port number to which the RMI connector will be bound - com.sun.management.jmxremote.rmi.port. An Integer object that represents the value of the second argument is returned if there is no port specified, if the port does not have the correct numeric format, or if the specified name is empty or null. -
COM_SUN_MANAGEMENT_JMXREMOTE_SSL
This property indicates whether SSL is enabled for monitoring remotely. Default is set to false. -
COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_CIPHER_SUITES
public static final CassandraRelevantProperties COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_CIPHER_SUITESA comma-delimited list of SSL/TLS cipher suites to enable. Used in conjunction with com.sun.management.jmxremote.ssl - com.sun.management.jmxremote.ssl.enabled.cipher.suites -
COM_SUN_MANAGEMENT_JMXREMOTE_SSL_ENABLED_PROTOCOLS
A comma-delimited list of SSL/TLS protocol versions to enable. Used in conjunction with com.sun.management.jmxremote.ssl - com.sun.management.jmxremote.ssl.enabled.protocols -
COM_SUN_MANAGEMENT_JMXREMOTE_SSL_NEED_CLIENT_AUTH
This property indicates whether SSL client authentication is enabled - com.sun.management.jmxremote.ssl.need.client.auth. Default is set to false. -
CONFIG_ALLOW_SYSTEM_PROPERTIES
Defaults to false for 4.1 but plan to switch to true in a later release the thinking is that environments may not work right off the bat so safer to add this feature disabled by default -
CONFIG_LOADER
-
CONSISTENT_DIRECTORY_LISTINGS
-
CONSISTENT_RANGE_MOVEMENT
-
CONSISTENT_SIMULTANEOUS_MOVES_ALLOW
-
CRYPTO_PROVIDER_CLASS_NAME
-
CUSTOM_GUARDRAILS_CONFIG_PROVIDER_CLASS
-
CUSTOM_QUERY_HANDLER_CLASS
-
CUSTOM_TRACING_CLASS
-
DATA_OUTPUT_BUFFER_ALLOCATE_TYPE
Controls the type of bufffer (heap/direct) used for shared scratch buffers -
DATA_OUTPUT_STREAM_PLUS_TEMP_BUFFER_SIZE
-
DECAYING_ESTIMATED_HISTOGRAM_RESERVOIR_STRIPE_COUNT
-
DEFAULT_PROVIDE_OVERLAPPING_TOMBSTONES
-
DETERMINISM_SSTABLE_COMPRESSION_DEFAULT
determinism properties for testing -
DETERMINISM_UNSAFE_UUID_NODE
-
DIAGNOSTIC_SNAPSHOT_INTERVAL_NANOS
-
DISABLE_AUTH_CACHES_REMOTE_CONFIGURATION
-
DISABLE_GOSSIP_ENDPOINT_REMOVAL
properties to disable certain behaviours for testing -
DISABLE_PAXOS_AUTO_REPAIRS
-
DISABLE_PAXOS_STATE_FLUSH
-
DISABLE_SSTABLE_ACTIVITY_TRACKING
-
DISABLE_STCS_IN_L0
-
DISABLE_TCACTIVE_OPENSSL
-
DISK_USAGE_MONITOR_INTERVAL_MS
property for the rate of the scheduled task that monitors disk usage -
DISK_USAGE_NOTIFY_INTERVAL_MS
property for the interval on which the repeated client warnings and diagnostic events about disk usage are ignored -
DOB_DOUBLING_THRESHOLD_MB
-
DOB_MAX_RECYCLE_BYTES
-
DRAIN_EXECUTOR_TIMEOUT_MS
When draining, how long to wait for mutating executors to shutdown. -
DROP_OVERSIZED_READ_REPAIR_MUTATIONS
-
DTEST_API_LOG_TOPOLOGY
-
DTEST_IS_IN_JVM_DTEST
This property indicates if the code is running under the in-jvm dtest framework -
DTEST_JVM_DTESTS_USE_LATEST
In_JVM dtest property indicating that the test should use "latest" configuration -
ENABLE_DC_LOCAL_COMMIT
-
ENABLE_NODELOCAL_QUERIES
WhetherConsistencyLevel.NODE_LOCALshould be allowed. -
EXPIRATION_DATE_OVERFLOW_POLICY
-
EXPIRATION_OVERFLOW_WARNING_INTERVAL_MINUTES
-
FAILED_BOOTSTRAP_TIMEOUT
-
FAILURE_LOGGING_INTERVAL_SECONDS
-
FAIL_ON_MISSING_CRYPTO_PROVIDER
-
FD_INITIAL_VALUE_MS
-
FD_MAX_INTERVAL_MS
-
FILE_CACHE_ENABLED
-
FILE_SYSTEM_CHECK_ENABLE
Deprecated.See CASSANDRA-17797 -
FILE_SYSTEM_CHECK_OWNERSHIP_FILENAME
@Deprecated(since="4.1") public static final CassandraRelevantProperties FILE_SYSTEM_CHECK_OWNERSHIP_FILENAMEDeprecated.See CASSANDRA-17797 -
FILE_SYSTEM_CHECK_OWNERSHIP_TOKEN
@Deprecated(since="4.1") public static final CassandraRelevantProperties FILE_SYSTEM_CHECK_OWNERSHIP_TOKENDeprecated.See CASSANDRA-17797 -
FORCE_DEFAULT_INDEXING_PAGE_SIZE
-
FORCE_LOAD_LOCAL_KEYSPACES
Used when running in Client mode and the system and schema keyspaces need to be initialized outside of their normal initialization path -
FORCE_PAXOS_STATE_REBUILD
-
GIT_SHA
-
GOSSIPER_QUARANTINE_DELAY
Gossip quarantine delay is used while evaluating membership changes and should only be changed with extreme care. -
GOSSIPER_SKIP_WAITING_TO_SETTLE
-
GOSSIP_DISABLE_THREAD_VALIDATION
-
GOSSIP_SETTLE_MIN_WAIT_MS
Delay before checking if gossip is settled. -
GOSSIP_SETTLE_POLL_INTERVAL_MS
Interval delay between checking gossip is settled. -
GOSSIP_SETTLE_POLL_SUCCESSES_REQUIRED
Number of polls without gossip state change to consider gossip as settled. -
IGNORED_SCHEMA_CHECK_ENDPOINTS
-
IGNORED_SCHEMA_CHECK_VERSIONS
-
IGNORE_CORRUPTED_SCHEMA_TABLES
-
IGNORE_DC
Deprecated.See CASSANDRA-17797 -
IGNORE_DYNAMIC_SNITCH_SEVERITY
-
IGNORE_KERNEL_BUG_1057843_CHECK
-
IGNORE_MISSING_NATIVE_FILE_HINTS
-
IGNORE_RACK
Deprecated.See CASSANDRA-17797 -
INDEX_SUMMARY_EXPECTED_KEY_SIZE
-
INITIAL_TOKEN
-
INTERNODE_EVENT_THREADS
-
IO_NETTY_EVENTLOOP_THREADS
-
IO_NETTY_TRANSPORT_ESTIMATE_SIZE_ON_SUBMIT
-
IO_NETTY_TRANSPORT_NONATIVE
-
JAVAX_RMI_SSL_CLIENT_ENABLED_CIPHER_SUITES
-
JAVAX_RMI_SSL_CLIENT_ENABLED_PROTOCOLS
-
JAVA_CLASS_PATH
Java class path. -
JAVA_HOME
-
JAVA_IO_TMPDIR
Indicates the temporary directory used by the Java Virtual Machine (JVM) to create and store temporary files. -
JAVA_LIBRARY_PATH
Path from which to load native libraries. Default is absolute path to lib directory. -
JAVA_RMI_DGC_LEASE_VALUE_IN_JVM_DTEST
Controls the distributed garbage collector lease time for JMX objects. Should only be set by in-jvm dtests. -
JAVA_RMI_SERVER_HOSTNAME
The value of this property represents the host name string that should be associated with remote stubs for locally created remote objects, in order to allow clients to invoke methods on the remote object. -
JAVA_RMI_SERVER_RANDOM_ID
If this value is true, object identifiers for remote objects exported by this VM will be generated by using a cryptographically secure random number generator. The default value is false. -
JAVA_SECURITY_AUTH_LOGIN_CONFIG
-
JAVA_SECURITY_EGD
-
JAVA_VERSION
Java Runtime Environment version -
JAVA_VM_NAME
Java Virtual Machine implementation name -
JOIN_RING
-
LIBJEMALLOC
startup checks properties -
LINE_SEPARATOR
Line separator ("\n" on UNIX). -
LOAD_RING_STATE
Load persistence ring state. Default value istrue. -
LOG4J2_DISABLE_JMX
-
LOG4J2_DISABLE_JMX_LEGACY
-
LOG4J_SHUTDOWN_HOOK_ENABLED
-
LOGBACK_CONFIGURATION_FILE
-
LOGS_VIRTUAL_TABLE_MAX_ROWS
Maximum number of rows in system_views.logs table -
LOG_DIR
Directory where Cassandra puts its logs, defaults to "." which is current directory. -
LOG_DIR_AUDIT
Directory where Cassandra persists logs from audit logging. If this property is not set, the audit log framework will set it automatically toLOG_DIR+ "/audit". -
LOOSE_DEF_OF_EMPTY_ENABLED
Loosen the definition of "empty" for gossip state, for use during host replacements if things go awry -
MAX_CONCURRENT_RANGE_REQUESTS
-
MAX_HINT_BUFFERS
-
MAX_LOCAL_PAUSE_IN_MS
-
MBEAN_REGISTRATION_CLASS
what class to use for mbean registeration -
MEMTABLE_OVERHEAD_COMPUTE_STEPS
-
MEMTABLE_OVERHEAD_SIZE
-
MEMTABLE_SHARD_COUNT
-
MEMTABLE_TRIE_SIZE_LIMIT
-
MIGRATION_DELAY
-
MONITORING_MAX_OPERATIONS
Defines the maximum number of unique timed out queries that will be reported in the logs. Use a negative number to remove any limit. -
MONITORING_REPORT_INTERVAL_MS
Defines the interval for reporting any operations that have timed out. -
MV_ALLOW_FILTERING_NONKEY_COLUMNS_UNSAFE
-
MV_ENABLE_COORDINATOR_BATCHLOG
-
MX4JADDRESS
mx4jaddress -
MX4JPORT
mx4jport -
NANOTIMETOMILLIS_TIMESTAMP_UPDATE_INTERVAL
-
NATIVE_EPOLL_ENABLED
-
NATIVE_TRANSPORT_PORT
This is the port used with RPC address for the native protocol to communicate with clients. Now that thrift RPC is no longer in use there is no RPC port. -
NEVER_PURGE_TOMBSTONES
-
NIO_DATA_OUTPUT_STREAM_PLUS_BUFFER_SIZE
-
NODETOOL_JMX_NOTIFICATION_POLL_INTERVAL_SECONDS
-
NON_GRACEFUL_SHUTDOWN
If set,MessagingServiceis shutdown abrtuptly without waiting for anything. This is an optimization used in unit tests becuase we never restart a node there. The only node is stopoped when the JVM terminates. Therefore, we can use such optimization and not wait unnecessarily. -
ORG_APACHE_CASSANDRA_DISABLE_MBEAN_REGISTRATION
This property indicates whether disable_mbean_registration is true -
OS_ARCH
Operating system architecture. -
OS_NAME
Operating system name. -
OTCP_LARGE_MESSAGE_THRESHOLD
-
OTC_INTRADC_TCP_NODELAY
Enabled/disable TCP_NODELAY for intradc connections. Defaults is enabled. -
OVERRIDE_DECOMMISSION
-
PARENT_REPAIR_STATUS_CACHE_SIZE
-
PARENT_REPAIR_STATUS_EXPIRY_SECONDS
-
PARTITIONER
-
PAXOS_CLEANUP_SESSION_TIMEOUT_SECONDS
-
PAXOS_DISABLE_COORDINATOR_LOCKING
-
PAXOS_LOG_TTL_LINEARIZABILITY_VIOLATIONS
-
PAXOS_MODERN_RELEASE
-
PAXOS_REPAIR_ALLOW_MULTIPLE_PENDING_UNSAFE
-
PAXOS_REPAIR_ON_TOPOLOGY_CHANGE_RETRIES
-
PAXOS_REPAIR_ON_TOPOLOGY_CHANGE_RETRY_DELAY_SECONDS
-
PAXOS_REPAIR_RETRY_TIMEOUT_IN_MS
-
PAXOS_USE_SELF_EXECUTION
-
PRINT_HEAP_HISTOGRAM_ON_OUT_OF_MEMORY_ERROR
-
READS_THRESHOLDS_COORDINATOR_DEFENSIVE_CHECKS_ENABLED
public static final CassandraRelevantProperties READS_THRESHOLDS_COORDINATOR_DEFENSIVE_CHECKS_ENABLED -
RELEASE_VERSION
-
REPAIR_CLEANUP_INTERVAL_SECONDS
-
REPAIR_DELETE_TIMEOUT_SECONDS
-
REPAIR_FAIL_TIMEOUT_SECONDS
-
REPAIR_MUTATION_REPAIR_ROWS_PER_BATCH
-
REPAIR_STATUS_CHECK_TIMEOUT_SECONDS
-
REPLACEMENT_ALLOW_EMPTY
When doing a host replacement its possible that the gossip state is "empty" meaning that the endpoint is known but the current state isn't known. If the host replacement is needed to repair this state, this property must be true. -
REPLACE_ADDRESS
-
REPLACE_ADDRESS_FIRST_BOOT
-
REPLACE_NODE
-
REPLACE_TOKEN
-
REQUIRED_BATCHLOG_REPLICA_COUNT
Number of replicas required to store batchlog for atomicity, only accepts values of 1 or 2. -
RESET_BOOTSTRAP_PROGRESS
Whether we reset any found data from previously run bootstraps. -
RING_DELAY
-
ROLE_PASSWORD_UPDATE_MIN_INTERVAL_MS
How often a role's password can be changed -
SAI_INTERSECTION_CLAUSE_LIMIT
Controls the maximum number of index query intersections that will take part in a query -
SAI_LATEST_VERSION
Latest version to be used for SAI index writing -
SAI_MINIMUM_POSTINGS_LEAVES
Minimum number of reachable leaves for a given node to be eligible for an auxiliary posting list -
SAI_POSTINGS_SKIP
Skip, or the sampling interval, for selecting a balanced tree level that is eligible for an auxiliary posting list. Sampling starts from 0, but balanced tree root node is at level 1. For skip = 4, eligible levels are 4, 8, 12, etc. (no level 0, because there is no node at level 0). -
SAI_SORTED_TERMS_CLUSTERING_BLOCK_SHIFT
Used to determine the block size and block mask for the clustering sorted terms. -
SAI_SORTED_TERMS_PARTITION_BLOCK_SHIFT
Used to determine the block size and block mask for the partition sorted terms. -
SAI_TEST_BALANCED_TREE_DEBUG_ENABLED
-
SAI_TEST_DISABLE_TIMEOUT
-
SAI_VECTOR_ALLOW_CUSTOM_PARAMETERS
Whether to allow the user to specify custom options to the hnsw index -
SAI_VECTOR_SEARCH_MAX_MATERIALIZE_KEYS
The maximum number of primary keys that a WHERE clause may materialize before the query planner switches from a search-then-sort execution strategy to an order-by-then-filter strategy. Increasing this limit allows more primary keys to be buffered in memory, enabling either (a) brute-force sorting or (b) graph traversal with a restrictive filter that admits only nodes whose primary keys matched the WHERE clause. Note also that the SAI_INTERSECTION_CLAUSE_LIMIT is applied to the WHERE clause before using a search to build a potential result set for search-then-sort query execution. -
SAI_VECTOR_SEARCH_MAX_TOP_K
Controls the maximum top-k limit for vector search -
SCHEMA_PULL_INTERVAL_MS
-
SCHEMA_UPDATE_HANDLER_FACTORY_CLASS
-
SEARCH_CONCURRENCY_FACTOR
-
SEED_COUNT_WARN_THRESHOLD
The maximum number of seeds returned by a seed provider before emmitting a warning. A large seed list may impact effectiveness of the third gossip round. The default used in SimpleSeedProvider is 20. -
SERIALIZATION_EMPTY_TYPE_NONEMPTY_BEHAVIOR
-
SET_SEP_THREAD_NAME
-
SHUTDOWN_ANNOUNCE_DELAY_IN_MS
-
SIMULATOR_ITERATIONS
-
SIZE_RECORDER_INTERVAL
-
SKIP_OPTIMAL_STREAMING_CANDIDATES_CALCULATION
Do not try to calculate optimal streaming candidates. This can take a lot of time in some configs specially with vnodes. -
SKIP_PAXOS_REPAIR_ON_TOPOLOGY_CHANGE
-
SKIP_PAXOS_REPAIR_ON_TOPOLOGY_CHANGE_KEYSPACES
If necessary for operational purposes, permit certain keyspaces to be ignored for paxos topology repairs. -
SKIP_PAXOS_REPAIR_VERSION_VALIDATION
-
SKIP_PAXOS_STATE_REBUILD
-
SNAPSHOT_CLEANUP_INITIAL_DELAY_SECONDS
snapshots ttl cleanup initial delay in seconds -
SNAPSHOT_CLEANUP_PERIOD_SECONDS
snapshots ttl cleanup period in seconds -
SNAPSHOT_MIN_ALLOWED_TTL_SECONDS
minimum allowed TTL for snapshots -
SSL_ENABLE
-
SSL_STORAGE_PORT
-
START_GOSSIP
-
START_NATIVE_TRANSPORT
-
STORAGE_DIR
-
STORAGE_HOOK
-
STORAGE_PORT
-
STREAMING_HISTOGRAM_ROUND_SECONDS
-
STREAMING_SESSION_PARALLELTRANSFERS
-
STREAM_HOOK
-
SUN_ARCH_DATA_MODEL
Platform word size sun.arch.data.model. Examples: "32", "64", "unknown" -
SUN_JAVA_COMMAND
-
SUN_RMI_TRANSPORT_TCP_THREADKEEPALIVETIME
Controls the JMX server threadpool keap-alive time. Should only be set by in-jvm dtests. -
SUN_STDERR_ENCODING
-
SUN_STDOUT_ENCODING
-
SUPERUSER_SETUP_DELAY_MS
-
SYSTEM_AUTH_DEFAULT_RF
-
SYSTEM_DISTRIBUTED_DEFAULT_RF
-
SYSTEM_TRACES_DEFAULT_RF
-
TEST_BBFAILHELPER_ENABLED
-
TEST_BLOB_SHARED_SEED
-
TEST_BYTEMAN_TRANSFORMATIONS_DEBUG
-
TEST_CASSANDRA_KEEPBRIEFBRIEF
-
TEST_CASSANDRA_RELEVANT_PROPERTIES
-
TEST_CASSANDRA_SKIP_SYNC
A property for various mechanisms for syncing files that makes it possible it intercept and skip syncing. -
TEST_CASSANDRA_SUITENAME
-
TEST_CASSANDRA_TESTTAG
-
TEST_COMPRESSION
-
TEST_COMPRESSION_ALGO
-
TEST_DEBUG_REF_COUNT
-
TEST_DRIVER_CONNECTION_TIMEOUT_MS
-
TEST_DRIVER_READ_TIMEOUT_MS
-
TEST_ENCRYPTION
-
TEST_FAIL_MV_LOCKS_COUNT
-
TEST_FAIL_WRITES_KS
-
TEST_FLUSH_LOCAL_SCHEMA_CHANGES
Flush changes ofSchemaKeyspaceafter each schema modification. In production, we always do that. However, tests which do not restart nodes may disable this functionality in order to run faster. Note that this is disabled for unit tests but if an individual test requires schema to be flushed, it can be also done manually for that particular case:flush(SchemaConstants.SCHEMA_KEYSPACE_NAME);. -
TEST_HARRY_SWITCH_AFTER
-
TEST_IGNORE_SIGAR
-
TEST_INTERVAL_TREE_EXPENSIVE_CHECKS
-
TEST_INVALID_LEGACY_SSTABLE_ROOT
-
TEST_JVM_DTEST_DISABLE_SSL
-
TEST_LEGACY_SSTABLE_ROOT
-
TEST_ORG_CAFFINITAS_OHC_SEGMENTCOUNT
-
TEST_RANDOM_SEED
-
TEST_READ_ITERATION_DELAY_MS
-
TEST_REUSE_PREPARED
-
TEST_ROW_CACHE_SIZE
-
TEST_SERIALIZATION_WRITES
-
TEST_SIMULATOR_DEBUG
-
TEST_SIMULATOR_DETERMINISM_CHECK
-
TEST_SIMULATOR_LIVENESS_CHECK
-
TEST_SIMULATOR_PRINT_ASM
properties for debugging simulator ASM output -
TEST_SIMULATOR_PRINT_ASM_CLASSES
-
TEST_SIMULATOR_PRINT_ASM_OPTS
-
TEST_SIMULATOR_PRINT_ASM_TYPES
-
TEST_SKIP_CRYPTO_PROVIDER_INSTALLATION
-
TEST_SSTABLE_FORMAT_DEVELOPMENT
-
TEST_STORAGE_COMPATIBILITY_MODE
StorageCompatibilityModemode sets how the node will behave, sstable or messaging versions to use etc. according to a yaml setting. But many tests don't load the config hence we need to force it otherwise they would run always under the default. Config is null for junits that don't load the config. Get from env var that CI/build.xml sets. This is a dev/CI only property. Do not use otherwise. -
TEST_STRICT_LCS_CHECKS
-
TEST_STRICT_RUNTIME_CHECKS
Turns some warnings into exceptions for testing. -
TEST_UNSAFE_VERBOSE_DEBUG_CLIENT_PROTOCOL
Not to be used in production, this causes a Netty logging handler to be added to the pipeline, which will throttle a system under any normal load. -
TEST_USE_PREPARED
-
TEST_UTIL_ALLOW_TOOL_REINIT_FOR_TEST
-
TEST_WRITE_SURVEY
Activate write survey mode. The node not becoming an active ring member, and you must use JMX StorageService->joinRing() to finalize the ring joining. -
TOLERATE_SSTABLE_SIZE
-
TRIGGERS_DIR
-
TRUNCATE_BALLOT_METADATA
-
TYPE_UDT_CONFLICT_BEHAVIOR
-
UCS_BASE_SHARD_COUNT
-
UCS_MIN_SSTABLE_SIZE
-
UCS_OVERLAP_INCLUSION_METHOD
-
UCS_SCALING_PARAMETER
-
UCS_SSTABLE_GROWTH
-
UCS_SURVIVAL_FACTOR
-
UCS_TARGET_SSTABLE_SIZE
-
UDF_EXECUTOR_THREAD_KEEPALIVE_MS
-
UNSAFE_SYSTEM
-
USER_HOME
User's home directory. -
USE_NIX_RECURSIVE_DELETE
When enabled, recursive directory deletion will be executed using a unix command `rm -rf` instead of traversing and removing individual files. This is now used only tests, but eventually we will make it true by default. -
VERY_LONG_TIME_MS
Gossiper compute expiration timeout. Default value 3 days. -
VIRTUAL_TABLE_COMPLEX_SETTINGS_FORMAT_JSON
Controls output format for Collection-type settings in system_views.settings table -
WAIT_FOR_TRACING_EVENTS_TIMEOUT_SECS
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getKey
-
getString
Gets the value of the indicated system property.- Returns:
- system property value if it exists, defaultValue otherwise.
-
getDefaultValue
Returns default value.- Returns:
- default value, if any, otherwise null.
-
reset
public void reset()Sets the property to its default value if a default value was specified. Remove the property otherwise. -
getString
Gets the value of a system property as a String.- Returns:
- system property String value if it exists, overrideDefaultValue otherwise.
-
convert
-
convertToString
-
setString
Sets the value into system properties.- Parameters:
value- to set
-
getBoolean
public boolean getBoolean()Gets the value of a system property as a boolean.- Returns:
- system property boolean value if it exists, false otherwise().
-
getBoolean
public boolean getBoolean(boolean overrideDefaultValue) Gets the value of a system property as a boolean.- Returns:
- system property boolean value if it exists, overrideDefaultValue otherwise.
-
setBoolean
Sets the value into system properties.- Parameters:
value- to set- Returns:
- Previous value if it exists.
-
clearValue
public void clearValue()Clears the value set in the system property. -
getInt
public int getInt()Gets the value of a system property as a int.- Returns:
- System property value if it exists, defaultValue otherwise. Throws an exception if no default value is set.
-
getLong
public long getLong()Gets the value of a system property as a long.- Returns:
- System property value if it exists, defaultValue otherwise. Throws an exception if no default value is set.
-
getLong
public long getLong(long overrideDefaultValue) Gets the value of a system property as a long.- Returns:
- system property long value if it exists, defaultValue otherwise.
-
getDouble
public double getDouble()Gets the value of a system property as a double.- Returns:
- System property value if it exists, defaultValue otherwise. Throws an exception if no default value is set.
-
getDouble
public double getDouble(double overrideDefaultValue) Gets the value of a system property as a double.- Returns:
- system property value if it exists, defaultValue otherwise.
-
getSizeInBytes
public long getSizeInBytes()Gets the value of a system property, given as a human-readable size in bytes (e.g. 100MiB, 10GB, 500B).- Returns:
- System property value if it exists, defaultValue otherwise. Throws an exception if no default value is set.
-
getSizeInBytes
public long getSizeInBytes(long overrideDefaultValue) Gets the value of a system property, given as a human-readable size in bytes (e.g. 100MiB, 10GB, 500B).- Returns:
- System property value if it exists, defaultValue otherwise.
-
getInt
public int getInt(int overrideDefaultValue) Gets the value of a system property as an int.- Returns:
- system property int value if it exists, overrideDefaultValue otherwise.
-
setInt
Sets the value into system properties.- Parameters:
value- to set- Returns:
- Previous value or null if it did not have one.
-
setLong
Sets the value into system properties.- Parameters:
value- to set- Returns:
- Previous value or null if it did not have one.
-
getEnum
Gets the value of a system property as a enum, callingString.toUpperCase()first.- Type Parameters:
T- type- Parameters:
defaultValue- to return when not defined- Returns:
- enum value
-
getEnum
Gets the value of a system property as a enum, optionally callingString.toUpperCase()first.- Type Parameters:
T- type- Parameters:
toUppercase- before converting to enumdefaultValue- to return when not defined- Returns:
- enum value
-
getEnum
Gets the value of a system property as an enum, optionally callingString.toUpperCase()first. If the value is missing, the default value for this property is used- Type Parameters:
T- type- Parameters:
toUppercase- before converting to enumenumClass- enumeration class- Returns:
- enum value
-
setEnum
Sets the value into system properties.- Parameters:
value- to set
-
isPresent
public boolean isPresent()- Returns:
- whether a system property is present or not.
-