gcloud 0.12.2 → 0.20.0

data/lib/gcloud/bigquery/table/list.rb

@@ -1,180 +0,0 @@
-# Copyright 2015 Google Inc. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "delegate"
-
-module Gcloud
-  module Bigquery
-    class Table
-      ##
-      # Table::List is a special case Array with additional values.
-      class List < DelegateClass(::Array)
-        ##
-        # If not empty, indicates that there are more records that match
-        # the request and this value should be passed to continue.
-        attr_accessor :token
-
-        # A hash of this page of results.
-        attr_accessor :etag
-
-        # Total number of tables in this collection.
-        attr_accessor :total
-
-        ##
-        # @private Create a new Table::List with an array of tables.
-        def initialize arr = []
-          super arr
-        end
-
-        ##
-        # Whether there is a next page of tables.
-        #
-        # @return [Boolean]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   bigquery = gcloud.bigquery
-        #   dataset = bigquery.dataset "my_dataset"
-        #
-        #   tables = dataset.tables
-        #   if tables.next?
-        #     next_tables = tables.next
-        #   end
-        #
-        def next?
-          !token.nil?
-        end
-
-        ##
-        # Retrieve the next page of tables.
-        #
-        # @return [Table::List]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   bigquery = gcloud.bigquery
-        #   dataset = bigquery.dataset "my_dataset"
-        #
-        #   tables = dataset.tables
-        #   if tables.next?
-        #     next_tables = tables.next
-        #   end
-        #
-        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
-
-        ##
-        # 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.
-        #
-        # @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 "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   bigquery = gcloud.bigquery
-        #   dataset = bigquery.dataset "my_dataset"
-        #
-        #   dataset.tables.all do |table|
-        #     puts table.name
-        #   end
-        #
-        # @example 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
-        #
-        # @example 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
-        #
-        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
-
-        ##
-        # @private New Table::List from a response object.
-        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
-
-        protected
-
-        ##
-        # Raise an error unless an active service is available.
-        def ensure_service!
-          fail "Must have active connection" unless @service
-        end
-      end
-    end
-  end
-end

data/lib/gcloud/bigquery/view.rb

@@ -1,475 +0,0 @@
-# Copyright 2015 Google Inc. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "gcloud/errors"
-require "gcloud/bigquery/service"
-require "gcloud/bigquery/data"
-require "gcloud/bigquery/table/list"
-require "google/apis/bigquery_v2"
-
-module Gcloud
-  module Bigquery
-    ##
-    # # View
-    #
-    # A view is a virtual table defined by a SQL query. You can query views in
-    # the browser tool, or by using a query job.
-    #
-    # BigQuery's views are logical views, not materialized views, which means
-    # that the query that defines the view is re-executed every time the view is
-    # queried. Queries are billed according to the total amount of data in all
-    # table fields referenced directly or indirectly by the top-level query.
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   bigquery = gcloud.bigquery
-    #   dataset = bigquery.dataset "my_dataset"
-    #   view = dataset.create_view "my_view",
-    #            "SELECT name, age FROM [proj:dataset.users]"
-    #
-    class View
-      ##
-      # @private The Service object.
-      attr_accessor :service
-
-      ##
-      # @private The Google API Client object.
-      attr_accessor :gapi
-
-      ##
-      # @private Create an empty Table object.
-      def initialize
-        @service = nil
-        @gapi = Google::Apis::BigqueryV2::Table.new
-      end
-
-      ##
-      # A unique ID for this table.
-      # The ID must contain only letters (a-z, A-Z), numbers (0-9),
-      # or underscores (_). The maximum length is 1,024 characters.
-      #
-      # @!group Attributes
-      #
-      def table_id
-        @gapi.table_reference.table_id
-      end
-
-      ##
-      # The ID of the `Dataset` containing this table.
-      #
-      # @!group Attributes
-      #
-      def dataset_id
-        @gapi.table_reference.dataset_id
-      end
-
-      ##
-      # The ID of the `Project` containing this table.
-      #
-      # @!group Attributes
-      #
-      def project_id
-        @gapi.table_reference.project_id
-      end
-
-      ##
-      # @private
-      # The gapi fragment containing the Project ID, Dataset ID, and Table ID as
-      # a camel-cased hash.
-      def table_ref
-        table_ref = @gapi.table_reference
-        table_ref = table_ref.to_hash if table_ref.respond_to? :to_hash
-        table_ref
-      end
-
-      ##
-      # The combined Project ID, Dataset ID, and Table ID for this table, in the
-      # format specified by the [Query
-      # Reference](https://cloud.google.com/bigquery/query-reference#from):
-      # `project_name:datasetId.tableId`. To use this value in queries see
-      # {#query_id}.
-      #
-      # @!group Attributes
-      #
-      def id
-        @gapi.id
-      end
-
-      ##
-      # The value returned by {#id}, wrapped in square brackets if the Project
-      # ID contains dashes, as specified by the [Query
-      # Reference](https://cloud.google.com/bigquery/query-reference#from).
-      # Useful in queries.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   bigquery = gcloud.bigquery
-      #   dataset = bigquery.dataset "my_dataset"
-      #   table = dataset.table "my_table"
-      #
-      #   data = bigquery.query "SELECT name FROM #{table.query_id}"
-      #
-      # @!group Attributes
-      #
-      def query_id
-        project_id["-"] ? "[#{id}]" : id
-      end
-
-      ##
-      # The name of the table.
-      #
-      # @!group Attributes
-      #
-      def name
-        @gapi.friendly_name
-      end
-
-      ##
-      # Updates the name of the table.
-      #
-      # @!group Attributes
-      #
-      def name= new_name
-        @gapi.update! friendly_name: new_name
-        patch_gapi! :friendly_name
-      end
-
-      ##
-      # A string hash of the dataset.
-      #
-      # @!group Attributes
-      #
-      def etag
-        ensure_full_data!
-        @gapi.etag
-      end
-
-      ##
-      # A URL that can be used to access the dataset using the REST API.
-      #
-      # @!group Attributes
-      #
-      def api_url
-        ensure_full_data!
-        @gapi.self_link
-      end
-
-      ##
-      # The description of the table.
-      #
-      # @!group Attributes
-      #
-      def description
-        ensure_full_data!
-        @gapi.description
-      end
-
-      ##
-      # Updates the description of the table.
-      #
-      # @!group Attributes
-      #
-      def description= new_description
-        @gapi.update! description: new_description
-        patch_gapi! :description
-      end
-
-      ##
-      # The time when this table was created.
-      #
-      # @!group Attributes
-      #
-      def created_at
-        ensure_full_data!
-        begin
-          Time.at(Integer(@gapi.creation_time) / 1000.0)
-        rescue
-          nil
-        end
-      end
-
-      ##
-      # The time when this table expires.
-      # If not present, the table will persist indefinitely.
-      # Expired tables will be deleted and their storage reclaimed.
-      #
-      # @!group Attributes
-      #
-      def expires_at
-        ensure_full_data!
-        begin
-          Time.at(Integer(@gapi.expiration_time) / 1000.0)
-        rescue
-          nil
-        end
-      end
-
-      ##
-      # The date when this table was last modified.
-      #
-      # @!group Attributes
-      #
-      def modified_at
-        ensure_full_data!
-        begin
-          Time.at(Integer(@gapi.last_modified_time) / 1000.0)
-        rescue
-          nil
-        end
-      end
-
-      ##
-      # Checks if the table's type is "TABLE".
-      #
-      # @!group Attributes
-      #
-      def table?
-        @gapi.type == "TABLE"
-      end
-
-      ##
-      # Checks if the table's type is "VIEW".
-      #
-      # @!group Attributes
-      #
-      def view?
-        @gapi.type == "VIEW"
-      end
-
-      ##
-      # The geographic location where the table should reside. Possible
-      # values include EU and US. The default value is US.
-      #
-      # @!group Attributes
-      #
-      def location
-        ensure_full_data!
-        @gapi.location
-      end
-
-      ##
-      # The schema of the view.
-      #
-      # @!group Attributes
-      #
-      def schema
-        ensure_full_data!
-        Schema.from_gapi(@gapi.schema).freeze
-      end
-
-      ##
-      # The fields of the view.
-      #
-      # @!group Attributes
-      #
-      def fields
-        schema.fields
-      end
-
-      ##
-      # The names of the columns in the view.
-      #
-      # @!group Attributes
-      #
-      def headers
-        fields.map(&:name)
-      end
-
-      ##
-      # The query that executes each time the view is loaded.
-      #
-      # @!group Attributes
-      #
-      def query
-        @gapi.view.query if @gapi.view
-      end
-
-      ##
-      # Updates the query that executes each time the view is loaded.
-      #
-      # @see https://cloud.google.com/bigquery/query-reference BigQuery Query
-      #   Reference
-      #
-      # @param [String] new_query The query that defines the view.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   bigquery = gcloud.bigquery
-      #   dataset = bigquery.dataset "my_dataset"
-      #   view = dataset.table "my_view"
-      #
-      #   view.query = "SELECT first_name FROM [my_project:my_dataset.my_table]"
-      #
-      # @!group Lifecycle
-      #
-      def query= new_query
-        @gapi.view ||= Google::Apis::BigqueryV2::ViewDefinition.new
-        @gapi.view.update! query: new_query
-        patch_view_gapi! :query
-      end
-
-      ##
-      # Runs a query to retrieve all data from the view.
-      #
-      # @param [Integer] max The maximum number of rows of data to return per
-      #   page of results. Setting this flag to a small value such as 1000 and
-      #   then paging through results might improve reliability when the query
-      #   result set is large. In addition to this limit, responses are also
-      #   limited to 10 MB. By default, there is no maximum row count, and only
-      #   the byte limit applies.
-      # @param [Integer] timeout How long to wait for the query to complete, in
-      #   milliseconds, before the request times out and returns. Note that this
-      #   is only a timeout for the request, not the query. If the query takes
-      #   longer to run than the timeout value, the call returns without any
-      #   results and with QueryData#complete? set to false. The default value
-      #   is 10000 milliseconds (10 seconds).
-      # @param [Boolean] cache Whether to look for the result in the query
-      #   cache. The query cache is a best-effort cache that will be flushed
-      #   whenever tables in the query are modified. The default value is true.
-      #   For more information, see [query
-      #   caching](https://developers.google.com/bigquery/querying-data).
-      # @param [Boolean] dryrun If set to `true`, BigQuery doesn't run the job.
-      #   Instead, if the query is valid, BigQuery returns statistics about the
-      #   job such as how many bytes would be processed. If the query is
-      #   invalid, an error returns. The default value is `false`.
-      #
-      # @return [Gcloud::Bigquery::QueryData]
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   bigquery = gcloud.bigquery
-      #   dataset = bigquery.dataset "my_dataset"
-      #   view = dataset.table "my_view"
-      #
-      #   data = view.data
-      #   data.each do |row|
-      #     puts row["first_name"]
-      #   end
-      #   more_data = data.next if data.next?
-      #
-      # @!group Data
-      #
-      def data max: nil, timeout: 10000, cache: true, dryrun: nil
-        sql = "SELECT * FROM #{query_id}"
-        ensure_service!
-        options = { max: max, timeout: timeout, cache: cache, dryrun: dryrun }
-        gapi = service.query sql, options
-        QueryData.from_gapi gapi, service
-      end
-
-      ##
-      # Permanently deletes the table.
-      #
-      # @return [Boolean] Returns `true` if the table was deleted.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   bigquery = gcloud.bigquery
-      #   dataset = bigquery.dataset "my_dataset"
-      #   table = dataset.table "my_table"
-      #
-      #   table.delete
-      #
-      # @!group Lifecycle
-      #
-      def delete
-        ensure_service!
-        service.delete_table dataset_id, table_id
-        true
-      end
-
-      ##
-      # Reloads the table with current data from the BigQuery service.
-      #
-      # @!group Lifecycle
-      #
-      def reload!
-        ensure_service!
-        gapi = service.get_table dataset_id, table_id
-        @gapi = gapi
-      end
-      alias_method :refresh!, :reload!
-
-      ##
-      # @private New Table from a Google API Client object.
-      def self.from_gapi gapi, conn
-        new.tap do |f|
-          f.gapi = gapi
-          f.service = conn
-        end
-      end
-
-      protected
-
-      ##
-      # Raise an error unless an active service is available.
-      def ensure_service!
-        fail "Must have active connection" unless service
-      end
-
-      def patch_gapi! *attributes
-        return if attributes.empty?
-        patch_args = Hash[attributes.map do |attr|
-          [attr, @gapi.send(attr)]
-        end]
-        patch_table_gapi patch_args
-      end
-
-      def patch_view_gapi! *attributes
-        return if attributes.empty?
-        patch_args = Hash[attributes.map do |attr|
-          [attr, @gapi.view.send(attr)]
-        end]
-        patch_view_args = Google::Apis::BigqueryV2::ViewDefinition.new(
-          patch_args
-        )
-        patch_table_gapi view: patch_view_args
-      end
-
-      def patch_table_gapi patch_args
-        ensure_service!
-        patch_gapi = Google::Apis::BigqueryV2::Table.new patch_args
-        @gapi = service.patch_table dataset_id, table_id, patch_gapi
-      end
-
-      ##
-      # Load the complete representation of the table if it has been
-      # only partially loaded by a request to the API list method.
-      def ensure_full_data!
-        reload_gapi! unless data_complete?
-      end
-
-      def reload_gapi!
-        ensure_service!
-        gapi = service.get_table dataset_id, table_id
-        @gapi = gapi
-      end
-
-      def data_complete?
-        @gapi.is_a? Google::Apis::BigqueryV2::Table
-      end
-    end
-  end
-end