Class: Google::Cloud::Bigtable::Table::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/bigtable/table/list.rb

Overview

Table::List is a special-case array with additional values.

Instance Method Summary collapse

Instance Method Details

#all {|table| ... } ⇒ Enumerator?

Retrieves remaining results by repeatedly invoking #next until #next? returns false. Calls the given block once for each result, which is passed as the argument to the block.

An enumerator is returned if no block is given.

This method will make repeated API calls until all remaining results are retrieved (unlike #each, for example, which merely iterates over the results returned by a single API call). Use with caution.

Examples:

Iterating each table by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

bigtable.tables("my-instance").all do |table|
  puts table.table_id
end

Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

all_table_ids = bigtable.tables("my-instance").all.map do |table|
  puts table.table_id
end

Yields:

  • (table) —

    The block for accessing each table instance.

Yield Parameters:

  • table (Table) —

    The table instance object.

Returns:

  • (Enumerator, nil) —

    An enumerator is returned if no block is given, otherwise nil.



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/google/cloud/bigtable/table/list.rb', line 117

def all
  return enum_for :all unless block_given?

  results = self
  loop do
    results.each { |r| yield r }
    break unless next?
    grpc.next_page
    results = self.class.from_grpc grpc, service
  end
end

#next ⇒ Table::List

Retrieves the next page of tables.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

tables = bigtable.tables("my-instance")
if tables.next?
  next_tables = tables.next
end

Returns:



75
76
77
78
79
80
81
 
# File 'lib/google/cloud/bigtable/table/list.rb', line 75

def next
  ensure_grpc!

  return nil unless next?
  grpc.next_page
  self.class.from_grpc grpc, service
end

#next? ⇒ Boolean

Whether there is a next page of tables.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

tables = bigtable.tables("my-instance")
if tables.next?
  next_tables = tables.next
end

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/google/cloud/bigtable/table/list.rb', line 56

def next?
  grpc.next_page?
end