class Google::Cloud::Bigquery::Table::List
Table::List
is a special case Array with additional values.
Attributes
A hash of this page of results.
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
Total number of tables in this collection.
Public Class Methods
@private New Table::List
from a response object.
# File lib/google/cloud/bigquery/table/list.rb, line 150 def self.from_gapi gapi_list, service, dataset_id = nil, max = nil tables = List.new(Array(gapi_list.tables).map { |gapi_object| Table.from_gapi gapi_object, service }) 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
@private Create a new Table::List
with an array of tables.
# File lib/google/cloud/bigquery/table/list.rb, line 38 def initialize arr = [] super arr end
Public Instance Methods
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.
@param [Integer] request_limit The upper limit of API requests to
make to load all tables. Default is no limit.
@yield [table] The block for accessing each table. @yieldparam [Table] table The table object.
@return [Enumerator]
@example Iterating each result by passing a block:
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new dataset = bigquery.dataset "my_dataset" dataset.tables.all do |table| puts table.name end
@example Using the enumerator by not passing a block:
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new dataset = bigquery.dataset "my_dataset" all_names = dataset.tables.all.map do |table| table.name end
@example Limit the number of API requests made:
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new dataset = bigquery.dataset "my_dataset" dataset.tables.all(request_limit: 10) do |table| puts table.name end
# File lib/google/cloud/bigquery/table/list.rb, line 133 def all request_limit: nil, &block request_limit = request_limit.to_i if request_limit return enum_for :all, request_limit: request_limit unless block_given? results = self loop do results.each(&block) if request_limit request_limit -= 1 break if request_limit.negative? end break unless results.next? results = results.next end end
Retrieve the next page of tables.
@return [Table::List]
@example
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new dataset = bigquery.dataset "my_dataset" tables = dataset.tables if tables.next? next_tables = tables.next end
# File lib/google/cloud/bigquery/table/list.rb, line 78 def next return nil unless next? ensure_service! gapi = @service.list_tables @dataset_id, token: token, max: @max self.class.from_gapi gapi, @service, @dataset_id, @max end
Whether there is a next page of tables.
@return [Boolean]
@example
require "google/cloud/bigquery" bigquery = Google::Cloud::Bigquery.new dataset = bigquery.dataset "my_dataset" tables = dataset.tables if tables.next? next_tables = tables.next end
# File lib/google/cloud/bigquery/table/list.rb, line 58 def next? !token.nil? end
Protected Instance Methods
Raise an error unless an active service is available.
# File lib/google/cloud/bigquery/table/list.rb, line 165 def ensure_service! raise "Must have active connection" unless @service end