Class: Google::Cloud::Bigtable::V2::BigtableClient
- Inherits:
-
Object
- Object
- Google::Cloud::Bigtable::V2::BigtableClient
- Defined in:
- lib/google/cloud/bigtable/v2/bigtable_client.rb
Overview
Service for reading from and writing to existing Bigtable tables.
Constant Summary collapse
- SERVICE_ADDRESS =
The default address of the service.
"bigtable.googleapis.com".freeze
- DEFAULT_SERVICE_PORT =
The default port of the service.
443
- GRPC_INTERCEPTORS =
The default set of gRPC interceptors.
[]
- DEFAULT_TIMEOUT =
30
- ALL_SCOPES =
The scopes needed to make gRPC calls to all of the methods defined in this service.
[ "https://www.googleapis.com/auth/bigtable.data", "https://www.googleapis.com/auth/bigtable.data.readonly", "https://www.googleapis.com/auth/cloud-bigtable.data", "https://www.googleapis.com/auth/cloud-bigtable.data.readonly", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ].freeze
Class Method Summary collapse
-
.table_path(project, instance, table) ⇒ String
Returns a fully-qualified table resource name string.
Instance Method Summary collapse
-
#check_and_mutate_row(table_name, row_key, app_profile_id: nil, predicate_filter: nil, true_mutations: nil, false_mutations: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::V2::CheckAndMutateRowResponse
Mutates a row atomically based on the output of a predicate Reader filter.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ BigtableClient
constructor
A new instance of BigtableClient.
-
#mutate_row(table_name, row_key, mutations, app_profile_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::V2::MutateRowResponse
Mutates a row atomically.
-
#mutate_rows(table_name, entries, app_profile_id: nil, options: nil) ⇒ Enumerable<Google::Bigtable::V2::MutateRowsResponse>
Mutates multiple rows in a batch.
-
#read_modify_write_row(table_name, row_key, rules, app_profile_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::V2::ReadModifyWriteRowResponse
Modifies a row atomically on the server.
-
#read_rows(table_name, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil, options: nil) ⇒ Enumerable<Google::Bigtable::V2::ReadRowsResponse>
Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.
-
#sample_row_keys(table_name, app_profile_id: nil, options: nil) ⇒ Enumerable<Google::Bigtable::V2::SampleRowKeysResponse>
Returns a sample of row keys in the table.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ BigtableClient
Returns a new instance of BigtableClient.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 114 def initialize \ credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/bigtable/v2/bigtable_services_pb" credentials ||= Google::Cloud::Bigtable::V2::Credentials.default if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Bigtable::V2::Credentials.new(credentials).updater_proc end if credentials.is_a?(GRPC::Core::Channel) channel = credentials end if credentials.is_a?(GRPC::Core::ChannelCredentials) chan_creds = credentials end if credentials.is_a?(Proc) updater_proc = credentials end if credentials.is_a?(Google::Auth::Credentials) updater_proc = credentials.updater_proc end package_version = Gem.loaded_specs['google-cloud-bigtable'].version.version google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } headers.merge!() unless .nil? client_config_file = Pathname.new(__dir__).join( "bigtable_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.bigtable.v2.Bigtable", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, metadata: headers ) end # Allow overriding the service path/port in subclasses. service_path = self.class::SERVICE_ADDRESS port = self.class::DEFAULT_SERVICE_PORT interceptors = self.class::GRPC_INTERCEPTORS @bigtable_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, interceptors: interceptors, &Google::Bigtable::V2::Bigtable::Stub.method(:new) ) @read_rows = Google::Gax.create_api_call( @bigtable_stub.method(:read_rows), defaults["read_rows"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'table_name' => request.table_name} end ) @sample_row_keys = Google::Gax.create_api_call( @bigtable_stub.method(:sample_row_keys), defaults["sample_row_keys"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'table_name' => request.table_name} end ) @mutate_row = Google::Gax.create_api_call( @bigtable_stub.method(:mutate_row), defaults["mutate_row"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'table_name' => request.table_name} end ) @mutate_rows = Google::Gax.create_api_call( @bigtable_stub.method(:mutate_rows), defaults["mutate_rows"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'table_name' => request.table_name} end ) @check_and_mutate_row = Google::Gax.create_api_call( @bigtable_stub.method(:check_and_mutate_row), defaults["check_and_mutate_row"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'table_name' => request.table_name} end ) @read_modify_write_row = Google::Gax.create_api_call( @bigtable_stub.method(:read_modify_write_row), defaults["read_modify_write_row"], exception_transformer: exception_transformer, params_extractor: proc do |request| {'table_name' => request.table_name} end ) end |
Class Method Details
.table_path(project, instance, table) ⇒ String
Returns a fully-qualified table resource name string.
77 78 79 80 81 82 83 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 77 def self.table_path project, instance, table TABLE_PATH_TEMPLATE.render( :"project" => project, :"instance" => instance, :"table" => table ) end |
Instance Method Details
#check_and_mutate_row(table_name, row_key, app_profile_id: nil, predicate_filter: nil, true_mutations: nil, false_mutations: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::V2::CheckAndMutateRowResponse
Mutates a row atomically based on the output of a predicate Reader filter.
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 497 def check_and_mutate_row \ table_name, row_key, app_profile_id: nil, predicate_filter: nil, true_mutations: nil, false_mutations: nil, options: nil, &block req = { table_name: table_name, row_key: row_key, app_profile_id: app_profile_id, predicate_filter: predicate_filter, true_mutations: true_mutations, false_mutations: false_mutations }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Bigtable::V2::CheckAndMutateRowRequest) @check_and_mutate_row.call(req, , &block) end |
#mutate_row(table_name, row_key, mutations, app_profile_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::V2::MutateRowResponse
Mutates a row atomically. Cells already present in the row are left
unchanged unless explicitly changed by mutation
.
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 377 def mutate_row \ table_name, row_key, mutations, app_profile_id: nil, options: nil, &block req = { table_name: table_name, row_key: row_key, mutations: mutations, app_profile_id: app_profile_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Bigtable::V2::MutateRowRequest) @mutate_row.call(req, , &block) end |
#mutate_rows(table_name, entries, app_profile_id: nil, options: nil) ⇒ Enumerable<Google::Bigtable::V2::MutateRowsResponse>
Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 430 def mutate_rows \ table_name, entries, app_profile_id: nil, options: nil req = { table_name: table_name, entries: entries, app_profile_id: app_profile_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Bigtable::V2::MutateRowsRequest) @mutate_rows.call(req, ) end |
#read_modify_write_row(table_name, row_key, rules, app_profile_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::V2::ReadModifyWriteRowResponse
Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 561 def read_modify_write_row \ table_name, row_key, rules, app_profile_id: nil, options: nil, &block req = { table_name: table_name, row_key: row_key, rules: rules, app_profile_id: app_profile_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Bigtable::V2::ReadModifyWriteRowRequest) @read_modify_write_row.call(req, , &block) end |
#read_rows(table_name, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil, options: nil) ⇒ Enumerable<Google::Bigtable::V2::ReadRowsResponse>
Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 280 def read_rows \ table_name, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil, options: nil req = { table_name: table_name, app_profile_id: app_profile_id, rows: rows, filter: filter, rows_limit: rows_limit }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Bigtable::V2::ReadRowsRequest) @read_rows.call(req, ) end |
#sample_row_keys(table_name, app_profile_id: nil, options: nil) ⇒ Enumerable<Google::Bigtable::V2::SampleRowKeysResponse>
Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.
326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/google/cloud/bigtable/v2/bigtable_client.rb', line 326 def sample_row_keys \ table_name, app_profile_id: nil, options: nil req = { table_name: table_name, app_profile_id: app_profile_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Bigtable::V2::SampleRowKeysRequest) @sample_row_keys.call(req, ) end |