BigQuery API - Module Google::Cloud (v1.61.0)

Reference documentation and code samples for the BigQuery API module Google::Cloud.

Methods

.bigquery

def self.bigquery(project_id = nil, credentials = nil, scope: nil, retries: nil, timeout: nil) -> Google::Cloud::Bigquery::Project

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.

@note Warning: Passing a String to a keyfile path or a Hash of credentials is deprecated. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data.

@example

# The recommended way to provide credentials is to use the `make_creds` method
# on the appropriate credentials class for your environment.

require "googleauth"

credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
  json_key_io: ::File.open("/path/to/keyfile.json")
)

client = ::Google::Cloud::Bigquery.new credentials: credentials
Parameters
  • project_id (String) — Identifier for a BigQuery project. If not present, the default project for the credentials is used.
  • credentials (Google::Auth::Credentials) — A Google::Auth::Credentials object. (See Bigquery::Credentials)
  • scope (String, Array<String>) (defaults to: nil) —

    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.

    The default scope is:

    • https://www.googleapis.com/auth/bigquery
  • retries (Integer) (defaults to: nil) — Number of times to retry requests on server error. The default value is 5. Optional.
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Returns
Example 
require "google/cloud"

bigquery = Google::Cloud.bigquery
dataset = bigquery.dataset "my_dataset"
table = dataset.table "my_table"

#bigquery

def bigquery(scope: nil, retries: nil, timeout: nil) -> Google::Cloud::Bigquery::Project

Creates a new object for connecting to the BigQuery service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide.

Parameters
  • scope (String, Array<String>) (defaults to: nil) —

    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.

    The default scope is:

    • https://www.googleapis.com/auth/bigquery
  • retries (Integer) (defaults to: nil) — Number of times to retry requests on server error. The default value is 5. Optional.
  • timeout (Integer) (defaults to: nil) — Default request timeout in seconds. Optional.
Returns
Examples 
require "google/cloud"

gcloud = Google::Cloud.new
bigquery = gcloud.bigquery
dataset = bigquery.dataset "my_dataset"
table = dataset.table "my_table"

data = table.data

# Iterate over the first page of results
data.each do |row|
  puts row[:name]
end
# Retrieve the next page of results
data = data.next if data.next?

The default scope can be overridden with the scope option:

require "google/cloud"

gcloud  = Google::Cloud.new
platform_scope = "https://www.googleapis.com/auth/cloud-platform"
bigquery = gcloud.bigquery scope: platform_scope