google-cloud-bigquery 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f16696b5a90b556871480222793c4e66d27c9fe6
-  data.tar.gz: b6c55807e67d5888773bccf1dabee042b23a9abe
+  metadata.gz: 6329af7634e65dcd64c344c2828b68e11a104399
+  data.tar.gz: a9d9b8b97b9f650a24f1f9fb22a5fbe989dce6f5
 SHA512:
-  metadata.gz: f07cece664a25f4962b72aef938fc39ff560e2aefbe32eabb375f8e98303f016d032fddce70de0a8f8887b2d4e49f5aa3e0b1e358a09a675d650a082d8984d61
-  data.tar.gz: 7b3ebbc30c72952601caf1f293fb8913ce51e9be6b22e2b783baaf7d26b378648009a7bec603b94823d2558befbe9cadcd362de701c3b71905704f45bc0b6d0c
+  metadata.gz: 92ec74a841633277404218e1306de8b57aa34eb736d748682028642dfbcc36cce225b42e8d391230d1d2aaa4e3514c86b464c8eee8e30f91d87eb36afb0fc18b
+  data.tar.gz: e149b925e5bd3985a7fb173dca9ea762d9c98251b90786b8648b1b7c214cbae81e1fb9d9af8429ba050d99c1ed2d36379a236a9f2f191eac37c28bb017494be5

data/lib/google-cloud-bigquery.rb

@@ -94,7 +94,7 @@ module Google
     # @return [Google::Cloud::Bigquery::Project]
     #
     # @example
-    #   require "google/cloud/bigquery"
+    #   require "google/cloud"
     #
     #   bigquery = Google::Cloud.bigquery
     #   dataset = bigquery.dataset "my_dataset"
@@ -103,20 +103,9 @@ module Google
     def self.bigquery project = nil, keyfile = nil, scope: nil, retries: nil,
                       timeout: nil
       require "google/cloud/bigquery"
-      project ||= Google::Cloud::Bigquery::Project.default_project
-      project = project.to_s # Always cast to a string
-      fail ArgumentError, "project is missing" if project.empty?
-
-      if keyfile.nil?
-        credentials = Google::Cloud::Bigquery::Credentials.default scope: scope
-      else
-        credentials = Google::Cloud::Bigquery::Credentials.new(
-          keyfile, scope: scope)
-      end
-
-      Google::Cloud::Bigquery::Project.new(
-        Google::Cloud::Bigquery::Service.new(
-          project, credentials, retries: retries, timeout: timeout))
+      Google::Cloud::Bigquery.new project: project, keyfile: keyfile,
+                                  scope: scope, retries: retries,
+                                  timeout: timeout
     end
   end
 end

data/lib/google/cloud/bigquery.rb

@@ -48,10 +48,9 @@ module Google
     # let's connect to Google's `publicdata` project, and see what you find.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new "publicdata"
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new project: "publicdata"
     #
     # bigquery.datasets.count #=> 1
     # bigquery.datasets.first.dataset_id #=> "samples"
@@ -69,10 +68,9 @@ module Google
     # every play written by Shakespeare.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new "publicdata"
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new project: "publicdata"
     #
     # dataset = bigquery.dataset "samples"
     # table = dataset.table "shakespeare"
@@ -97,10 +95,9 @@ module Google
     # results.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
     #
     # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " +
     #       "FROM publicdata:samples.shakespeare"
@@ -126,10 +123,9 @@ module Google
     # of {Google::Cloud::Bigquery::QueryData}.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
     #
     # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " +
     #       "FROM publicdata:samples.shakespeare"
@@ -159,8 +155,8 @@ module Google
     # ```ruby
     # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
+    #
     # dataset = bigquery.create_dataset "my_dataset"
     # ```
     #
@@ -172,10 +168,9 @@ module Google
     # BigQuery](https://cloud.google.com/bigquery/preparing-data-for-bigquery).)
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
     # dataset = bigquery.dataset "my_dataset"
     #
     # table = dataset.create_table "people" do |schema|
@@ -207,10 +202,9 @@ module Google
     # application is a great approach.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
     # dataset = bigquery.dataset "my_dataset"
     # table = dataset.table "people"
     #
@@ -254,10 +248,9 @@ module Google
     # also contained in the archive specifies the schema used below.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
     # dataset = bigquery.dataset "my_dataset"
     # table = dataset.create_table "baby_names" do |schema|
     #   schema.string "name", mode: :required
@@ -284,10 +277,9 @@ module Google
     # setting up billing.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery
+    # bigquery = Google::Cloud::Bigquery.new
     # dataset = bigquery.dataset "my_dataset"
     # source_table = dataset.table "baby_names"
     # result_table = dataset.create_table "baby_names_results"
@@ -302,7 +294,9 @@ module Google
     #
     # if !query_job.failed?
     #
-    #   storage = gcloud.storage
+    #   require "google/cloud/bigquery"
+    #
+    #   storage = Google::Cloud::Storage.new
     #   bucket_id = "bigquery-exports-#{SecureRandom.uuid}"
     #   bucket = storage.create_bucket bucket_id
     #   extract_url = "gs://#{bucket.id}/baby-names-sam.csv"
@@ -337,10 +331,9 @@ module Google
     # You can also set the request `timeout` value in seconds.
     #
     # ```ruby
-    # require "google/cloud"
+    # require "google/cloud/bigquery"
     #
-    # gcloud = Google::Cloud.new
-    # bigquery = gcloud.bigquery retries: 10, timeout: 120
+    # bigquery = Google::Cloud::Bigquery.new retries: 10, timeout: 120
     # ```
     #
     # See the [BigQuery error
@@ -348,6 +341,56 @@ module Google
     # for a list of error conditions.
     #
     module Bigquery
+      # Creates a new `Project` instance connected to the BigQuery service.
+      # Each call creates a new connection.
+      #
+      # For more information on connecting to Google Cloud see the
+      # [Authentication
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+      #
+      # @param [String] project Identifier for a BigQuery project. If not
+      #   present, the default project for the credentials is used.
+      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
+      #   file path the file must be readable.
+      # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
+      #   the set of resources and operations that the connection can access.
+      #   See # [Using OAuth 2.0 to Access Google #
+      #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+      #
+      #   The default scope is:
+      #
+      #   * `https://www.googleapis.com/auth/bigquery`
+      # @param [Integer] retries Number of times to retry requests on server
+      #   error. The default value is `3`. Optional.
+      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      #
+      # @return [Google::Cloud::Bigquery::Project]
+      #
+      # @example
+      #   require "google/cloud/bigquery"
+      #
+      #   bigquery = Google::Cloud::Bigquery.new
+      #   dataset = bigquery.dataset "my_dataset"
+      #   table = dataset.table "my_table"
+      #
+      def self.new project: nil, keyfile: nil, scope: nil, retries: nil,
+                   timeout: nil
+        project ||= Google::Cloud::Bigquery::Project.default_project
+        project = project.to_s # Always cast to a string
+        fail ArgumentError, "project is missing" if project.empty?
+
+        if keyfile.nil?
+          credentials = Google::Cloud::Bigquery::Credentials.default(
+            scope: scope)
+        else
+          credentials = Google::Cloud::Bigquery::Credentials.new(
+            keyfile, scope: scope)
+        end
+
+        Google::Cloud::Bigquery::Project.new(
+          Google::Cloud::Bigquery::Service.new(
+            project, credentials, retries: retries, timeout: timeout))
+      end
     end
   end
 end

data/lib/google/cloud/bigquery/data.rb

@@ -71,10 +71,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   table = dataset.table "my_table"
         #
         #   data = table.data
@@ -92,10 +91,9 @@ module Google
         # @return [Data]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   table = dataset.table "my_table"
         #
         #   data = table.data
@@ -128,10 +126,9 @@ module Google
         # @return [Enumerator]
         #
         # @example Iterating each rows by passing a block:
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   table = dataset.table "my_table"
         #
         #   table.data.all do |row|
@@ -139,10 +136,9 @@ module Google
         #   end
         #
         # @example Using the enumerator by not passing a block:
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   table = dataset.table "my_table"
         #
         #   words = table.data.all.map do |row|
@@ -150,10 +146,9 @@ module Google
         #   end
         #
         # @example Limit the number of API calls made:
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   table = dataset.table "my_table"
         #
         #   table.data.all(request_limit: 10) do |row|

data/lib/google/cloud/bigquery/dataset.rb

@@ -33,10 +33,9 @@ module Google
       # within a specific project.
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/bigquery"
       #
-      #   gcloud = Google::Cloud.new
-      #   bigquery = gcloud.bigquery
+      #   bigquery = Google::Cloud::Bigquery.new
       #
       #   dataset = bigquery.create_dataset "my_dataset",
       #                                     name: "My Dataset",
@@ -225,10 +224,9 @@ module Google
         # @return [Google::Cloud::Bigquery::Dataset::Access]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #
         #   dataset.access #=> [{"role"=>"OWNER",
@@ -241,10 +239,9 @@ module Google
         #                  #     "userByEmail"=>"123456789-...com"}]
         #
         # @example Manage the access rules by passing a block:
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #
         #   dataset.access do |access|
@@ -279,10 +276,9 @@ module Google
         # @return [Boolean] Returns `true` if the dataset was deleted.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #
         #   dataset = bigquery.dataset "my_dataset"
         #   dataset.delete
@@ -315,28 +311,25 @@ module Google
         # @return [Google::Cloud::Bigquery::Table]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   table = dataset.create_table "my_table"
         #
         # @example You can also pass name and description options.
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   table = dataset.create_table "my_table"
         #                                name: "My Table",
         #                                description: "A description of table."
         #
         # @example The table's schema fields can be passed as an argument.
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #
         #   schema_fields = [
@@ -354,10 +347,9 @@ module Google
         #   table = dataset.create_table "my_table", fields: schema_fields
         #
         # @example Or the table's schema can be configured with the block.
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #
         #   table = dataset.create_table "my_table" do |t|
@@ -369,10 +361,9 @@ module Google
         #   end
         #
         # @example You can define the schema using a nested block.
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   table = dataset.create_table "my_table" do |t|
         #     t.name = "My Table",
@@ -420,19 +411,17 @@ module Google
         # @return [Google::Cloud::Bigquery::View]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   view = dataset.create_view "my_view",
         #             "SELECT name, age FROM [proj:dataset.users]"
         #
         # @example A name and description can be provided:
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   view = dataset.create_view "my_view",
         #             "SELECT name, age FROM [proj:dataset.users]",
@@ -467,10 +456,9 @@ module Google
         #   not exist
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   table = dataset.table "my_table"
         #   puts table.name
@@ -497,10 +485,9 @@ module Google
         #   {Google::Cloud::Bigquery::Table::List})
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   tables = dataset.tables
         #   tables.each do |table|
@@ -508,10 +495,9 @@ module Google
         #   end
         #
         # @example Retrieve all tables: (See {Table::List#all})
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
         #   tables = dataset.tables
         #   tables.all do |table|
@@ -576,10 +562,9 @@ module Google
         # @return [Google::Cloud::Bigquery::QueryJob]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #
         #   job = bigquery.query_job "SELECT name FROM my_table"
         #
@@ -639,10 +624,9 @@ module Google
         # @return [Google::Cloud::Bigquery::QueryData]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/bigquery"
         #
-        #   gcloud = Google::Cloud.new
-        #   bigquery = gcloud.bigquery
+        #   bigquery = Google::Cloud::Bigquery.new
         #
         #   data = bigquery.query "SELECT name FROM my_table"
         #   data.each do |row|