class Google::Cloud::Spanner::Range

# Range

Represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key.

@example

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

key_range = db.range 1, 100
results = db.read "users", [:id, :name], keys: key_range

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end

Attributes

begin[R]

Returns the object that defines the beginning of the range.

end[R]

Returns the object that defines the end of the range.

Public Class Methods

new(beginning, ending, exclude_begin: false, exclude_end: false) click to toggle source

Creates a Spanner Range. This can be used in place of a Ruby Range when needing to exclude the beginning value.

@param [Object] beginning The object that defines the beginning of the

range.

@param [Object] ending The object that defines the end of the range. @param [Boolean] exclude_begin Determines if the range excludes its

beginning value. Default is `false`.

@param [Boolean] exclude_end Determines if the range excludes its

ending value. Default is `false`.

@example

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

db = spanner.client "my-instance", "my-database"

key_range = Google::Cloud::Spanner::Range.new 1, 100
results = db.read "users", [:id, :name], keys: key_range

results.rows.each do |row|
  puts "User #{row[:id]} is #{row[:name]}"
end
# File lib/google/cloud/spanner/range.rb, line 75
def initialize beginning, ending, exclude_begin: false,
               exclude_end: false
  @begin = beginning
  @end = ending
  @exclude_begin = exclude_begin
  @exclude_end = exclude_end
end

Public Instance Methods

exclude_begin?() click to toggle source

Returns `true` if the range excludes its beginning value. @return [Boolean]

# File lib/google/cloud/spanner/range.rb, line 86
def exclude_begin?
  @exclude_begin
end
exclude_end?() click to toggle source

Returns `true` if the range excludes its end value. @return [Boolean]

# File lib/google/cloud/spanner/range.rb, line 93
def exclude_end?
  @exclude_end
end