Class Guardrails
- java.lang.Object
-
- org.apache.cassandra.db.guardrails.Guardrails
-
- All Implemented Interfaces:
GuardrailsMBean
public final class Guardrails extends java.lang.Object implements GuardrailsMBean
Entry point for Guardrails, storing the defined guardrails and providing a few global methods over them.
-
-
Field Summary
Fields Modifier and Type Field Description static EnableFlagallowFilteringEnabledGuardrail disabling ALLOW FILTERING statement within a querystatic EnableFlagalterTableEnabledGuardrail disabling ALTER TABLE column mutation access.static MaxThresholdcollectionSizeGuardrail on the size of a collection.static MaxThresholdcolumnsPerTableGuardrail on the number of columns per table.static MaxThresholdcolumnValueSizeGuardrail on the size of a collection.static EnableFlagcompactTablesEnabledGuardrail disabling the creation of new COMPACT STORAGE tablesstatic GuardrailsConfigProviderCONFIG_PROVIDERstatic EnableFlagcreateSecondaryIndexesEnabledGuardrail disabling user's ability to create secondary indexesstatic EnableFlagdropKeyspaceEnabledGuardrail disabling DROP KEYSPACE behaviorstatic EnableFlagdropTruncateTableEnabledGuardrail disabling DROP / TRUNCATE TABLE behaviorstatic MaxThresholdfieldsPerUDTGuardrail on the number of fields on each UDT.static EnableFlaggroupByEnabledstatic MaxThresholdinSelectCartesianProductGuardrail on the number of restrictions created by a cartesian product of a CQL'sINquery.static Guardrailsinstancestatic EnableFlagintersectFilteringQueryEnabledGuardrail to warn on or fail filtering queries that contain intersections on mutable columns at consistency levels that require coordinator reconciliation.static MaxThresholditemsPerCollectionGuardrail on the number of items of a collection.static MaxThresholdkeyspacesGuardrail on the total number of user keyspaces.static PercentageThresholdlocalDataDiskUsageGuardrail on the data disk usage on the local node, used by a periodic task to calculate and propagate that status.static MaxThresholdmaterializedViewsPerTableGuardrail on the number of materialized views per table.static MaxThresholdmaximumAllowableTimestampstatic MaxThresholdmaximumReplicationFactorGuardrail on the maximum replication factor.static java.lang.StringMBEAN_NAMEstatic MinThresholdminimumAllowableTimestampstatic MinThresholdminimumReplicationFactorGuardrail on the minimum replication factor.static EnableFlagnonPartitionRestrictedIndexQueryEnabledstatic MaxThresholdpageSizeGuardrail on the number of elements returned within page.static MaxThresholdpartitionKeysInSelectGuardrail on the number of partition keys in the IN clause.static MaxThresholdpartitionSizeGuardrail on the size of a partition.static MaxThresholdpartitionTombstonesGuardrail on the number of rows of a partition.static EnableFlagreadBeforeWriteListOperationsEnabledGuardrail disabling operations on lists that require read before write.static Values<ConsistencyLevel>readConsistencyLevelsGuardrail on read consistency levels.static Predicates<InetAddressAndPort>replicaDiskUsageGuardrail on the data disk usage on replicas, used at write time to verify the status of the involved replicas.static MaxThresholdsaiFrozenTermSizeGuardrail on the size of a frozen term written to SAI index.static MaxThresholdsaiSSTableIndexesPerQuerystatic MaxThresholdsaiStringTermSizeGuardrail on the size of a string term written to SAI index.static MaxThresholdsaiVectorTermSizeGuardrail on the size of a vector term written to SAI index.static MaxThresholdsecondaryIndexesPerTablestatic EnableFlagsimpleStrategyEnabledGuardrail disabling setting SimpleStrategy via keyspace creation or alterationstatic Values<java.lang.String>tablePropertiesGuardrail warning about, ignoring or rejecting the usage of certain table properties.static MaxThresholdtablesGuardrail on the total number of tables on user keyspaces.static EnableFlaguncompressedTablesEnabledGuardrail disabling user's ability to turn off compressionstatic EnableFlaguserTimestampsEnabledGuardrail disabling user-provided timestamps.static MaxThresholdvectorDimensionsGuardrail on the number of dimensions of vector columns.static EnableFlagvectorTypeEnabledGuardrail on the usage of vector type.static Values<ConsistencyLevel>writeConsistencyLevelsGuardrail on write consistency levels.static EnableFlagzeroTTLOnTWCSEnabledGuardrail to warn or fail a CREATE or ALTER TABLE statement when default_time_to_live is set to 0 and the table is using TimeWindowCompactionStrategy compaction or a subclass of it.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleangetAllowFilteringEnabled()Returns whether ALLOW FILTERING property is allowed.booleangetAlterTableEnabled()Gets whether users can use the ALTER TABLE statement to change columnsjava.lang.StringgetCollectionSizeFailThreshold()java.lang.StringgetCollectionSizeWarnThreshold()intgetColumnsPerTableFailThreshold()intgetColumnsPerTableWarnThreshold()java.lang.StringgetColumnValueSizeFailThreshold()java.lang.StringgetColumnValueSizeWarnThreshold()booleangetCompactTablesEnabled()Returns whether users can create new COMPACT STORAGE tablesjava.lang.StringgetDataDiskUsageMaxDiskSize()intgetDataDiskUsagePercentageFailThreshold()intgetDataDiskUsagePercentageWarnThreshold()booleangetDropKeyspaceEnabled()Returns whether users can DROP a keyspacebooleangetDropTruncateTableEnabled()Returns whether users can TRUNCATE or DROP TABLEintgetFieldsPerUDTFailThreshold()intgetFieldsPerUDTWarnThreshold()booleangetGroupByEnabled()Returns whether GROUP BY queries are allowed.intgetInSelectCartesianProductFailThreshold()intgetInSelectCartesianProductWarnThreshold()booleangetIntersectFilteringQueryEnabled()booleangetIntersectFilteringQueryWarned()intgetItemsPerCollectionFailThreshold()intgetItemsPerCollectionWarnThreshold()intgetKeyspacesFailThreshold()intgetKeyspacesWarnThreshold()intgetMaterializedViewsPerTableFailThreshold()intgetMaterializedViewsPerTableWarnThreshold()intgetMaximumReplicationFactorFailThreshold()intgetMaximumReplicationFactorWarnThreshold()java.lang.StringgetMaximumTimestampFailThreshold()java.lang.StringgetMaximumTimestampWarnThreshold()intgetMinimumReplicationFactorFailThreshold()intgetMinimumReplicationFactorWarnThreshold()java.lang.StringgetMinimumTimestampFailThreshold()java.lang.StringgetMinimumTimestampWarnThreshold()booleangetNonPartitionRestrictedQueryEnabled()Returns whether it is possible to execute a query against secondary indexes without specifying any partition key restrictions.intgetPageSizeFailThreshold()intgetPageSizeWarnThreshold()intgetPartitionKeysInSelectFailThreshold()intgetPartitionKeysInSelectWarnThreshold()java.lang.StringgetPartitionSizeFailThreshold()java.lang.StringgetPartitionSizeWarnThreshold()longgetPartitionTombstonesFailThreshold()longgetPartitionTombstonesWarnThreshold()booleangetReadBeforeWriteListOperationsEnabled()Returns whether list operations that require read before write are allowed.java.util.Set<java.lang.String>getReadConsistencyLevelsDisallowed()java.lang.StringgetReadConsistencyLevelsDisallowedCSV()java.util.Set<java.lang.String>getReadConsistencyLevelsWarned()java.lang.StringgetReadConsistencyLevelsWarnedCSV()java.lang.StringgetSaiFrozenTermSizeFailThreshold()java.lang.StringgetSaiFrozenTermSizeWarnThreshold()intgetSaiSSTableIndexesPerQueryFailThreshold()intgetSaiSSTableIndexesPerQueryWarnThreshold()java.lang.StringgetSaiStringTermSizeFailThreshold()java.lang.StringgetSaiStringTermSizeWarnThreshold()java.lang.StringgetSaiVectorTermSizeFailThreshold()java.lang.StringgetSaiVectorTermSizeWarnThreshold()booleangetSecondaryIndexesEnabled()intgetSecondaryIndexesPerTableFailThreshold()intgetSecondaryIndexesPerTableWarnThreshold()booleangetSimpleStrategyEnabled()Returns whether SimpleStrategy is allowed on keyspace creation or alterationjava.util.Set<java.lang.String>getTablePropertiesDisallowed()java.lang.StringgetTablePropertiesDisallowedCSV()java.util.Set<java.lang.String>getTablePropertiesIgnored()java.lang.StringgetTablePropertiesIgnoredCSV()java.util.Set<java.lang.String>getTablePropertiesWarned()java.lang.StringgetTablePropertiesWarnedCSV()intgetTablesFailThreshold()intgetTablesWarnThreshold()booleangetUncompressedTablesEnabled()Returns whether users can disable compression on tablesbooleangetUserTimestampsEnabled()Returns whether user-provided timestamps are allowed.intgetVectorDimensionsFailThreshold()intgetVectorDimensionsWarnThreshold()booleangetVectorTypeEnabled()java.util.Set<java.lang.String>getWriteConsistencyLevelsDisallowed()java.lang.StringgetWriteConsistencyLevelsDisallowedCSV()java.util.Set<java.lang.String>getWriteConsistencyLevelsWarned()java.lang.StringgetWriteConsistencyLevelsWarnedCSV()booleangetZeroTTLOnTWCSEnabled()Returns whether it is allowed to create or alter table to use 0 default TTL with TimeWindowCompactionStrategy.booleangetZeroTTLOnTWCSWarned()Returns whether warnings will be emitted when usage of 0 default TTL on a table with TimeWindowCompactionStrategy is detected.voidsetAllowFilteringEnabled(boolean enabled)Sets whether ALLOW FILTERING is allowed.voidsetAlterTableEnabled(boolean enabled)Sets whether users can use the ALTER TABLE statement to change columnsvoidsetCollectionSizeThreshold(java.lang.String warnSize, java.lang.String failSize)voidsetColumnsPerTableThreshold(int warn, int fail)voidsetColumnValueSizeThreshold(java.lang.String warnSize, java.lang.String failSize)voidsetCompactTablesEnabled(boolean enabled)Sets whether users can create new COMPACT STORAGE tablesvoidsetDataDiskUsageMaxDiskSize(java.lang.String size)voidsetDataDiskUsagePercentageThreshold(int warn, int fail)voidsetDropKeyspaceEnabled(boolean enabled)Sets whether users can DROP a keyspacevoidsetDropTruncateTableEnabled(boolean enabled)Sets whether users can TRUNCATE or DROP TABLEvoidsetFieldsPerUDTThreshold(int warn, int fail)voidsetGroupByEnabled(boolean enabled)Sets whether GROUP BY queries are allowed.voidsetInSelectCartesianProductThreshold(int warn, int fail)voidsetIntersectFilteringQueryEnabled(boolean value)voidsetIntersectFilteringQueryWarned(boolean value)voidsetItemsPerCollectionThreshold(int warn, int fail)voidsetKeyspacesThreshold(int warn, int fail)voidsetMaterializedViewsPerTableThreshold(int warn, int fail)voidsetMaximumReplicationFactorThreshold(int warn, int fail)voidsetMaximumTimestampThreshold(java.lang.String warnSeconds, java.lang.String failSeconds)Sets the warning upper bound for user supplied timestamps.voidsetMinimumReplicationFactorThreshold(int warn, int fail)voidsetMinimumTimestampThreshold(java.lang.String warnSeconds, java.lang.String failSeconds)Sets the warning lower bound for user supplied timestamps.voidsetNonPartitionRestrictedQueryEnabled(boolean enabled)Sets whether it is possible to execute a query against indexes (secondary or SAI) without specifying any partition key restrictions.voidsetPageSizeThreshold(int warn, int fail)voidsetPartitionKeysInSelectThreshold(int warn, int fail)voidsetPartitionSizeThreshold(java.lang.String warnSize, java.lang.String failSize)voidsetPartitionTombstonesThreshold(long warn, long fail)voidsetReadBeforeWriteListOperationsEnabled(boolean enabled)Sets whether list operations that require read before write are allowed.voidsetReadConsistencyLevelsDisallowed(java.util.Set<java.lang.String> consistencyLevels)voidsetReadConsistencyLevelsDisallowedCSV(java.lang.String consistencyLevels)voidsetReadConsistencyLevelsWarned(java.util.Set<java.lang.String> consistencyLevels)voidsetReadConsistencyLevelsWarnedCSV(java.lang.String consistencyLevels)voidsetSaiFrozenTermSizeThreshold(java.lang.String warnSize, java.lang.String failSize)voidsetSaiSSTableIndexesPerQueryThreshold(int warn, int fail)Sets warning and failure thresholds for the number of SAI SSTable indexes searched by a queryvoidsetSaiStringTermSizeThreshold(java.lang.String warnSize, java.lang.String failSize)voidsetSaiVectorTermSizeThreshold(java.lang.String warnSize, java.lang.String failSize)voidsetSecondaryIndexesEnabled(boolean enabled)Enables or disables the ability to create secondary indexesvoidsetSecondaryIndexesPerTableThreshold(int warn, int fail)voidsetSimpleStrategyEnabled(boolean enabled)Sets whether SimpleStrategy is allowed on keyspace creation or alterationvoidsetTablePropertiesDisallowed(java.lang.String... properties)voidsetTablePropertiesDisallowed(java.util.Set<java.lang.String> properties)voidsetTablePropertiesDisallowedCSV(java.lang.String properties)voidsetTablePropertiesIgnored(java.lang.String... properties)voidsetTablePropertiesIgnored(java.util.Set<java.lang.String> properties)voidsetTablePropertiesIgnoredCSV(java.lang.String properties)voidsetTablePropertiesWarned(java.lang.String... properties)voidsetTablePropertiesWarned(java.util.Set<java.lang.String> properties)voidsetTablePropertiesWarnedCSV(java.lang.String properties)voidsetTablesThreshold(int warn, int fail)voidsetUncompressedTablesEnabled(boolean enabled)Sets whether users can disable compression on tablesvoidsetUserTimestampsEnabled(boolean enabled)Sets whether user-provided timestamps are allowed.voidsetVectorDimensionsThreshold(int warn, int fail)voidsetVectorTypeEnabled(boolean enabled)voidsetWriteConsistencyLevelsDisallowed(java.util.Set<java.lang.String> consistencyLevels)voidsetWriteConsistencyLevelsDisallowedCSV(java.lang.String consistencyLevels)voidsetWriteConsistencyLevelsWarned(java.util.Set<java.lang.String> consistencyLevels)voidsetWriteConsistencyLevelsWarnedCSV(java.lang.String consistencyLevels)voidsetZeroTTLOnTWCSEnabled(boolean value)Sets whether users can use 0 default TTL on a table with TimeWindowCompactionStrategy.voidsetZeroTTLOnTWCSWarned(boolean value)Sets whether warnings will be emitted when usage of 0 default TTL on a table with TimeWindowCompactionStrategy is detected.
-
-
-
Field Detail
-
MBEAN_NAME
public static final java.lang.String MBEAN_NAME
- See Also:
- Constant Field Values
-
CONFIG_PROVIDER
public static final GuardrailsConfigProvider CONFIG_PROVIDER
-
instance
public static final Guardrails instance
-
keyspaces
public static final MaxThreshold keyspaces
Guardrail on the total number of user keyspaces.
-
tables
public static final MaxThreshold tables
Guardrail on the total number of tables on user keyspaces.
-
columnsPerTable
public static final MaxThreshold columnsPerTable
Guardrail on the number of columns per table.
-
secondaryIndexesPerTable
public static final MaxThreshold secondaryIndexesPerTable
-
createSecondaryIndexesEnabled
public static final EnableFlag createSecondaryIndexesEnabled
Guardrail disabling user's ability to create secondary indexes
-
materializedViewsPerTable
public static final MaxThreshold materializedViewsPerTable
Guardrail on the number of materialized views per table.
-
tableProperties
public static final Values<java.lang.String> tableProperties
Guardrail warning about, ignoring or rejecting the usage of certain table properties.
-
userTimestampsEnabled
public static final EnableFlag userTimestampsEnabled
Guardrail disabling user-provided timestamps.
-
groupByEnabled
public static final EnableFlag groupByEnabled
-
alterTableEnabled
public static final EnableFlag alterTableEnabled
Guardrail disabling ALTER TABLE column mutation access.
-
dropTruncateTableEnabled
public static final EnableFlag dropTruncateTableEnabled
Guardrail disabling DROP / TRUNCATE TABLE behavior
-
dropKeyspaceEnabled
public static final EnableFlag dropKeyspaceEnabled
Guardrail disabling DROP KEYSPACE behavior
-
uncompressedTablesEnabled
public static final EnableFlag uncompressedTablesEnabled
Guardrail disabling user's ability to turn off compression
-
compactTablesEnabled
public static final EnableFlag compactTablesEnabled
Guardrail disabling the creation of new COMPACT STORAGE tables
-
zeroTTLOnTWCSEnabled
public static final EnableFlag zeroTTLOnTWCSEnabled
Guardrail to warn or fail a CREATE or ALTER TABLE statement when default_time_to_live is set to 0 and the table is using TimeWindowCompactionStrategy compaction or a subclass of it.
-
intersectFilteringQueryEnabled
public static final EnableFlag intersectFilteringQueryEnabled
Guardrail to warn on or fail filtering queries that contain intersections on mutable columns at consistency levels that require coordinator reconciliation.- See Also:
- CASSANDRA-19007
-
pageSize
public static final MaxThreshold pageSize
Guardrail on the number of elements returned within page.
-
partitionKeysInSelect
public static final MaxThreshold partitionKeysInSelect
Guardrail on the number of partition keys in the IN clause.
-
readBeforeWriteListOperationsEnabled
public static final EnableFlag readBeforeWriteListOperationsEnabled
Guardrail disabling operations on lists that require read before write.
-
allowFilteringEnabled
public static final EnableFlag allowFilteringEnabled
Guardrail disabling ALLOW FILTERING statement within a query
-
simpleStrategyEnabled
public static final EnableFlag simpleStrategyEnabled
Guardrail disabling setting SimpleStrategy via keyspace creation or alteration
-
inSelectCartesianProduct
public static final MaxThreshold inSelectCartesianProduct
Guardrail on the number of restrictions created by a cartesian product of a CQL'sINquery.
-
readConsistencyLevels
public static final Values<ConsistencyLevel> readConsistencyLevels
Guardrail on read consistency levels.
-
writeConsistencyLevels
public static final Values<ConsistencyLevel> writeConsistencyLevels
Guardrail on write consistency levels.
-
partitionSize
public static final MaxThreshold partitionSize
Guardrail on the size of a partition.
-
partitionTombstones
public static final MaxThreshold partitionTombstones
Guardrail on the number of rows of a partition.
-
columnValueSize
public static final MaxThreshold columnValueSize
Guardrail on the size of a collection.
-
collectionSize
public static final MaxThreshold collectionSize
Guardrail on the size of a collection.
-
itemsPerCollection
public static final MaxThreshold itemsPerCollection
Guardrail on the number of items of a collection.
-
fieldsPerUDT
public static final MaxThreshold fieldsPerUDT
Guardrail on the number of fields on each UDT.
-
vectorTypeEnabled
public static final EnableFlag vectorTypeEnabled
Guardrail on the usage of vector type. This may be useful when running clusters that have diverse clients, where some do not support the vector type. Clients that do not support vector may fail to establish sessions or fail to read results containing vector columns.
-
vectorDimensions
public static final MaxThreshold vectorDimensions
Guardrail on the number of dimensions of vector columns.
-
localDataDiskUsage
public static final PercentageThreshold localDataDiskUsage
Guardrail on the data disk usage on the local node, used by a periodic task to calculate and propagate that status. SeeDiskUsageMonitorandDiskUsageBroadcaster.
-
replicaDiskUsage
public static final Predicates<InetAddressAndPort> replicaDiskUsage
Guardrail on the data disk usage on replicas, used at write time to verify the status of the involved replicas. SeeDiskUsageMonitorandDiskUsageBroadcaster.
-
minimumReplicationFactor
public static final MinThreshold minimumReplicationFactor
Guardrail on the minimum replication factor.
-
maximumReplicationFactor
public static final MaxThreshold maximumReplicationFactor
Guardrail on the maximum replication factor.
-
maximumAllowableTimestamp
public static final MaxThreshold maximumAllowableTimestamp
-
minimumAllowableTimestamp
public static final MinThreshold minimumAllowableTimestamp
-
saiSSTableIndexesPerQuery
public static final MaxThreshold saiSSTableIndexesPerQuery
-
saiStringTermSize
public static final MaxThreshold saiStringTermSize
Guardrail on the size of a string term written to SAI index.
-
saiFrozenTermSize
public static final MaxThreshold saiFrozenTermSize
Guardrail on the size of a frozen term written to SAI index.
-
saiVectorTermSize
public static final MaxThreshold saiVectorTermSize
Guardrail on the size of a vector term written to SAI index.
-
nonPartitionRestrictedIndexQueryEnabled
public static final EnableFlag nonPartitionRestrictedIndexQueryEnabled
-
-
Method Detail
-
getKeyspacesWarnThreshold
public int getKeyspacesWarnThreshold()
- Specified by:
getKeyspacesWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when creating more user keyspaces than threshold. -1 means disabled.
-
getKeyspacesFailThreshold
public int getKeyspacesFailThreshold()
- Specified by:
getKeyspacesFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent creating more user keyspaces than threshold. -1 means disabled.
-
setKeyspacesThreshold
public void setKeyspacesThreshold(int warn, int fail)- Specified by:
setKeyspacesThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when creating more user keyspaces than threshold. -1 means disabled.fail- The threshold to prevent creating more user keyspaces than threshold. -1 means disabled.
-
getTablesWarnThreshold
public int getTablesWarnThreshold()
- Specified by:
getTablesWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when creating more tables than threshold. -1 means disabled.
-
getTablesFailThreshold
public int getTablesFailThreshold()
- Specified by:
getTablesFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent creating more tables than threshold. -1 means disabled.
-
setTablesThreshold
public void setTablesThreshold(int warn, int fail)- Specified by:
setTablesThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when creating more tables than threshold. -1 means disabled.fail- The threshold to prevent creating more tables than threshold. -1 means disabled.
-
getColumnsPerTableWarnThreshold
public int getColumnsPerTableWarnThreshold()
- Specified by:
getColumnsPerTableWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when having more columns per table than threshold. -1 means disabled.
-
getColumnsPerTableFailThreshold
public int getColumnsPerTableFailThreshold()
- Specified by:
getColumnsPerTableFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent having more columns per table than threshold. -1 means disabled.
-
setColumnsPerTableThreshold
public void setColumnsPerTableThreshold(int warn, int fail)- Specified by:
setColumnsPerTableThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when having more columns per table than threshold. -1 means disabled.fail- The threshold to prevent having more columns per table than threshold. -1 means disabled.
-
getSecondaryIndexesPerTableWarnThreshold
public int getSecondaryIndexesPerTableWarnThreshold()
- Specified by:
getSecondaryIndexesPerTableWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when creating more secondary indexes per table than threshold. -1 means disabled.
-
getSecondaryIndexesPerTableFailThreshold
public int getSecondaryIndexesPerTableFailThreshold()
- Specified by:
getSecondaryIndexesPerTableFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent creating more secondary indexes per table than threshold. -1 means disabled.
-
setSecondaryIndexesPerTableThreshold
public void setSecondaryIndexesPerTableThreshold(int warn, int fail)- Specified by:
setSecondaryIndexesPerTableThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when creating more secondary indexes per table than threshold. -1 means disabled.fail- The threshold to prevent creating more secondary indexes per table than threshold. -1 means disabled.
-
getSecondaryIndexesEnabled
public boolean getSecondaryIndexesEnabled()
- Specified by:
getSecondaryIndexesEnabledin interfaceGuardrailsMBean- Returns:
- Whether secondary index creation is active or not on the node
-
setSecondaryIndexesEnabled
public void setSecondaryIndexesEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanEnables or disables the ability to create secondary indexes- Specified by:
setSecondaryIndexesEnabledin interfaceGuardrailsMBean
-
getMaterializedViewsPerTableWarnThreshold
public int getMaterializedViewsPerTableWarnThreshold()
- Specified by:
getMaterializedViewsPerTableWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when creating more materialized views per table than threshold. -1 means disabled.
-
getMaterializedViewsPerTableFailThreshold
public int getMaterializedViewsPerTableFailThreshold()
- Specified by:
getMaterializedViewsPerTableFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent creating more materialized views per table than threshold. -1 means disabled.
-
setMaterializedViewsPerTableThreshold
public void setMaterializedViewsPerTableThreshold(int warn, int fail)- Specified by:
setMaterializedViewsPerTableThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when creating more materialized views per table than threshold. -1 means disabled.fail- The threshold to prevent creating more materialized views per table than threshold. -1 means disabled.
-
getTablePropertiesWarned
public java.util.Set<java.lang.String> getTablePropertiesWarned()
- Specified by:
getTablePropertiesWarnedin interfaceGuardrailsMBean- Returns:
- properties that are warned about when creating or altering a table.
-
getTablePropertiesWarnedCSV
public java.lang.String getTablePropertiesWarnedCSV()
- Specified by:
getTablePropertiesWarnedCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of properties that are warned about when creating or altering a table.
-
setTablePropertiesWarned
public void setTablePropertiesWarned(java.lang.String... properties)
-
setTablePropertiesWarned
public void setTablePropertiesWarned(java.util.Set<java.lang.String> properties)
- Specified by:
setTablePropertiesWarnedin interfaceGuardrailsMBean- Parameters:
properties- properties that are warned about when creating or altering a table.
-
setTablePropertiesWarnedCSV
public void setTablePropertiesWarnedCSV(java.lang.String properties)
- Specified by:
setTablePropertiesWarnedCSVin interfaceGuardrailsMBean- Parameters:
properties- Comma-separated list of properties that are warned about when creating or altering a table.
-
getTablePropertiesDisallowed
public java.util.Set<java.lang.String> getTablePropertiesDisallowed()
- Specified by:
getTablePropertiesDisallowedin interfaceGuardrailsMBean- Returns:
- properties that are not allowed when creating or altering a table.
-
getTablePropertiesDisallowedCSV
public java.lang.String getTablePropertiesDisallowedCSV()
- Specified by:
getTablePropertiesDisallowedCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of properties that are not allowed when creating or altering a table.
-
setTablePropertiesDisallowed
public void setTablePropertiesDisallowed(java.lang.String... properties)
-
setTablePropertiesDisallowed
public void setTablePropertiesDisallowed(java.util.Set<java.lang.String> properties)
- Specified by:
setTablePropertiesDisallowedin interfaceGuardrailsMBean- Parameters:
properties- properties that are not allowed when creating or altering a table.
-
setTablePropertiesDisallowedCSV
public void setTablePropertiesDisallowedCSV(java.lang.String properties)
- Specified by:
setTablePropertiesDisallowedCSVin interfaceGuardrailsMBean- Parameters:
properties- Comma-separated list of properties that are not allowed when creating or altering a table.
-
getTablePropertiesIgnored
public java.util.Set<java.lang.String> getTablePropertiesIgnored()
- Specified by:
getTablePropertiesIgnoredin interfaceGuardrailsMBean- Returns:
- properties that are ignored when creating or altering a table.
-
getTablePropertiesIgnoredCSV
public java.lang.String getTablePropertiesIgnoredCSV()
- Specified by:
getTablePropertiesIgnoredCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of properties that are ignored when creating or altering a table.
-
setTablePropertiesIgnored
public void setTablePropertiesIgnored(java.lang.String... properties)
-
setTablePropertiesIgnored
public void setTablePropertiesIgnored(java.util.Set<java.lang.String> properties)
- Specified by:
setTablePropertiesIgnoredin interfaceGuardrailsMBean- Parameters:
properties- properties that are ignored when creating or altering a table.
-
setTablePropertiesIgnoredCSV
public void setTablePropertiesIgnoredCSV(java.lang.String properties)
- Specified by:
setTablePropertiesIgnoredCSVin interfaceGuardrailsMBean- Parameters:
properties- Comma-separated list of properties that are ignored when creating or altering a table.
-
getUserTimestampsEnabled
public boolean getUserTimestampsEnabled()
Description copied from interface:GuardrailsMBeanReturns whether user-provided timestamps are allowed.- Specified by:
getUserTimestampsEnabledin interfaceGuardrailsMBean- Returns:
trueif user-provided timestamps are allowed,falseotherwise.
-
setUserTimestampsEnabled
public void setUserTimestampsEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether user-provided timestamps are allowed.- Specified by:
setUserTimestampsEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif user-provided timestamps are allowed,falseotherwise.
-
getAlterTableEnabled
public boolean getAlterTableEnabled()
Description copied from interface:GuardrailsMBeanGets whether users can use the ALTER TABLE statement to change columns- Specified by:
getAlterTableEnabledin interfaceGuardrailsMBean- Returns:
trueif ALTER TABLE is allowed,falseotherwise.
-
setAlterTableEnabled
public void setAlterTableEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether users can use the ALTER TABLE statement to change columns- Specified by:
setAlterTableEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif changing columns is allowed,falseotherwise.
-
getAllowFilteringEnabled
public boolean getAllowFilteringEnabled()
Description copied from interface:GuardrailsMBeanReturns whether ALLOW FILTERING property is allowed.- Specified by:
getAllowFilteringEnabledin interfaceGuardrailsMBean- Returns:
trueif ALLOW FILTERING is allowed,falseotherwise.
-
setAllowFilteringEnabled
public void setAllowFilteringEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether ALLOW FILTERING is allowed.- Specified by:
setAllowFilteringEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif ALLOW FILTERING is allowed,falseotherwise.
-
getSimpleStrategyEnabled
public boolean getSimpleStrategyEnabled()
Description copied from interface:GuardrailsMBeanReturns whether SimpleStrategy is allowed on keyspace creation or alteration- Specified by:
getSimpleStrategyEnabledin interfaceGuardrailsMBean- Returns:
trueif SimpleStrategy is allowed;falseotherwise
-
setSimpleStrategyEnabled
public void setSimpleStrategyEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether SimpleStrategy is allowed on keyspace creation or alteration- Specified by:
setSimpleStrategyEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif SimpleStrategy is allowed,falseotherwise.
-
getUncompressedTablesEnabled
public boolean getUncompressedTablesEnabled()
Description copied from interface:GuardrailsMBeanReturns whether users can disable compression on tables- Specified by:
getUncompressedTablesEnabledin interfaceGuardrailsMBean- Returns:
trueif users can disable compression on a table,falseotherwise.
-
setUncompressedTablesEnabled
public void setUncompressedTablesEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether users can disable compression on tables- Specified by:
setUncompressedTablesEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif users can disable compression on a table,falseotherwise.
-
getCompactTablesEnabled
public boolean getCompactTablesEnabled()
Description copied from interface:GuardrailsMBeanReturns whether users can create new COMPACT STORAGE tables- Specified by:
getCompactTablesEnabledin interfaceGuardrailsMBean- Returns:
trueif allowed,falseotherwise.
-
setCompactTablesEnabled
public void setCompactTablesEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether users can create new COMPACT STORAGE tables- Specified by:
setCompactTablesEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif allowed,falseotherwise.
-
getGroupByEnabled
public boolean getGroupByEnabled()
Description copied from interface:GuardrailsMBeanReturns whether GROUP BY queries are allowed.- Specified by:
getGroupByEnabledin interfaceGuardrailsMBean- Returns:
trueif allowed,falseotherwise.
-
setGroupByEnabled
public void setGroupByEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether GROUP BY queries are allowed.- Specified by:
setGroupByEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif allowed,falseotherwise.
-
getDropTruncateTableEnabled
public boolean getDropTruncateTableEnabled()
Description copied from interface:GuardrailsMBeanReturns whether users can TRUNCATE or DROP TABLE- Specified by:
getDropTruncateTableEnabledin interfaceGuardrailsMBean- Returns:
trueif allowed,falseotherwise.
-
setDropTruncateTableEnabled
public void setDropTruncateTableEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether users can TRUNCATE or DROP TABLE- Specified by:
setDropTruncateTableEnabledin interfaceGuardrailsMBean
-
getDropKeyspaceEnabled
public boolean getDropKeyspaceEnabled()
Description copied from interface:GuardrailsMBeanReturns whether users can DROP a keyspace- Specified by:
getDropKeyspaceEnabledin interfaceGuardrailsMBean- Returns:
trueif allowed,falseotherwise.
-
setDropKeyspaceEnabled
public void setDropKeyspaceEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether users can DROP a keyspace- Specified by:
setDropKeyspaceEnabledin interfaceGuardrailsMBean
-
getPageSizeWarnThreshold
public int getPageSizeWarnThreshold()
- Specified by:
getPageSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when requested page size greater than threshold. -1 means disabled.
-
getPageSizeFailThreshold
public int getPageSizeFailThreshold()
- Specified by:
getPageSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent requesting page with more elements than threshold. -1 means disabled.
-
setPageSizeThreshold
public void setPageSizeThreshold(int warn, int fail)- Specified by:
setPageSizeThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when the requested page size is greater than threshold. -1 means disabled.fail- The threshold to prevent requesting pages with more elements than threshold. -1 means disabled.
-
getReadBeforeWriteListOperationsEnabled
public boolean getReadBeforeWriteListOperationsEnabled()
Description copied from interface:GuardrailsMBeanReturns whether list operations that require read before write are allowed.- Specified by:
getReadBeforeWriteListOperationsEnabledin interfaceGuardrailsMBean- Returns:
trueif list operations that require read before write are allowed,falseotherwise.
-
setReadBeforeWriteListOperationsEnabled
public void setReadBeforeWriteListOperationsEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether list operations that require read before write are allowed.- Specified by:
setReadBeforeWriteListOperationsEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif list operations that require read before write are allowed,falseotherwise.
-
getPartitionKeysInSelectWarnThreshold
public int getPartitionKeysInSelectWarnThreshold()
- Specified by:
getPartitionKeysInSelectWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when the number of partition keys in a select statement greater than threshold. -1 means disabled.
-
getPartitionKeysInSelectFailThreshold
public int getPartitionKeysInSelectFailThreshold()
- Specified by:
getPartitionKeysInSelectFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when the number of partition keys in a select statement greater than threshold. -1 means disabled.
-
setPartitionKeysInSelectThreshold
public void setPartitionKeysInSelectThreshold(int warn, int fail)- Specified by:
setPartitionKeysInSelectThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when the number of partition keys in a select statement is greater than threshold -1 means disabled.fail- The threshold to prevent when the number of partition keys in a select statement is more than threshold -1 means disabled.
-
getPartitionSizeWarnThreshold
@Nullable public java.lang.String getPartitionSizeWarnThreshold()
- Specified by:
getPartitionSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when encountering partitions larger than threshold, as a string formatted as in,
for example,
10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
getPartitionSizeFailThreshold
@Nullable public java.lang.String getPartitionSizeFailThreshold()
- Specified by:
getPartitionSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when encountering partitions larger than threshold, as a string formatted as in,
for example,
10GiB,20MiB,30KiBor40B. Anullvalue means disabled. Triggering a failure emits a log message and a diagnostic event, but it doesn't throw an exception interrupting the offending sstable write.
-
setPartitionSizeThreshold
public void setPartitionSizeThreshold(@Nullable java.lang.String warnSize, @Nullable java.lang.String failSize)- Specified by:
setPartitionSizeThresholdin interfaceGuardrailsMBean- Parameters:
warnSize- The threshold to warn when encountering partitions larger than threshold, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled.failSize- The threshold to fail when encountering partitions larger than threshold, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled. Triggering a failure emits a log message and a diagnostic event, but it desn't throw an exception interrupting the offending sstable write.
-
getPartitionTombstonesWarnThreshold
public long getPartitionTombstonesWarnThreshold()
- Specified by:
getPartitionTombstonesWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when encountering partitions with more tombstones than threshold. -1 means disabled.
-
getPartitionTombstonesFailThreshold
public long getPartitionTombstonesFailThreshold()
- Specified by:
getPartitionTombstonesFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when encountering partitions with more tombstones than threshold. -1 means disabled. Triggering a failure emits a log message and a diagnostic event, but it doesn't throw an exception interrupting the offending sstable write.
-
setPartitionTombstonesThreshold
public void setPartitionTombstonesThreshold(long warn, long fail)- Specified by:
setPartitionTombstonesThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when encountering partitions with more tombstones than threshold. -1 means disabled.fail- The threshold to fail when encountering partitions with more tombstones than threshold. -1 means disabled. Triggering a failure emits a log message and a diagnostic event, but it desn't throw an exception interrupting the offending sstable write.
-
getColumnValueSizeWarnThreshold
@Nullable public java.lang.String getColumnValueSizeWarnThreshold()
- Specified by:
getColumnValueSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when encountering column values larger than threshold, as a string formatted as
in, for example,
10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
getColumnValueSizeFailThreshold
@Nullable public java.lang.String getColumnValueSizeFailThreshold()
- Specified by:
getColumnValueSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent column values larger than threshold, as a string formatted as in, for example,
10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
setColumnValueSizeThreshold
public void setColumnValueSizeThreshold(@Nullable java.lang.String warnSize, @Nullable java.lang.String failSize)- Specified by:
setColumnValueSizeThresholdin interfaceGuardrailsMBean- Parameters:
warnSize- The threshold to warn when encountering column values larger than threshold, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled.failSize- The threshold to prevent column values larger than threshold, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
getCollectionSizeWarnThreshold
@Nullable public java.lang.String getCollectionSizeWarnThreshold()
- Specified by:
getCollectionSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when encountering larger size of collection data than threshold, as a string
formatted as in, for example,
10GiB,20MiB,30KiBor40B. Anullvalue means that the threshold is disabled.
-
getCollectionSizeFailThreshold
@Nullable public java.lang.String getCollectionSizeFailThreshold()
- Specified by:
getCollectionSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent collections with larger data size than threshold, as a string formatted as in,
for example,
10GiB,20MiB,30KiBor40B. Anullvalue means that the threshold is disabled.
-
setCollectionSizeThreshold
public void setCollectionSizeThreshold(@Nullable java.lang.String warnSize, @Nullable java.lang.String failSize)- Specified by:
setCollectionSizeThresholdin interfaceGuardrailsMBean- Parameters:
warnSize- The threshold to warn when encountering larger size of collection data than threshold, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled.failSize- The threshold to prevent collections with larger data size than threshold, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
getItemsPerCollectionWarnThreshold
public int getItemsPerCollectionWarnThreshold()
- Specified by:
getItemsPerCollectionWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when encountering more elements in a collection than threshold.
-
getItemsPerCollectionFailThreshold
public int getItemsPerCollectionFailThreshold()
- Specified by:
getItemsPerCollectionFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent collections with more elements than threshold.
-
setItemsPerCollectionThreshold
public void setItemsPerCollectionThreshold(int warn, int fail)- Specified by:
setItemsPerCollectionThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when encountering more elements in a collection than threshold.fail- The threshold to prevent collectiosn with more elements than threshold.
-
getInSelectCartesianProductWarnThreshold
public int getInSelectCartesianProductWarnThreshold()
- Specified by:
getInSelectCartesianProductWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when an IN query creates a cartesian product with a size exceeding threshold. -1 means disabled.
-
getInSelectCartesianProductFailThreshold
public int getInSelectCartesianProductFailThreshold()
- Specified by:
getInSelectCartesianProductFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to prevent IN queries creating a cartesian product with a size exceeding threshold. -1 means disabled.
-
setInSelectCartesianProductThreshold
public void setInSelectCartesianProductThreshold(int warn, int fail)- Specified by:
setInSelectCartesianProductThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when an IN query creates a cartesian product with a size exceeding threshold. -1 means disabled.fail- The threshold to prevent IN queries creating a cartesian product with a size exceeding threshold. -1 means disabled.
-
getReadConsistencyLevelsWarned
public java.util.Set<java.lang.String> getReadConsistencyLevelsWarned()
- Specified by:
getReadConsistencyLevelsWarnedin interfaceGuardrailsMBean- Returns:
- consistency levels that are warned about when reading.
-
getReadConsistencyLevelsWarnedCSV
public java.lang.String getReadConsistencyLevelsWarnedCSV()
- Specified by:
getReadConsistencyLevelsWarnedCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of consistency levels that are warned about when reading.
-
setReadConsistencyLevelsWarned
public void setReadConsistencyLevelsWarned(java.util.Set<java.lang.String> consistencyLevels)
- Specified by:
setReadConsistencyLevelsWarnedin interfaceGuardrailsMBean- Parameters:
consistencyLevels- consistency levels that are warned about when reading.
-
setReadConsistencyLevelsWarnedCSV
public void setReadConsistencyLevelsWarnedCSV(java.lang.String consistencyLevels)
- Specified by:
setReadConsistencyLevelsWarnedCSVin interfaceGuardrailsMBean- Parameters:
consistencyLevels- Comma-separated list of consistency levels that are warned about when reading.
-
getReadConsistencyLevelsDisallowed
public java.util.Set<java.lang.String> getReadConsistencyLevelsDisallowed()
- Specified by:
getReadConsistencyLevelsDisallowedin interfaceGuardrailsMBean- Returns:
- consistency levels that are not allowed when reading.
-
getReadConsistencyLevelsDisallowedCSV
public java.lang.String getReadConsistencyLevelsDisallowedCSV()
- Specified by:
getReadConsistencyLevelsDisallowedCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of consistency levels that are not allowed when reading.
-
setReadConsistencyLevelsDisallowed
public void setReadConsistencyLevelsDisallowed(java.util.Set<java.lang.String> consistencyLevels)
- Specified by:
setReadConsistencyLevelsDisallowedin interfaceGuardrailsMBean- Parameters:
consistencyLevels- consistency levels that are not allowed when reading.
-
setReadConsistencyLevelsDisallowedCSV
public void setReadConsistencyLevelsDisallowedCSV(java.lang.String consistencyLevels)
- Specified by:
setReadConsistencyLevelsDisallowedCSVin interfaceGuardrailsMBean- Parameters:
consistencyLevels- Comma-separated list of consistency levels that are not allowed when reading.
-
getWriteConsistencyLevelsWarned
public java.util.Set<java.lang.String> getWriteConsistencyLevelsWarned()
- Specified by:
getWriteConsistencyLevelsWarnedin interfaceGuardrailsMBean- Returns:
- consistency levels that are warned about when writing.
-
getWriteConsistencyLevelsWarnedCSV
public java.lang.String getWriteConsistencyLevelsWarnedCSV()
- Specified by:
getWriteConsistencyLevelsWarnedCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of consistency levels that are warned about when writing.
-
setWriteConsistencyLevelsWarned
public void setWriteConsistencyLevelsWarned(java.util.Set<java.lang.String> consistencyLevels)
- Specified by:
setWriteConsistencyLevelsWarnedin interfaceGuardrailsMBean- Parameters:
consistencyLevels- consistency levels that are warned about when writing.
-
setWriteConsistencyLevelsWarnedCSV
public void setWriteConsistencyLevelsWarnedCSV(java.lang.String consistencyLevels)
- Specified by:
setWriteConsistencyLevelsWarnedCSVin interfaceGuardrailsMBean- Parameters:
consistencyLevels- Comma-separated list of consistency levels that are warned about when writing.
-
getWriteConsistencyLevelsDisallowed
public java.util.Set<java.lang.String> getWriteConsistencyLevelsDisallowed()
- Specified by:
getWriteConsistencyLevelsDisallowedin interfaceGuardrailsMBean- Returns:
- consistency levels that are not allowed when writing.
-
getWriteConsistencyLevelsDisallowedCSV
public java.lang.String getWriteConsistencyLevelsDisallowedCSV()
- Specified by:
getWriteConsistencyLevelsDisallowedCSVin interfaceGuardrailsMBean- Returns:
- Comma-separated list of consistency levels that are not allowed when writing.
-
setWriteConsistencyLevelsDisallowed
public void setWriteConsistencyLevelsDisallowed(java.util.Set<java.lang.String> consistencyLevels)
- Specified by:
setWriteConsistencyLevelsDisallowedin interfaceGuardrailsMBean- Parameters:
consistencyLevels- consistency levels that are not allowed when writing.
-
setWriteConsistencyLevelsDisallowedCSV
public void setWriteConsistencyLevelsDisallowedCSV(java.lang.String consistencyLevels)
- Specified by:
setWriteConsistencyLevelsDisallowedCSVin interfaceGuardrailsMBean- Parameters:
consistencyLevels- Comma-separated list of consistency levels that are not allowed when writing.
-
getFieldsPerUDTWarnThreshold
public int getFieldsPerUDTWarnThreshold()
- Specified by:
getFieldsPerUDTWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when creating a UDT with more fields than threshold. -1 means disabled.
-
getFieldsPerUDTFailThreshold
public int getFieldsPerUDTFailThreshold()
- Specified by:
getFieldsPerUDTFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when creating a UDT with more fields than threshold. -1 means disabled.
-
setFieldsPerUDTThreshold
public void setFieldsPerUDTThreshold(int warn, int fail)- Specified by:
setFieldsPerUDTThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when creating a UDT with more fields than threshold. -1 means disabled.fail- The threshold to prevent creating a UDT with more fields than threshold. -1 means disabled.
-
getVectorDimensionsWarnThreshold
public int getVectorDimensionsWarnThreshold()
- Specified by:
getVectorDimensionsWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when creating a vector with more dimensions than threshold.
-
getVectorDimensionsFailThreshold
public int getVectorDimensionsFailThreshold()
- Specified by:
getVectorDimensionsFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when creating a vector with more dimensions than threshold.
-
setVectorDimensionsThreshold
public void setVectorDimensionsThreshold(int warn, int fail)- Specified by:
setVectorDimensionsThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when creating a vector with more dimensions than threshold.fail- The threshold to prevent creating a vector with more dimensions than threshold.
-
setVectorTypeEnabled
public void setVectorTypeEnabled(boolean enabled)
- Specified by:
setVectorTypeEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif vector type usage is enabled.
-
getVectorTypeEnabled
public boolean getVectorTypeEnabled()
- Specified by:
getVectorTypeEnabledin interfaceGuardrailsMBean- Returns:
trueif vector type usage is enabled.
-
getMaximumReplicationFactorWarnThreshold
public int getMaximumReplicationFactorWarnThreshold()
- Specified by:
getMaximumReplicationFactorWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when replication factor is greater than threshold.
-
getMaximumReplicationFactorFailThreshold
public int getMaximumReplicationFactorFailThreshold()
- Specified by:
getMaximumReplicationFactorFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when replication factor is greater than threshold.
-
setMaximumReplicationFactorThreshold
public void setMaximumReplicationFactorThreshold(int warn, int fail)- Specified by:
setMaximumReplicationFactorThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when the maximum replication factor is greater than threshold. -1 means disabled.fail- The threshold to fail when the maximum replication factor is greater than threshold. -1 means disabled.
-
getDataDiskUsagePercentageWarnThreshold
public int getDataDiskUsagePercentageWarnThreshold()
- Specified by:
getDataDiskUsagePercentageWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when local data disk usage percentage exceeds that threshold.
Allowed values are in the range
[1, 100], and -1 means disabled.
-
getDataDiskUsagePercentageFailThreshold
public int getDataDiskUsagePercentageFailThreshold()
- Specified by:
getDataDiskUsagePercentageFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when local data disk usage percentage exceeds that threshold.
Allowed values are in the range
[1, 100], and -1 means disabled.
-
setDataDiskUsagePercentageThreshold
public void setDataDiskUsagePercentageThreshold(int warn, int fail)- Specified by:
setDataDiskUsagePercentageThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when local disk usage percentage exceeds that threshold. Allowed values are in the range[1, 100], and -1 means disabled.fail- The threshold to fail when local disk usage percentage exceeds that threshold. Allowed values are in the range[1, 100], and -1 means disabled.
-
getDataDiskUsageMaxDiskSize
@Nullable public java.lang.String getDataDiskUsageMaxDiskSize()
- Specified by:
getDataDiskUsageMaxDiskSizein interfaceGuardrailsMBean- Returns:
- The max disk size of the data directories when calculating disk usage thresholds, as a string formatted
as in, for example,
10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
setDataDiskUsageMaxDiskSize
public void setDataDiskUsageMaxDiskSize(@Nullable java.lang.String size)- Specified by:
setDataDiskUsageMaxDiskSizein interfaceGuardrailsMBean- Parameters:
size- The max disk size of the data directories when calculating disk usage thresholds, as a string formatted as in, for example,10GiB,20MiB,30KiBor40B. Anullvalue means disabled.
-
getMinimumReplicationFactorWarnThreshold
public int getMinimumReplicationFactorWarnThreshold()
- Specified by:
getMinimumReplicationFactorWarnThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to warn when replication factor is lesser than threshold.
-
getMinimumReplicationFactorFailThreshold
public int getMinimumReplicationFactorFailThreshold()
- Specified by:
getMinimumReplicationFactorFailThresholdin interfaceGuardrailsMBean- Returns:
- The threshold to fail when replication factor is lesser than threshold.
-
setMinimumReplicationFactorThreshold
public void setMinimumReplicationFactorThreshold(int warn, int fail)- Specified by:
setMinimumReplicationFactorThresholdin interfaceGuardrailsMBean- Parameters:
warn- The threshold to warn when the minimum replication factor is lesser than threshold. -1 means disabled.fail- The threshold to fail when the minimum replication factor is lesser than threshold. -1 means disabled.
-
getZeroTTLOnTWCSEnabled
public boolean getZeroTTLOnTWCSEnabled()
Description copied from interface:GuardrailsMBeanReturns whether it is allowed to create or alter table to use 0 default TTL with TimeWindowCompactionStrategy. If it is not, such query will fail.- Specified by:
getZeroTTLOnTWCSEnabledin interfaceGuardrailsMBean- Returns:
trueif 0 default TTL is allowed on TWCS table,falseotherwise.
-
setZeroTTLOnTWCSEnabled
public void setZeroTTLOnTWCSEnabled(boolean value)
Description copied from interface:GuardrailsMBeanSets whether users can use 0 default TTL on a table with TimeWindowCompactionStrategy.- Specified by:
setZeroTTLOnTWCSEnabledin interfaceGuardrailsMBean- Parameters:
value-trueif 0 default TTL on TWCS tables is allowed,falseotherwise.
-
getZeroTTLOnTWCSWarned
public boolean getZeroTTLOnTWCSWarned()
Description copied from interface:GuardrailsMBeanReturns whether warnings will be emitted when usage of 0 default TTL on a table with TimeWindowCompactionStrategy is detected.- Specified by:
getZeroTTLOnTWCSWarnedin interfaceGuardrailsMBean- Returns:
trueif warnings will be emitted,falseotherwise.
-
setZeroTTLOnTWCSWarned
public void setZeroTTLOnTWCSWarned(boolean value)
Description copied from interface:GuardrailsMBeanSets whether warnings will be emitted when usage of 0 default TTL on a table with TimeWindowCompactionStrategy is detected.- Specified by:
setZeroTTLOnTWCSWarnedin interfaceGuardrailsMBean- Parameters:
value-trueif warning will be emitted,falseotherwise.
-
getMaximumTimestampWarnThreshold
public java.lang.String getMaximumTimestampWarnThreshold()
- Specified by:
getMaximumTimestampWarnThresholdin interfaceGuardrailsMBean- Returns:
- The highest acceptable difference between now and the written value timestamp before triggering a warning.
Expressed as a string formatted as in, for example,
10s20m,30hor40d. Anullvalue means disabled.
-
getMaximumTimestampFailThreshold
public java.lang.String getMaximumTimestampFailThreshold()
- Specified by:
getMaximumTimestampFailThresholdin interfaceGuardrailsMBean- Returns:
- The highest acceptable difference between now and the written value timestamp before triggering a failure.
Expressed as a string formatted as in, for example,
10s20m,30hor40d. Anullvalue means disabled.
-
setMaximumTimestampThreshold
public void setMaximumTimestampThreshold(java.lang.String warnSeconds, java.lang.String failSeconds)Description copied from interface:GuardrailsMBeanSets the warning upper bound for user supplied timestamps.- Specified by:
setMaximumTimestampThresholdin interfaceGuardrailsMBean- Parameters:
warnSeconds- The highest acceptable difference between now and the written value timestamp before triggering a warning. Expressed as a string formatted as in, for example,10s,20m,30hor40d. Anullvalue means disabled.failSeconds- The highest acceptable difference between now and the written value timestamp before triggering a failure. Expressed as a string formatted as in, for example,10s,20m,30hor40d. Anullvalue means disabled.
-
getMinimumTimestampWarnThreshold
public java.lang.String getMinimumTimestampWarnThreshold()
- Specified by:
getMinimumTimestampWarnThresholdin interfaceGuardrailsMBean- Returns:
- The lowest acceptable difference between now and the written value timestamp before triggering a warning.
Expressed as a string formatted as in, for example,
10s20m,30hor40d. Anullvalue means disabled.
-
getMinimumTimestampFailThreshold
public java.lang.String getMinimumTimestampFailThreshold()
- Specified by:
getMinimumTimestampFailThresholdin interfaceGuardrailsMBean- Returns:
- The lowest acceptable difference between now and the written value timestamp before triggering a failure.
Expressed as a string formatted as in, for example,
10s20m,30hor40d. Anullvalue means disabled.
-
setMinimumTimestampThreshold
public void setMinimumTimestampThreshold(java.lang.String warnSeconds, java.lang.String failSeconds)Description copied from interface:GuardrailsMBeanSets the warning lower bound for user supplied timestamps.- Specified by:
setMinimumTimestampThresholdin interfaceGuardrailsMBean- Parameters:
warnSeconds- The lowest acceptable difference between now and the written value timestamp before triggering a warning. Expressed as a string formatted as in, for example,10s,20m,30hor40d. Anullvalue means disabled.failSeconds- The lowest acceptable difference between now and the written value timestamp before triggering a failure. Expressed as a string formatted as in, for example,10s,20m,30hor40d. Anullvalue means disabled.
-
getSaiSSTableIndexesPerQueryWarnThreshold
public int getSaiSSTableIndexesPerQueryWarnThreshold()
- Specified by:
getSaiSSTableIndexesPerQueryWarnThresholdin interfaceGuardrailsMBean- Returns:
- the warning threshold for the number of SAI SSTable indexes searched by a query
-
getSaiSSTableIndexesPerQueryFailThreshold
public int getSaiSSTableIndexesPerQueryFailThreshold()
- Specified by:
getSaiSSTableIndexesPerQueryFailThresholdin interfaceGuardrailsMBean- Returns:
- the failure threshold for the number of SAI SSTable indexes searched by a query
-
setSaiSSTableIndexesPerQueryThreshold
public void setSaiSSTableIndexesPerQueryThreshold(int warn, int fail)Description copied from interface:GuardrailsMBeanSets warning and failure thresholds for the number of SAI SSTable indexes searched by a query- Specified by:
setSaiSSTableIndexesPerQueryThresholdin interfaceGuardrailsMBean- Parameters:
warn- value to set for warn thresholdfail- value to set for fail threshold
-
getSaiStringTermSizeWarnThreshold
@Nullable public java.lang.String getSaiStringTermSizeWarnThreshold()
- Specified by:
getSaiStringTermSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The warning threshold for string terms written to an SAI index, as a human-readable string.
(ex.
10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
getSaiStringTermSizeFailThreshold
@Nullable public java.lang.String getSaiStringTermSizeFailThreshold()
- Specified by:
getSaiStringTermSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The failure threshold for string terms written to an SAI index, as a human-readable string.
(ex.
10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
setSaiStringTermSizeThreshold
public void setSaiStringTermSizeThreshold(@Nullable java.lang.String warnSize, @Nullable java.lang.String failSize)- Specified by:
setSaiStringTermSizeThresholdin interfaceGuardrailsMBean- Parameters:
warnSize- The warning threshold for string terms written to an SAI index, as a human-readable string. (ex.10GiB,20MiB,30KiBor40B) Anullvalue means disabled.failSize- The failure threshold for string terms written to an SAI index, as a human-readable string. (ex.10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
getSaiFrozenTermSizeWarnThreshold
@Nullable public java.lang.String getSaiFrozenTermSizeWarnThreshold()
- Specified by:
getSaiFrozenTermSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The warning threshold for frozen terms written to an SAI index, as a human-readable string.
(ex.
10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
getSaiFrozenTermSizeFailThreshold
@Nullable public java.lang.String getSaiFrozenTermSizeFailThreshold()
- Specified by:
getSaiFrozenTermSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The failure threshold for frozen terms written to an SAI index, as a human-readable string.
(ex.
10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
setSaiFrozenTermSizeThreshold
public void setSaiFrozenTermSizeThreshold(@Nullable java.lang.String warnSize, @Nullable java.lang.String failSize)- Specified by:
setSaiFrozenTermSizeThresholdin interfaceGuardrailsMBean- Parameters:
warnSize- The warning threshold for frozen terms written to an SAI index, as a human-readable string. (ex.10GiB,20MiB,30KiBor40B) Anullvalue means disabled.failSize- The failure threshold for frozen terms written to an SAI index, as a human-readable string. (ex.10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
getSaiVectorTermSizeWarnThreshold
@Nullable public java.lang.String getSaiVectorTermSizeWarnThreshold()
- Specified by:
getSaiVectorTermSizeWarnThresholdin interfaceGuardrailsMBean- Returns:
- The warning threshold for vector terms written to an SAI index, as a human-readable string.
(ex.
10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
getSaiVectorTermSizeFailThreshold
@Nullable public java.lang.String getSaiVectorTermSizeFailThreshold()
- Specified by:
getSaiVectorTermSizeFailThresholdin interfaceGuardrailsMBean- Returns:
- The failure threshold for vector terms written to an SAI index, as a human-readable string.
(ex.
10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
setSaiVectorTermSizeThreshold
public void setSaiVectorTermSizeThreshold(@Nullable java.lang.String warnSize, @Nullable java.lang.String failSize)- Specified by:
setSaiVectorTermSizeThresholdin interfaceGuardrailsMBean- Parameters:
warnSize- The warning threshold for vector terms written to an SAI index, as a human-readable string. (ex.10GiB,20MiB,30KiBor40B) Anullvalue means disabled.failSize- The failure threshold for vector terms written to an SAI index, as a human-readable string. (ex.10GiB,20MiB,30KiBor40B) Anullvalue means disabled.
-
getNonPartitionRestrictedQueryEnabled
public boolean getNonPartitionRestrictedQueryEnabled()
Description copied from interface:GuardrailsMBeanReturns whether it is possible to execute a query against secondary indexes without specifying any partition key restrictions.- Specified by:
getNonPartitionRestrictedQueryEnabledin interfaceGuardrailsMBean- Returns:
- true if it is possible to execute a query without a partition key, false otherwise
-
setNonPartitionRestrictedQueryEnabled
public void setNonPartitionRestrictedQueryEnabled(boolean enabled)
Description copied from interface:GuardrailsMBeanSets whether it is possible to execute a query against indexes (secondary or SAI) without specifying any partition key restrictions.- Specified by:
setNonPartitionRestrictedQueryEnabledin interfaceGuardrailsMBean- Parameters:
enabled-trueif a query without partition key is enabled or not
-
getIntersectFilteringQueryWarned
public boolean getIntersectFilteringQueryWarned()
- Specified by:
getIntersectFilteringQueryWarnedin interfaceGuardrailsMBean- Returns:
- true if a client warning is emitted for a filtering query with an intersection on mutable columns at a consistency level requiring coordinator reconciliation
-
setIntersectFilteringQueryWarned
public void setIntersectFilteringQueryWarned(boolean value)
- Specified by:
setIntersectFilteringQueryWarnedin interfaceGuardrailsMBean
-
getIntersectFilteringQueryEnabled
public boolean getIntersectFilteringQueryEnabled()
- Specified by:
getIntersectFilteringQueryEnabledin interfaceGuardrailsMBean- Returns:
- true if it is possible to execute a filtering query with an intersection on mutable columns at a consistency level requiring coordinator reconciliation
-
setIntersectFilteringQueryEnabled
public void setIntersectFilteringQueryEnabled(boolean value)
- Specified by:
setIntersectFilteringQueryEnabledin interfaceGuardrailsMBean
-
-