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

Version latest

• 1.61.0 (latest)
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.1
• 1.51.1
• 1.50.0
• 1.49.1
• 1.48.1
• 1.47.0
• 1.46.1
• 1.45.0
• 1.44.2
• 1.43.1
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.1

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

Google Cloud BigQuery

Google BigQuery enables super-fast, SQL-like queries against massive datasets, using the processing power of Google's infrastructure.

See BigQuery Overview.

Methods

.configure

def self.configure() -> Google::Cloud::Config

Configure the Google Cloud BigQuery library.

The following BigQuery configuration parameters are supported:

• project_id - (String) Identifier for a BigQuery project. (The parameter project is considered deprecated, but may also be used.)
• credentials - (Google::Auth::Credentials) A Google::Auth::Credentials object. (See Credentials) @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.
• scope - (String, Array
• retries - (Integer) Number of times to retry requests on server error.
• timeout - (Integer) Default timeout to use in requests.

Yields

• (Google::Cloud.configure.bigquery)

Returns

• (Google::Cloud::Config) — The configuration object the Google::Cloud::Bigquery library uses.

.new

def self.new(project_id: nil, credentials: nil, scope: nil, retries: nil, timeout: nil, endpoint: nil, project: nil, keyfile: nil, universe_domain: 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.

Parameters

• project_id (String) (defaults to: nil) — Identifier for a BigQuery project. If not present, the default project for the credentials is used.
• credentials (Google::Auth::Credentials) (defaults to: nil) — A Google::Auth::Credentials object. (See Credentials) @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 do |config| config.credentials = credentials end

• 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.
• endpoint (String) (defaults to: nil) — Override of the endpoint host name. Optional. If the param is nil, uses the default endpoint.
• project (String) (defaults to: nil) — Alias for the project_id argument. Deprecated.
• keyfile (String) (defaults to: nil) — Alias for the credentials argument. Deprecated.

Returns

• (Google::Cloud::Bigquery::Project)

Raises

• (ArgumentError)

Example

require "google/cloud/bigquery"

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

Constants

VERSION

value: "1.61.0".freeze