Class: Gcloud::Bigquery::Table::List

Inherits:
Array
  • Object
show all
Defined in:
lib/gcloud/bigquery/table/list.rb

Overview

Table::List is a special case Array with additional values.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

Returns a new instance of List.



37
38
39
 
# File 'lib/gcloud/bigquery/table/list.rb', line 37

def initialize arr = []
  super arr
end

Instance Attribute Details

#etag ⇒ Object

A hash of this page of results.



30
31
32
 
# File 'lib/gcloud/bigquery/table/list.rb', line 30

def etag
  @etag
end

#token ⇒ Object

If not empty, indicates that there are more records that match the request and this value should be passed to continue.



27
28
29
 
# File 'lib/gcloud/bigquery/table/list.rb', line 27

def token
  @token
end

#total ⇒ Object

Total number of tables in this collection.



33
34
35
 
# File 'lib/gcloud/bigquery/table/list.rb', line 33

def total
  @total
end

Class Method Details

.from_gapi(gapi_list, service, dataset_id = nil, max = nil) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/gcloud/bigquery/table/list.rb', line 157

def self.from_gapi gapi_list, service, dataset_id = nil, max = nil
  tables = List.new(Array(gapi_list.tables).map do |gapi_object|
    Table.from_gapi gapi_object, service
  end)
  tables.instance_variable_set :@token,      gapi_list.next_page_token
  tables.instance_variable_set :@etag,       gapi_list.etag
  tables.instance_variable_set :@total,      gapi_list.total_items
  tables.instance_variable_set :@service,    service
  tables.instance_variable_set :@dataset_id, dataset_id
  tables.instance_variable_set :@max,        max
  tables
end

Instance Method Details

#all(request_limit: nil) {|table| ... } ⇒ Enumerator

Retrieves all tables by repeatedly loading #next until #next? returns ‘false`. Calls the given block once for each table, which is passed as the parameter.

An Enumerator is returned if no block is given.

This method may make several API calls until all tables are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.

Examples:

Iterating each result by passing a block:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery
dataset = bigquery.dataset "my_dataset"

dataset.tables.all do |table|
  puts table.name
end

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery
dataset = bigquery.dataset "my_dataset"

all_names = dataset.tables.all.map do |table|
  table.name
end

Limit the number of API requests made:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery
dataset = bigquery.dataset "my_dataset"

dataset.tables.all(request_limit: 10) do |table|
  puts table.name
end

Parameters:

  • request_limit (Integer) (defaults to: nil) —

    The upper limit of API requests to make to load all tables. Default is no limit.

Yields:

  • (table) —

    The block for accessing each table.

Yield Parameters:

  • table (Table) —

    The table object.

Returns:

  • (Enumerator) 


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/gcloud/bigquery/table/list.rb', line 138

def all request_limit: nil
  request_limit = request_limit.to_i if request_limit
  unless block_given?
    return enum_for(:all, request_limit: request_limit)
  end
  results = self
  loop do
    results.each { |r| yield r }
    if request_limit
      request_limit -= 1
      break if request_limit < 0
    end
    break unless results.next?
    results = results.next
  end
end

#next ⇒ Table::List

Retrieve the next page of tables.

Examples:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery
dataset = bigquery.dataset "my_dataset"

tables = dataset.tables
if tables.next?
  next_tables = tables.next
end

Returns:



79
80
81
82
83
84
85
 
# File 'lib/gcloud/bigquery/table/list.rb', line 79

def next
  return nil unless next?
  ensure_service!
  options = { token: token, max: @max }
  gapi = @service.list_tables @dataset_id, options
  self.class.from_gapi gapi, @service, @dataset_id, @max
end

#next? ⇒ Boolean

Whether there is a next page of tables.

Examples:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery
dataset = bigquery.dataset "my_dataset"

tables = dataset.tables
if tables.next?
  next_tables = tables.next
end

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/gcloud/bigquery/table/list.rb', line 58

def next?
  !token.nil?
end