Class: Google::Cloud::Bigtable::SampleRowKey

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/sample_row_key.rb

Overview

SampleRowKey

Sample row key with byte offset.

NOTE:

  • row_key : Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present. Note: that row keys in this list may not have ever been written to or read from, and users should therefore not make any assumptions about the row key structure that are specific to their use case.

  • offset_bytes : Approximate total storage space used by all rows in the table which precede row_key. Buffering the contents of all rows between two subsequent samples would require space roughly equal to the difference in their offset_bytes fields.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

table = bigtable.table "my-instance", "my-table"

table.sample_row_keys.each do |r|
  p r
end

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String (readonly)

Returns Sample row key.

Returns:

  • (String) —

    Sample row key.



54
55
56
 
# File 'lib/google/cloud/bigtable/sample_row_key.rb', line 54

def key
  @key
end

#offset ⇒ Integer (readonly)

Returns Row offset in bytes.

Returns:

  • (Integer) —

    Row offset in bytes.



58
59
60
 
# File 'lib/google/cloud/bigtable/sample_row_key.rb', line 58

def offset
  @offset
end