Class: Cassandra::ColumnContainer::Options

Inherits:

Object

• Object
• Cassandra::ColumnContainer::Options

Defined in:

lib/cassandra/column_container.rb

Overview

Encapsulates all of the configuration options of a column-container.

Instance Attribute Summary

• #bloom_filter_fp_chance ⇒ Float readonly

  The false positive chance for the Bloom filter of this column-container.

• #caching ⇒ Hash readonly

  The caching options for this column-container.

• #cdc ⇒ Object readonly

  Whether or not change data capture is enabled on this table.

• #comment ⇒ String readonly

  The comment attribute of this column-container.

• #compaction_strategy ⇒ ColumnContainer::Compaction readonly

  The compaction strategy of this column-container.

• #compression ⇒ Hash readonly

  Compression settings.

• #crc_check_chance ⇒ Float readonly

  When compression is enabled, this option defines the probability with which checksums for compressed blocks are checked during reads.

• #default_time_to_live ⇒ Integer readonly

  The default TTL for this column-container.

• #extensions ⇒ Hash readonly

  The extension options of this column-container.

• #gc_grace_seconds ⇒ Integer readonly

  The tombstone garbage collection grace time in seconds for this column-container.

• #index_interval ⇒ Integer readonly

  Return the index interval of this column-container; Cassandra will hold 1/index_interval of row keys in memory.

• #local_read_repair_chance ⇒ Float readonly

  The cluster local read repair chance for this column-container.

• #memtable_flush_period_in_ms ⇒ Integer readonly

  How often (in milliseconds) to flush the memtable of this column-container.

• #read_repair_chance ⇒ Float readonly

  The chance with which a read repair is triggered for this column-container.

• #speculative_retry ⇒ String readonly

  Return the speculative retry setting of this column-container, which determines how much response delay the coordinator node will tolerate from the chosen replica before retrying the request on other replicas.

Instance Method Summary

• #compact_storage? ⇒ Boolean

  Whether this column-container uses compact storage.

• #populate_io_cache_on_flush? ⇒ Boolean

  Whether to populate the I/O cache on flush of this column-container.

• #replicate_on_write? ⇒ Boolean

  Return whether to replicate counter updates to other replicas.

Instance Attribute Details

#bloom_filter_fp_chance ⇒ Float (readonly)

# File 'lib/cassandra/column_container.rb', line 35

def bloom_filter_fp_chance
  @bloom_filter_fp_chance
end

#caching ⇒ Hash (readonly)

# File 'lib/cassandra/column_container.rb', line 33

def caching
  @caching
end

#cdc ⇒ Object (readonly)

# File 'lib/cassandra/column_container.rb', line 64

def cdc
  @cdc
end

#comment ⇒ String (readonly)

# File 'lib/cassandra/column_container.rb', line 25

def comment
  @comment
end

#compaction_strategy ⇒ ColumnContainer::Compaction (readonly)

# File 'lib/cassandra/column_container.rb', line 61

def compaction_strategy
  @compaction_strategy
end

#compression ⇒ Hash (readonly)

# File 'lib/cassandra/column_container.rb', line 52

def compression
  @compression
end

#crc_check_chance ⇒ Float (readonly)

When compression is enabled, this option defines the probability with which checksums for compressed blocks are checked during reads.

# File 'lib/cassandra/column_container.rb', line 56

def crc_check_chance
  @crc_check_chance
end

#default_time_to_live ⇒ Integer (readonly)

# File 'lib/cassandra/column_container.rb', line 39

def default_time_to_live
  @default_time_to_live
end

#extensions ⇒ Hash (readonly)

# File 'lib/cassandra/column_container.rb', line 58

def extensions
  @extensions
end

#gc_grace_seconds ⇒ Integer (readonly)

# File 'lib/cassandra/column_container.rb', line 31

def gc_grace_seconds
  @gc_grace_seconds
end

#index_interval ⇒ Integer (readonly)

Return the index interval of this column-container; Cassandra will hold 1/index_interval of row keys in memory.

# File 'lib/cassandra/column_container.rb', line 50

def index_interval
  @index_interval
end

#local_read_repair_chance ⇒ Float (readonly)

# File 'lib/cassandra/column_container.rb', line 29

def local_read_repair_chance
  @local_read_repair_chance
end

#memtable_flush_period_in_ms ⇒ Integer (readonly)

# File 'lib/cassandra/column_container.rb', line 37

def memtable_flush_period_in_ms
  @memtable_flush_period_in_ms
end

#read_repair_chance ⇒ Float (readonly)

# File 'lib/cassandra/column_container.rb', line 27

def read_repair_chance
  @read_repair_chance
end

#speculative_retry ⇒ String (readonly)

Return the speculative retry setting of this column-container, which determines how much response delay the coordinator node will tolerate from the chosen replica before retrying the request on other replicas. This setting can be expressed as a fixed delay in ms (e.g. 10ms) or as a percentile indicating "when the response time has exceeded the Nth percentile of read response times for this object" (e.g. 99percentile).

# File 'lib/cassandra/column_container.rb', line 46

def speculative_retry
  @speculative_retry
end

Instance Method Details

#compact_storage? ⇒ Boolean

# File 'lib/cassandra/column_container.rb', line 124

def compact_storage?
  @compact_storage
end

#populate_io_cache_on_flush? ⇒ Boolean

# File 'lib/cassandra/column_container.rb', line 119

def populate_io_cache_on_flush?
  @populate_io_cache_on_flush
end

#replicate_on_write? ⇒ Boolean

Return whether to replicate counter updates to other replicas. It is strongly recommended that this setting be true. Otherwise, counter updates are only written to one replica and fault tolerance is sacrificed.

# File 'lib/cassandra/column_container.rb', line 113

def replicate_on_write?
  @replicate_on_write
end