Class: Cassandra::ColumnContainer::Options

Inherits:
Object
  • Object
show all
Defined in:
lib/cassandra/column_container.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#bloom_filter_fp_chance ⇒ Float (readonly)

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

Returns:

  • (Float) —

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



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

def bloom_filter_fp_chance
  @bloom_filter_fp_chance
end

#caching ⇒ Hash (readonly)

Returns the caching options for this column-container.

Returns:

  • (Hash) —

    the caching options for this column-container.



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

def caching
  @caching
end

#cdc ⇒ Object (readonly)

Returns whether or not change data capture is enabled on this table.

Returns:

  • whether or not change data capture is enabled on this table.



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

def cdc
  @cdc
end

#comment ⇒ String (readonly)

Returns the comment attribute of this column-container.

Returns:

  • (String) —

    the comment attribute of this column-container.



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

def comment
  @comment
end

#compaction_strategy ⇒ ColumnContainer::Compaction (readonly)

Returns the compaction strategy of this column-container.

Returns:



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

def compaction_strategy
  @compaction_strategy
end

#compression ⇒ Hash (readonly)

Returns compression settings.

Returns:

  • (Hash) —

    compression settings



52
53
54
 
# 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.

Returns:

  • (Float) —

    the probability of checking checksums on compressed blocks.



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

def crc_check_chance
  @crc_check_chance
end

#default_time_to_live ⇒ Integer (readonly)

Returns the default TTL for this column-container.

Returns:

  • (Integer) —

    the default TTL for this column-container.



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

def default_time_to_live
  @default_time_to_live
end

#extensions ⇒ Hash (readonly)

Returns the extension options of this column-container.

Returns:

  • (Hash) —

    the extension options of this column-container.



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

def extensions
  @extensions
end

#gc_grace_seconds ⇒ Integer (readonly)

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

Returns:

  • (Integer) —

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



31
32
33
 
# 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.

Returns:

  • (Integer) —

    the index interval of this column-container. May be nil, indicating a default value of 128.



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

def index_interval
  @index_interval
end

#local_read_repair_chance ⇒ Float (readonly)

Returns the cluster local read repair chance for this column-container.

Returns:

  • (Float) —

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



29
30
31
 
# 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)

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

Returns:

  • (Integer) —

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



37
38
39
 
# 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)

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

Returns:

  • (Float) —

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



27
28
29
 
# 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).

Returns:

  • (String) —

    the speculative retry setting of this column-container.



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

def speculative_retry
  @speculative_retry
end

Instance Method Details

#compact_storage? ⇒ Boolean

Returns whether this column-container uses compact storage.

Returns:

  • (Boolean) —

    whether this column-container uses compact storage.



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

def compact_storage?
  @compact_storage
end

#populate_io_cache_on_flush? ⇒ Boolean

Returns whether to populate the I/O cache on flush of this column-container. May be nil, indicating a default value of false.

Returns:

  • (Boolean) —

    whether to populate the I/O cache on flush of this column-container. May be nil, indicating a default value of false.



119
120
121
 
# 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.

Returns:

  • (Boolean) —

    whether to replicate counter updates to other replicas.



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

def replicate_on_write?
  @replicate_on_write
end