Module: Google::Cloud::Bigquery::DataTransfer
- Defined in:
- lib/google/cloud/bigquery/data_transfer.rb,
lib/google/cloud/bigquery/data_transfer/v1.rb,
lib/google/cloud/bigquery/data_transfer/version.rb,
lib/google/cloud/bigquery/data_transfer/credentials.rb,
lib/google/cloud/bigquery/data_transfer/v1/credentials.rb,
lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb,
lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/transfer.rb,
lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/data_transfer/v1/data_transfer.rb
Overview
Ruby Client for BigQuery Data Transfer API (Beta)
BigQuery Data Transfer API: Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.
Quick Start
In order to use this library, you first need to go through the following steps:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the BigQuery Data Transfer API.
- Setup Authentication.
Installation
$ gem install google-cloud-bigquery-data_transfer
Preview
DataTransferServiceClient
require "google/cloud/bigquery/data_transfer"
data_transfer_client = Google::Cloud::Bigquery::DataTransfer.new
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.location_path(project_id, "us-central1")
# Iterate over all results.
data_transfer_client.list_data_sources(formatted_parent).each do |element|
# Process element.
end
# Or iterate over results one page at a time.
data_transfer_client.list_data_sources(formatted_parent).each_page do |page|
# Process each page at a time.
page.each do |element|
# Process element.
end
end
Next Steps
- Read the BigQuery Data Transfer API Product documentation to learn more about the product and see How-to Guides.
- View this repository's main README to see the full list of Cloud APIs that we cover.
Enabling Logging
To enable logging for this library, set the logger for the underlying gRPC library.
The logger that you set may be a Ruby stdlib Logger
as shown below,
or a Google::Cloud::Logging::Logger
that will write logs to Stackdriver Logging. See grpc/logconfig.rb
and the gRPC spec_helper.rb for additional information.
Configuring a Ruby stdlib logger:
require "logger"
module MyLogger
LOGGER = Logger.new $stderr, level: Logger::WARN
def logger
LOGGER
end
end
# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
module GRPC
extend MyLogger
end
Defined Under Namespace
Modules: V1 Classes: Credentials
Constant Summary collapse
- FILE_DIR =
rubocop:enable LineLength
File.realdirpath(Pathname.new(__FILE__).join("..").join("data_transfer"))
- AVAILABLE_VERSIONS =
Dir["#{FILE_DIR}/*"] .select { |file| File.directory?(file) } .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) } .select { |dir| File.exist?(dir + ".rb") } .map { |dir| File.basename(dir) }
- VERSION =
"0.5.0".freeze
Class Method Summary collapse
-
.new(version: , credentials: , scopes: , client_config: , timeout: ) ⇒ Object
The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery.
Class Method Details
.new(version: , credentials: , scopes: , client_config: , timeout: ) ⇒ Object
The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.
156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/google/cloud/bigquery/data_transfer.rb', line 156 def self.new(*args, version: :v1, **kwargs) unless AVAILABLE_VERSIONS.include?(version.to_s.downcase) raise "The version: #{version} is not available. The available versions " \ "are: [#{AVAILABLE_VERSIONS.join(", ")}]" end require "#{FILE_DIR}/#{version.to_s.downcase}" version_module = Google::Cloud::Bigquery::DataTransfer .constants .select {|sym| sym.to_s.downcase == version.to_s.downcase} .first Google::Cloud::Bigquery::DataTransfer.const_get(version_module).new(*args, **kwargs) end |