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 instance by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

bigtable.tables("instance-id").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("instance-id").all.map do |table|
  puts table.table_id
end

Yields:

  • (table) —

    The block for accessing each table instance.

Yield Parameters:

  • instance (Table) —

    The table instance object.

Returns:

  • (Enumerator) 


110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/cloud/bigtable/table/list.rb', line 110

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

Retrieve 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:



69
70
71
72
73
74
75
 
# File 'lib/google/cloud/bigtable/table/list.rb', line 69

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) 


52
53
54
 
# File 'lib/google/cloud/bigtable/table/list.rb', line 52

def next?
  grpc.next_page?
end