RelationOptions (DataStax Java driver for Apache Cassandra(R) 4.17.0 API)

All Superinterfaces:

OptionProvider<SelfT>

All Known Subinterfaces:

AlterDseTableStart, AlterDseTableWithOptions, AlterDseTableWithOptionsEnd, AlterMaterializedView, AlterMaterializedViewStart, AlterTableStart, AlterTableWithOptions, AlterTableWithOptionsEnd, CreateDseTable, CreateDseTableWithOptions, CreateMaterializedView, CreateMaterializedViewPrimaryKey, CreateTable, CreateTableWithOptions, DseRelationOptions<SelfT>, DseRelationStructure<SelfT>, RelationStructure<SelfT>
```
public interface RelationOptions<SelfT extends RelationOptions<SelfT>>
extends OptionProvider<SelfT>
```

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SelfT`	`withBloomFilterFpChance(double bloomFilterFpChance)` Defines the false-positive probability for SSTable bloom filters.
`default SelfT`	`withCaching(boolean keys, SchemaBuilder.RowsPerPartition rowsPerPartition)` Defines the caching criteria.
`default SelfT`	`withCDC(boolean enabled)` Defines whether or not change data capture is enabled.
`default SelfT`	`withComment(String comment)` Defines documentation for this relation.
`default SelfT`	`withCompaction(CompactionStrategy<?> compactionStrategy)` Defines the compaction strategy to use.
`default SelfT`	`withCompression(String compressionAlgorithmName)` Configures compression using the given algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
`default SelfT`	`withCompression(String compressionAlgorithmName, int chunkLengthKB, double crcCheckChance)` Configures compression using the given algorithm, chunk length and crc check chance.
`default SelfT`	`withDcLocalReadRepairChance(double dcLocalReadRepairChance)` Defines the probability of read repairs being invoked over all replicas in the current data center.
`default SelfT`	`withDefaultTimeToLiveSeconds(int ttl)` Defines the default 'time to live' (expiration time) of writes in seconds.
`default SelfT`	`withDeflateCompression()` Configures compression using the Deflate algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
`default SelfT`	`withDeflateCompression(int chunkLengthKB, double crcCheckChance)` Configures compression using the Deflate algorithm with the given chunk length and crc check chance.
`default SelfT`	`withGcGraceSeconds(int gcGraceSeconds)` Defines the time to wait before garbage collecting tombstones (deletion markers).
`default SelfT`	`withLZ4Compression()` Configures compression using the LZ4 algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
`default SelfT`	`withLZ4Compression(int chunkLengthKB, double crcCheckChance)` Configures compression using the LZ4 algorithm with the given chunk length and crc check chance.
`default SelfT`	`withMaxIndexInterval(int max)` Defines the maximum index interval.
`default SelfT`	`withMemtableFlushPeriodInMs(int memtableFlushPeriodInMs)` Defines the memtable flush period in milliseconds.
`default SelfT`	`withMinIndexInterval(int min)` Defines the minimum index interval.
`default SelfT`	`withNoCompression()` Defines that compression should be disabled.
`default SelfT`	`withReadRepairChance(double readRepairChance)` Defines the probability with which read repairs should be invoked on non-quorum reads.
`default SelfT`	`withSnappyCompression()` Configures compression using the Snappy algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
`default SelfT`	`withSnappyCompression(int chunkLengthKB, double crcCheckChance)` Configures compression using the Snappy algorithm with the given chunk length and crc check chance.
`default SelfT`	`withSpeculativeRetry(String speculativeRetry)` Defines the configuration for coordinator to replica speculative retries.

Methods inherited from interface com.datastax.oss.driver.api.querybuilder.schema.OptionProvider
getOptions, withOption

- Method Detail
  - withBloomFilterFpChance
```
@NonNull
 @CheckReturnValue
default SelfT withBloomFilterFpChance(double bloomFilterFpChance)
```
    Defines the false-positive probability for SSTable bloom filters.
    If no call was made to this method, the default value set is:
    - 0.01 for the size-tiered compaction strategy;
    - 0.1 for the leveled compaction strategy.
  - withCDC
```
@NonNull
 @CheckReturnValue
default SelfT withCDC(boolean enabled)
```
    Defines whether or not change data capture is enabled.
    Note that using this option with a version of Apache Cassandra less than 3.8 or DataStax Enterprise 5.0 will raise a syntax error.
    If no call is made to this method, the default value set is false.
  - withCaching
```
@NonNull
 @CheckReturnValue
default SelfT withCaching(boolean keys,
                                                      @NonNull
                                                      SchemaBuilder.RowsPerPartition rowsPerPartition)
```
    Defines the caching criteria.
    If no call is made to this method, the default value is determined by the global caching properties in cassandra.yaml.
    
    Parameters:
    
    keys - If true, caches all keys, otherwise none.
    
    rowsPerPartition - Whether to cache ALL, NONE or the first N rows per partition.
  - withComment
```
@NonNull
 @CheckReturnValue
default SelfT withComment(@NonNull
                                                      String comment)
```
    Defines documentation for this relation.
  - withCompaction
```
@NonNull
 @CheckReturnValue
default SelfT withCompaction(@NonNull
                                                         CompactionStrategy<?> compactionStrategy)
```
    Defines the compaction strategy to use.
    
    See Also:
    
    SchemaBuilder.sizeTieredCompactionStrategy(), SchemaBuilder.leveledCompactionStrategy(), SchemaBuilder.timeWindowCompactionStrategy()
  - withLZ4Compression
```
@NonNull
 @CheckReturnValue
default SelfT withLZ4Compression(int chunkLengthKB,
                                                             double crcCheckChance)
```
    Configures compression using the LZ4 algorithm with the given chunk length and crc check chance.
    
    See Also:
    
    withCompression(String, int, double)
  - withLZ4Compression
```
@NonNull
 @CheckReturnValue
default SelfT withLZ4Compression()
```
    Configures compression using the LZ4 algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
    
    See Also:
    
    withCompression(String, int, double)
  - withSnappyCompression
```
@NonNull
 @CheckReturnValue
default SelfT withSnappyCompression(int chunkLengthKB,
                                                                double crcCheckChance)
```
    Configures compression using the Snappy algorithm with the given chunk length and crc check chance.
    
    See Also:
    
    withCompression(String, int, double)
  - withSnappyCompression
```
@NonNull
 @CheckReturnValue
default SelfT withSnappyCompression()
```
    Configures compression using the Snappy algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
    
    See Also:
    
    withCompression(String, int, double)
  - withDeflateCompression
```
@NonNull
 @CheckReturnValue
default SelfT withDeflateCompression(int chunkLengthKB,
                                                                 double crcCheckChance)
```
    Configures compression using the Deflate algorithm with the given chunk length and crc check chance.
    
    See Also:
    
    withCompression(String, int, double)
  - withDeflateCompression
```
@NonNull
 @CheckReturnValue
default SelfT withDeflateCompression()
```
    Configures compression using the Deflate algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
    
    See Also:
    
    withCompression(String, int, double)
  - withCompression
```
@NonNull
 @CheckReturnValue
default SelfT withCompression(@NonNull
                                                          String compressionAlgorithmName)
```
    Configures compression using the given algorithm using the default configuration (64kb chunk_length, and 1.0 crc_check_chance).
    Unless specifying a custom compression algorithm implementation, it is recommended to use withLZ4Compression(), withSnappyCompression(), or withDeflateCompression().
    
    See Also:
    
    withCompression(String, int, double)
  - withCompression
```
@NonNull
 @CheckReturnValue
default SelfT withCompression(@NonNull
                                                          String compressionAlgorithmName,
                                                          int chunkLengthKB,
                                                          double crcCheckChance)
```
    Configures compression using the given algorithm, chunk length and crc check chance.
    Unless specifying a custom compression algorithm implementation, it is recommended to use withLZ4Compression(), withSnappyCompression(), or withDeflateCompression().
    
    Parameters:
    
    compressionAlgorithmName - The class name of the compression algorithm.
    
    chunkLengthKB - The chunk length in KB of compression blocks. Defaults to 64.
    
    crcCheckChance - The probability (0.0 to 1.0) that checksum will be checked on each read. Defaults to 1.0.
  - withNoCompression
```
@NonNull
 @CheckReturnValue
default SelfT withNoCompression()
```
    Defines that compression should be disabled.
  - withDcLocalReadRepairChance
```
@NonNull
 @CheckReturnValue
default SelfT withDcLocalReadRepairChance(double dcLocalReadRepairChance)
```
    Defines the probability of read repairs being invoked over all replicas in the current data center.
    If no call is made to this method, the default value set is 0.0.
    
    Parameters:
    
    dcLocalReadRepairChance - the probability.
    
    Returns:
    
    this TableOptions object.
  - withDefaultTimeToLiveSeconds
```
@NonNull
 @CheckReturnValue
default SelfT withDefaultTimeToLiveSeconds(int ttl)
```
    Defines the default 'time to live' (expiration time) of writes in seconds.
    If no call is made to this method, the default value is 0 (no TTL).
  - withGcGraceSeconds
```
@NonNull
 @CheckReturnValue
default SelfT withGcGraceSeconds(int gcGraceSeconds)
```
    Defines the time to wait before garbage collecting tombstones (deletion markers).
    The default value allows a great deal of time for consistency to be achieved prior to deletion. In many deployments this interval can be reduced, and in a single-node cluster it can be safely set to zero.
    If no call is made to this method, the default value set is 864000 secs (10 days).
  - withMemtableFlushPeriodInMs
```
@NonNull
 @CheckReturnValue
default SelfT withMemtableFlushPeriodInMs(int memtableFlushPeriodInMs)
```
    Defines the memtable flush period in milliseconds.
    If set, this forces flushing of memtables after the specified time elapses.
    If no call is made to this method, the default value is 0 (unset).
  - withMinIndexInterval
```
@NonNull
 @CheckReturnValue
default SelfT withMinIndexInterval(int min)
```
    Defines the minimum index interval. This is the gap between index entries in the index summary. A lower value will increase the size of the index (more RAM usage) but potentially improve disk I/O.
    If no call is made to this method, the default value set is 128.
  - withMaxIndexInterval
```
@NonNull
 @CheckReturnValue
default SelfT withMaxIndexInterval(int max)
```
    Defines the maximum index interval.
    If no call is made to this method, the default value set is 2048.
    
    See Also:
    
    withMinIndexInterval(int)
  - withReadRepairChance
```
@NonNull
 @CheckReturnValue
default SelfT withReadRepairChance(double readRepairChance)
```
    Defines the probability with which read repairs should be invoked on non-quorum reads. The value must be between 0 and 1.
    If no call is made to this method, the default value set is 0.1.
  - withSpeculativeRetry
```
@NonNull
 @CheckReturnValue
default SelfT withSpeculativeRetry(@NonNull
                                                               String speculativeRetry)
```
    Defines the configuration for coordinator to replica speculative retries.
    This overrides the normal read timeout when read_repair_chance is not 1.0, sending a request to other replica(s) to service reads.
    Valid values include:
    - ALWAYS: Retry reads of all replicas.
    - Xpercentile: Retry reads based on the effect on throughput and latency.
    - Yms: Retry reads after specified milliseconds.
    - NONE: Do not retry reads.
    Using the speculative retry property, you can configure rapid read protection in Cassandra 2.0.2 and later. Use this property to retry a request after some milliseconds have passed or after a percentile of the typical read latency has been reached, which is tracked per table.
    If no call is made to this method, the default value set is 99percentile.

Interface RelationOptions<SelfT extends RelationOptions<SelfT>>

Method Summary

Methods inherited from interface com.datastax.oss.driver.api.querybuilder.schema.OptionProvider

Method Detail

withBloomFilterFpChance

withCDC

withCaching

withComment

withCompaction

withLZ4Compression

withLZ4Compression

withSnappyCompression

withSnappyCompression

withDeflateCompression

withDeflateCompression

withCompression

withCompression

withNoCompression

withDcLocalReadRepairChance

withDefaultTimeToLiveSeconds

withGcGraceSeconds

withMemtableFlushPeriodInMs

withMinIndexInterval

withMaxIndexInterval

withReadRepairChance

withSpeculativeRetry