google-cloud-bigtable 0.1.2 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/LOGGING.md +1 -1
- data/OVERVIEW.md +7 -5
- data/lib/google-cloud-bigtable.rb +1 -1
- data/lib/google/cloud/bigtable/admin.rb +4 -4
- data/lib/google/cloud/bigtable/admin/v2.rb +4 -4
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb +66 -66
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client_config.json +16 -16
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb +42 -42
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client_config.json +8 -26
- data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_instance_admin.rb +36 -36
- data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb +37 -37
- data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb +21 -21
- data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb +26 -26
- data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/iam_policy.rb +13 -13
- data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/policy.rb +28 -28
- data/lib/google/cloud/bigtable/admin/v2/doc/google/longrunning/operations.rb +9 -9
- data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/duration.rb +3 -3
- data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/field_mask.rb +7 -7
- data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/bigtable/admin/v2/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/bigtable/column_family.rb +1 -1
- data/lib/google/cloud/bigtable/instance.rb +11 -12
- data/lib/google/cloud/bigtable/project.rb +21 -21
- data/lib/google/cloud/bigtable/table.rb +13 -12
- data/lib/google/cloud/bigtable/v2.rb +4 -4
- data/lib/google/cloud/bigtable/v2/bigtable_client.rb +20 -20
- data/lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb +24 -24
- data/lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb +39 -39
- data/lib/google/cloud/bigtable/v2/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/bigtable/v2/doc/google/protobuf/wrappers.rb +18 -18
- data/lib/google/cloud/bigtable/v2/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/bigtable/version.rb +1 -1
- metadata +3 -3
@@ -352,7 +352,7 @@ module Google
|
|
352
352
|
#
|
353
353
|
# @param cluster_id [String]
|
354
354
|
# The ID to be used when referring to the new cluster within its instance,
|
355
|
-
# e.g., just
|
355
|
+
# e.g., just `mycluster`
|
356
356
|
# @param location [String]
|
357
357
|
# The location where this cluster's nodes and storage reside. For best
|
358
358
|
# performance, clients should be located as close as possible to this
|
@@ -519,7 +519,7 @@ module Google
|
|
519
519
|
#
|
520
520
|
# @param name [String]
|
521
521
|
# The name by which the new table should be referred to within the parent
|
522
|
-
# instance, e.g.,
|
522
|
+
# instance, e.g., `foobar`
|
523
523
|
# @param column_families [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
|
524
524
|
# (See {Google::Cloud::Bigtable::Table::ColumnFamilyMap})
|
525
525
|
# If passed as an empty use code block to add column families.
|
@@ -531,20 +531,19 @@ module Google
|
|
531
531
|
# @param initial_splits [Array<String>]
|
532
532
|
# The optional list of row keys that will be used to initially split the
|
533
533
|
# table into several tablets (tablets are similar to HBase regions).
|
534
|
-
# Given two split keys,
|
535
|
-
# spanning the key ranges:
|
534
|
+
# Given two split keys, `s1` and `s2`, three tablets will be created,
|
535
|
+
# spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
|
536
536
|
#
|
537
537
|
# Example:
|
538
538
|
#
|
539
|
-
# * Row keys :=
|
540
|
-
#
|
541
|
-
# * initial_split_keys := +["apple", "customer_1", "customer_2", "other"]+
|
539
|
+
# * Row keys := `["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]`
|
540
|
+
# * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
|
542
541
|
# * Key assignment:
|
543
|
-
# * Tablet 1 :
|
544
|
-
# * Tablet 2 :
|
545
|
-
# * Tablet 3 :
|
546
|
-
# * Tablet 4 :
|
547
|
-
# * Tablet 5 :
|
542
|
+
# * Tablet 1 : `[, apple) => {"a"}`
|
543
|
+
# * Tablet 2 : `[apple, customer_1) => {"apple", "custom"}`
|
544
|
+
# * Tablet 3 : `[customer_1, customer_2) => {"customer_1"}`
|
545
|
+
# * Tablet 4 : `[customer_2, other) => {"customer_2"}`
|
546
|
+
# * Tablet 5 : `[other, ) => {"other", "zz"}`
|
548
547
|
# A hash of the same form as `Google::Bigtable::Admin::V2::CreateTableRequest::Split`
|
549
548
|
# can also be provided.
|
550
549
|
# @yield [column_families] A block for adding column_families.
|
@@ -35,10 +35,11 @@ module Google
|
|
35
35
|
# Google::Cloud::Bigtable::Project is the main object for interacting with
|
36
36
|
# Cloud Bigtable.
|
37
37
|
#
|
38
|
-
# {Google::Cloud::Bigtable::Cluster}
|
38
|
+
# {Google::Cloud::Bigtable::Cluster} and {Google::Cloud::Bigtable::Instance}
|
39
39
|
# objects are created, accessed, and managed by Google::Cloud::Bigtable::Project.
|
40
40
|
#
|
41
|
-
#
|
41
|
+
# To create an instance, use {Google::Cloud::Bigtable.new} or
|
42
|
+
# {Google::Cloud#bigtable}.
|
42
43
|
#
|
43
44
|
# @example Obtaining an instance and the clusters from a project.
|
44
45
|
# require "google/cloud"
|
@@ -130,7 +131,7 @@ module Google
|
|
130
131
|
|
131
132
|
# Create a Bigtable instance.
|
132
133
|
#
|
133
|
-
# @see https://cloud.google.com/compute/docs/regions-zones
|
134
|
+
# @see https://cloud.google.com/compute/docs/regions-zones Cluster zone locations
|
134
135
|
#
|
135
136
|
# @param instance_id [String] The unique identifier for the instance,
|
136
137
|
# which cannot be changed after the instance is created. Values are of
|
@@ -158,7 +159,7 @@ module Google
|
|
158
159
|
# * No more than 64 labels can be associated with a given resource.
|
159
160
|
# @param clusters [Hash{String => Google::Cloud::Bigtable::Cluster}]
|
160
161
|
# (See {Google::Cloud::Bigtable::Instance::ClusterMap})
|
161
|
-
# If
|
162
|
+
# If unspecified, you may use a code block to add clusters.
|
162
163
|
# Minimum one cluster must be specified.
|
163
164
|
# @yield [clusters] A block for adding clusters.
|
164
165
|
# @yieldparam [Hash{String => Google::Cloud::Bigtable::Cluster}]
|
@@ -341,7 +342,7 @@ module Google
|
|
341
342
|
# bigtable = Google::Cloud::Bigtable.new
|
342
343
|
#
|
343
344
|
# table = bigtable.table("my-instance", "my-table", view: :FULL, perform_lookup: true)
|
344
|
-
#
|
345
|
+
# if table
|
345
346
|
# puts table.name
|
346
347
|
# p table.column_families
|
347
348
|
# p table.cluster_states
|
@@ -359,7 +360,7 @@ module Google
|
|
359
360
|
# "cf-1",
|
360
361
|
# "field-1",
|
361
362
|
# "XYZ"
|
362
|
-
# timestamp: Time.now.to_i * 1000
|
363
|
+
# timestamp: Time.now.to_i * 1000 # Timestamp in milliseconds.
|
363
364
|
# ).delete_from_column("cf2", "field02")
|
364
365
|
#
|
365
366
|
# table.mutate_row(entry)
|
@@ -371,7 +372,7 @@ module Google
|
|
371
372
|
# table = bigtable.table("my-instance", "my-table", app_profile_id: "my-app-profile")
|
372
373
|
#
|
373
374
|
# table.read_rows(limit: 5).each do |row|
|
374
|
-
# row
|
375
|
+
# p row
|
375
376
|
# end
|
376
377
|
|
377
378
|
def table \
|
@@ -406,32 +407,31 @@ module Google
|
|
406
407
|
# The unique Id of the instance in which to create the table.
|
407
408
|
# @param table_id [String]
|
408
409
|
# The name by which the new table should be referred to within the parent
|
409
|
-
# instance, e.g.,
|
410
|
+
# instance, e.g., `foobar`
|
410
411
|
# @param column_families [Hash{String => Google::Cloud::Bigtable::ColumnFamily}]
|
411
412
|
# (See {Google::Cloud::Bigtable::Table::ColumnFamilyMap})
|
412
|
-
# If
|
413
|
+
# If unspecified, you may use a code block to add column families.
|
413
414
|
# @param granularity [Symbol]
|
414
415
|
# The granularity at which timestamps are stored in this table.
|
415
416
|
# Timestamps not matching the granularity will be rejected.
|
416
417
|
# Valid values are `:MILLIS`.
|
417
|
-
# If unspecified, the value will be set to `:MILLIS
|
418
|
+
# If unspecified, the value will be set to `:MILLIS`.
|
418
419
|
# @param initial_splits [Array<String>]
|
419
420
|
# The optional list of row keys that will be used to initially split the
|
420
421
|
# table into several tablets (tablets are similar to HBase regions).
|
421
|
-
# Given two split keys,
|
422
|
-
# spanning the key ranges:
|
422
|
+
# Given two split keys, `s1` and `s2`, three tablets will be created,
|
423
|
+
# spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
|
423
424
|
#
|
424
425
|
# Example:
|
425
426
|
#
|
426
|
-
# * Row keys := ["a", "apple", "custom", "customer_1", "customer_2"
|
427
|
-
#
|
428
|
-
# * initial_split_keys := +["apple", "customer_1", "customer_2", "other"]+
|
427
|
+
# * Row keys := `["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]`
|
428
|
+
# * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
|
429
429
|
# * Key assignment:
|
430
|
-
# * Tablet 1 :
|
431
|
-
# * Tablet 2 :
|
432
|
-
# * Tablet 3 :
|
433
|
-
# * Tablet 4 :
|
434
|
-
# * Tablet 5 :
|
430
|
+
# * Tablet 1 : `[, apple) => {"a"}`
|
431
|
+
# * Tablet 2 : `[apple, customer_1) => {"apple", "custom"}`
|
432
|
+
# * Tablet 3 : `[customer_1, customer_2) => {"customer_1"}`
|
433
|
+
# * Tablet 4 : `[customer_2, other) => {"customer_2"}`
|
434
|
+
# * Tablet 5 : `[other, ) => {"other", "zz"}`
|
435
435
|
# A hash of the same form as `Google::Bigtable::Admin::V2::CreateTableRequest::Split`
|
436
436
|
# can also be provided.
|
437
437
|
# @yield [column_families] A block for adding column_families.
|
@@ -494,7 +494,7 @@ module Google
|
|
494
494
|
# The unique Id of the instance in which table is exists.
|
495
495
|
# @param table_id [String]
|
496
496
|
# The unique name of the table to be deleted.
|
497
|
-
# e.g.,
|
497
|
+
# e.g., `foobar`
|
498
498
|
#
|
499
499
|
# @example Create table with column families and initial splits.
|
500
500
|
# require "google/cloud/bigtable"
|
@@ -208,9 +208,9 @@ module Google
|
|
208
208
|
# table = bigtable.table("my-instance", "my-table")
|
209
209
|
#
|
210
210
|
# if table.exists?
|
211
|
-
# p "Table
|
211
|
+
# p "Table exists."
|
212
212
|
# else
|
213
|
-
# p "Table
|
213
|
+
# p "Table does not exist"
|
214
214
|
# end
|
215
215
|
#
|
216
216
|
# @example Using bigtable instance
|
@@ -222,9 +222,9 @@ module Google
|
|
222
222
|
# table = bigtable.table("my-table")
|
223
223
|
#
|
224
224
|
# if table.exists?
|
225
|
-
# p "Table
|
225
|
+
# p "Table exists."
|
226
226
|
# else
|
227
|
-
# p "Table
|
227
|
+
# p "Table does not exist"
|
228
228
|
# end
|
229
229
|
#
|
230
230
|
|
@@ -234,11 +234,12 @@ module Google
|
|
234
234
|
false
|
235
235
|
end
|
236
236
|
|
237
|
-
#
|
237
|
+
# Returns a column family object that can be used to perform create,
|
238
|
+
# update, or delete operations.
|
238
239
|
#
|
239
240
|
# @param name [String] Name of the column family
|
240
241
|
# @param gc_rule [Google::Cloud::Bigtable::GcRule] Optional.
|
241
|
-
#
|
242
|
+
# Required for create and update operations.
|
242
243
|
#
|
243
244
|
# @example Create column family
|
244
245
|
# require "google/cloud/bigtable"
|
@@ -467,12 +468,12 @@ module Google
|
|
467
468
|
response.consistent
|
468
469
|
end
|
469
470
|
|
470
|
-
# Wait for replication to check replication consistency
|
471
|
-
# Checks replication consistency by generating consistency token and
|
472
|
-
# calling
|
473
|
-
# If the response is consistent
|
474
|
-
#
|
475
|
-
#
|
471
|
+
# Wait for replication to check replication consistency.
|
472
|
+
# Checks replication consistency by generating a consistency token and
|
473
|
+
# calling the `check_consistency` api call 5 times (by default).
|
474
|
+
# If the response is consistent, returns true. Otherwise tries again
|
475
|
+
# repeatedly until the timeout. If the check does not succeed by the
|
476
|
+
# timeout, returns `false`.
|
476
477
|
#
|
477
478
|
# @param timeout [Integer]
|
478
479
|
# Timeout in seconds. Defaults value is 600 seconds.
|
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# rubocop:disable LineLength
|
22
22
|
|
23
23
|
##
|
24
|
-
# # Ruby Client for Cloud Bigtable API ([Alpha](https://github.com/
|
24
|
+
# # Ruby Client for Cloud Bigtable API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
|
25
25
|
#
|
26
26
|
# [Cloud Bigtable API][Product Documentation]:
|
27
27
|
# API for reading and writing the contents of Bigtables associated with a
|
@@ -35,7 +35,7 @@ module Google
|
|
35
35
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
36
36
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
37
37
|
# 3. [Enable the Cloud Bigtable API.](https://console.cloud.google.com/apis/library/bigtable.googleapis.com)
|
38
|
-
# 4. [Setup Authentication.](https://
|
38
|
+
# 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
39
39
|
#
|
40
40
|
# ### Installation
|
41
41
|
# ```
|
@@ -45,7 +45,7 @@ module Google
|
|
45
45
|
# ### Next Steps
|
46
46
|
# - Read the [Cloud Bigtable API Product documentation][Product Documentation]
|
47
47
|
# to learn more about the product and see How-to Guides.
|
48
|
-
# - View this [repository's main README](https://github.com/
|
48
|
+
# - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
49
49
|
# to see the full list of Cloud APIs that we cover.
|
50
50
|
#
|
51
51
|
# [Product Documentation]: https://cloud.google.com/bigtable
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
#
|
55
55
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
56
56
|
# The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
57
|
-
# or a [`Google::Cloud::Logging::Logger`](https://
|
57
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
|
58
58
|
# that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
59
59
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
60
60
|
#
|
@@ -245,7 +245,7 @@ module Google
|
|
245
245
|
# @param table_name [String]
|
246
246
|
# The unique name of the table from which to read.
|
247
247
|
# Values are of the form
|
248
|
-
#
|
248
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
249
249
|
# @param app_profile_id [String]
|
250
250
|
# This value specifies routing for replication. If not specified, the
|
251
251
|
# "default" application profile will be used.
|
@@ -303,7 +303,7 @@ module Google
|
|
303
303
|
# @param table_name [String]
|
304
304
|
# The unique name of the table from which to sample row keys.
|
305
305
|
# Values are of the form
|
306
|
-
#
|
306
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
307
307
|
# @param app_profile_id [String]
|
308
308
|
# This value specifies routing for replication. If not specified, the
|
309
309
|
# "default" application profile will be used.
|
@@ -336,12 +336,12 @@ module Google
|
|
336
336
|
end
|
337
337
|
|
338
338
|
# Mutates a row atomically. Cells already present in the row are left
|
339
|
-
# unchanged unless explicitly changed by
|
339
|
+
# unchanged unless explicitly changed by `mutation`.
|
340
340
|
#
|
341
341
|
# @param table_name [String]
|
342
342
|
# The unique name of the table to which the mutation should be applied.
|
343
343
|
# Values are of the form
|
344
|
-
#
|
344
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
345
345
|
# @param row_key [String]
|
346
346
|
# The key of the row to which the mutation should be applied.
|
347
347
|
# @param mutations [Array<Google::Bigtable::V2::Mutation | Hash>]
|
@@ -367,10 +367,10 @@ module Google
|
|
367
367
|
# bigtable_client = Google::Cloud::Bigtable::V2.new
|
368
368
|
# formatted_table_name = Google::Cloud::Bigtable::V2::BigtableClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
|
369
369
|
#
|
370
|
-
# # TODO: Initialize
|
370
|
+
# # TODO: Initialize `row_key`:
|
371
371
|
# row_key = ''
|
372
372
|
#
|
373
|
-
# # TODO: Initialize
|
373
|
+
# # TODO: Initialize `mutations`:
|
374
374
|
# mutations = []
|
375
375
|
# response = bigtable_client.mutate_row(formatted_table_name, row_key, mutations)
|
376
376
|
|
@@ -421,7 +421,7 @@ module Google
|
|
421
421
|
# bigtable_client = Google::Cloud::Bigtable::V2.new
|
422
422
|
# formatted_table_name = Google::Cloud::Bigtable::V2::BigtableClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
|
423
423
|
#
|
424
|
-
# # TODO: Initialize
|
424
|
+
# # TODO: Initialize `entries`:
|
425
425
|
# entries = []
|
426
426
|
# bigtable_client.mutate_rows(formatted_table_name, entries).each do |element|
|
427
427
|
# # Process element.
|
@@ -447,7 +447,7 @@ module Google
|
|
447
447
|
# The unique name of the table to which the conditional mutation should be
|
448
448
|
# applied.
|
449
449
|
# Values are of the form
|
450
|
-
#
|
450
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
451
451
|
# @param row_key [String]
|
452
452
|
# The key of the row to which the conditional mutation should be applied.
|
453
453
|
# @param app_profile_id [String]
|
@@ -455,24 +455,24 @@ module Google
|
|
455
455
|
# "default" application profile will be used.
|
456
456
|
# @param predicate_filter [Google::Bigtable::V2::RowFilter | Hash]
|
457
457
|
# The filter to be applied to the contents of the specified row. Depending
|
458
|
-
# on whether or not any results are yielded, either
|
459
|
-
#
|
458
|
+
# on whether or not any results are yielded, either `true_mutations` or
|
459
|
+
# `false_mutations` will be executed. If unset, checks that the row contains
|
460
460
|
# any values at all.
|
461
461
|
# A hash of the same form as `Google::Bigtable::V2::RowFilter`
|
462
462
|
# can also be provided.
|
463
463
|
# @param true_mutations [Array<Google::Bigtable::V2::Mutation | Hash>]
|
464
|
-
# Changes to be atomically applied to the specified row if
|
465
|
-
# yields at least one cell when applied to
|
464
|
+
# Changes to be atomically applied to the specified row if `predicate_filter`
|
465
|
+
# yields at least one cell when applied to `row_key`. Entries are applied in
|
466
466
|
# order, meaning that earlier mutations can be masked by later ones.
|
467
|
-
# Must contain at least one entry if
|
467
|
+
# Must contain at least one entry if `false_mutations` is empty, and at most
|
468
468
|
# 100000.
|
469
469
|
# A hash of the same form as `Google::Bigtable::V2::Mutation`
|
470
470
|
# can also be provided.
|
471
471
|
# @param false_mutations [Array<Google::Bigtable::V2::Mutation | Hash>]
|
472
|
-
# Changes to be atomically applied to the specified row if
|
473
|
-
# does not yield any cells when applied to
|
472
|
+
# Changes to be atomically applied to the specified row if `predicate_filter`
|
473
|
+
# does not yield any cells when applied to `row_key`. Entries are applied in
|
474
474
|
# order, meaning that earlier mutations can be masked by later ones.
|
475
|
-
# Must contain at least one entry if
|
475
|
+
# Must contain at least one entry if `true_mutations` is empty, and at most
|
476
476
|
# 100000.
|
477
477
|
# A hash of the same form as `Google::Bigtable::V2::Mutation`
|
478
478
|
# can also be provided.
|
@@ -490,7 +490,7 @@ module Google
|
|
490
490
|
# bigtable_client = Google::Cloud::Bigtable::V2.new
|
491
491
|
# formatted_table_name = Google::Cloud::Bigtable::V2::BigtableClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
|
492
492
|
#
|
493
|
-
# # TODO: Initialize
|
493
|
+
# # TODO: Initialize `row_key`:
|
494
494
|
# row_key = ''
|
495
495
|
# response = bigtable_client.check_and_mutate_row(formatted_table_name, row_key)
|
496
496
|
|
@@ -525,7 +525,7 @@ module Google
|
|
525
525
|
# The unique name of the table to which the read/modify/write rules should be
|
526
526
|
# applied.
|
527
527
|
# Values are of the form
|
528
|
-
#
|
528
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
529
529
|
# @param row_key [String]
|
530
530
|
# The key of the row to which the read/modify/write rules should be applied.
|
531
531
|
# @param rules [Array<Google::Bigtable::V2::ReadModifyWriteRule | Hash>]
|
@@ -551,10 +551,10 @@ module Google
|
|
551
551
|
# bigtable_client = Google::Cloud::Bigtable::V2.new
|
552
552
|
# formatted_table_name = Google::Cloud::Bigtable::V2::BigtableClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
|
553
553
|
#
|
554
|
-
# # TODO: Initialize
|
554
|
+
# # TODO: Initialize `row_key`:
|
555
555
|
# row_key = ''
|
556
556
|
#
|
557
|
-
# # TODO: Initialize
|
557
|
+
# # TODO: Initialize `rules`:
|
558
558
|
# rules = []
|
559
559
|
# response = bigtable_client.read_modify_write_row(formatted_table_name, row_key, rules)
|
560
560
|
|
@@ -21,7 +21,7 @@ module Google
|
|
21
21
|
# @return [String]
|
22
22
|
# The unique name of the table from which to read.
|
23
23
|
# Values are of the form
|
24
|
-
#
|
24
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
25
25
|
# @!attribute [rw] app_profile_id
|
26
26
|
# @return [String]
|
27
27
|
# This value specifies routing for replication. If not specified, the
|
@@ -67,14 +67,14 @@ module Google
|
|
67
67
|
# family as the previous CellChunk. The empty string can occur as a
|
68
68
|
# column family name in a response so clients must check
|
69
69
|
# explicitly for the presence of this message, not just for
|
70
|
-
#
|
70
|
+
# `family_name.value` being non-empty.
|
71
71
|
# @!attribute [rw] qualifier
|
72
72
|
# @return [Google::Protobuf::BytesValue]
|
73
73
|
# The column qualifier for this chunk of data. If this message
|
74
74
|
# is not present, this CellChunk is a continuation of the same column
|
75
75
|
# as the previous CellChunk. Column qualifiers may be empty so
|
76
76
|
# clients must check for the presence of this message, not just
|
77
|
-
# for
|
77
|
+
# for `qualifier.value` being non-empty.
|
78
78
|
# @!attribute [rw] timestamp_micros
|
79
79
|
# @return [Integer]
|
80
80
|
# The cell's stored timestamp, which also uniquely identifies it
|
@@ -82,7 +82,7 @@ module Google
|
|
82
82
|
# microseconds, but individual tables may set a coarser
|
83
83
|
# granularity to further restrict the allowed values. For
|
84
84
|
# example, a table which specifies millisecond granularity will
|
85
|
-
# only allow values of
|
85
|
+
# only allow values of `timestamp_micros` which are multiples of
|
86
86
|
# 1000. Timestamps are only set in the first CellChunk per cell
|
87
87
|
# (for cells split into multiple chunks).
|
88
88
|
# @!attribute [rw] labels
|
@@ -106,11 +106,11 @@ module Google
|
|
106
106
|
# @!attribute [rw] reset_row
|
107
107
|
# @return [true, false]
|
108
108
|
# Indicates that the client should drop all previous chunks for
|
109
|
-
#
|
109
|
+
# `row_key`, as it will be re-read from the beginning.
|
110
110
|
# @!attribute [rw] commit_row
|
111
111
|
# @return [true, false]
|
112
112
|
# Indicates that the client can safely process all previous chunks for
|
113
|
-
#
|
113
|
+
# `row_key`, as its data has been fully read.
|
114
114
|
class CellChunk; end
|
115
115
|
end
|
116
116
|
|
@@ -119,7 +119,7 @@ module Google
|
|
119
119
|
# @return [String]
|
120
120
|
# The unique name of the table from which to sample row keys.
|
121
121
|
# Values are of the form
|
122
|
-
#
|
122
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
123
123
|
# @!attribute [rw] app_profile_id
|
124
124
|
# @return [String]
|
125
125
|
# This value specifies routing for replication. If not specified, the
|
@@ -139,9 +139,9 @@ module Google
|
|
139
139
|
# @!attribute [rw] offset_bytes
|
140
140
|
# @return [Integer]
|
141
141
|
# Approximate total storage space used by all rows in the table which precede
|
142
|
-
#
|
142
|
+
# `row_key`. Buffering the contents of all rows between two subsequent
|
143
143
|
# samples would require space roughly equal to the difference in their
|
144
|
-
#
|
144
|
+
# `offset_bytes` fields.
|
145
145
|
class SampleRowKeysResponse; end
|
146
146
|
|
147
147
|
# Request message for Bigtable.MutateRow.
|
@@ -149,7 +149,7 @@ module Google
|
|
149
149
|
# @return [String]
|
150
150
|
# The unique name of the table to which the mutation should be applied.
|
151
151
|
# Values are of the form
|
152
|
-
#
|
152
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
153
153
|
# @!attribute [rw] app_profile_id
|
154
154
|
# @return [String]
|
155
155
|
# This value specifies routing for replication. If not specified, the
|
@@ -185,7 +185,7 @@ module Google
|
|
185
185
|
class MutateRowsRequest
|
186
186
|
# @!attribute [rw] row_key
|
187
187
|
# @return [String]
|
188
|
-
# The key of the row to which the
|
188
|
+
# The key of the row to which the `mutations` should be applied.
|
189
189
|
# @!attribute [rw] mutations
|
190
190
|
# @return [Array<Google::Bigtable::V2::Mutation>]
|
191
191
|
# Changes to be atomically applied to the specified row. Mutations are
|
@@ -202,11 +202,11 @@ module Google
|
|
202
202
|
class MutateRowsResponse
|
203
203
|
# @!attribute [rw] index
|
204
204
|
# @return [Integer]
|
205
|
-
# The index into the original request's
|
205
|
+
# The index into the original request's `entries` list of the Entry
|
206
206
|
# for which a result is being reported.
|
207
207
|
# @!attribute [rw] status
|
208
208
|
# @return [Google::Rpc::Status]
|
209
|
-
# The result of the request Entry identified by
|
209
|
+
# The result of the request Entry identified by `index`.
|
210
210
|
# Depending on how requests are batched during execution, it is possible
|
211
211
|
# for one Entry to fail due to an error with another Entry. In the event
|
212
212
|
# that this occurs, the same error will be reported for both entries.
|
@@ -219,7 +219,7 @@ module Google
|
|
219
219
|
# The unique name of the table to which the conditional mutation should be
|
220
220
|
# applied.
|
221
221
|
# Values are of the form
|
222
|
-
#
|
222
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
223
223
|
# @!attribute [rw] app_profile_id
|
224
224
|
# @return [String]
|
225
225
|
# This value specifies routing for replication. If not specified, the
|
@@ -230,29 +230,29 @@ module Google
|
|
230
230
|
# @!attribute [rw] predicate_filter
|
231
231
|
# @return [Google::Bigtable::V2::RowFilter]
|
232
232
|
# The filter to be applied to the contents of the specified row. Depending
|
233
|
-
# on whether or not any results are yielded, either
|
234
|
-
#
|
233
|
+
# on whether or not any results are yielded, either `true_mutations` or
|
234
|
+
# `false_mutations` will be executed. If unset, checks that the row contains
|
235
235
|
# any values at all.
|
236
236
|
# @!attribute [rw] true_mutations
|
237
237
|
# @return [Array<Google::Bigtable::V2::Mutation>]
|
238
|
-
# Changes to be atomically applied to the specified row if
|
239
|
-
# yields at least one cell when applied to
|
238
|
+
# Changes to be atomically applied to the specified row if `predicate_filter`
|
239
|
+
# yields at least one cell when applied to `row_key`. Entries are applied in
|
240
240
|
# order, meaning that earlier mutations can be masked by later ones.
|
241
|
-
# Must contain at least one entry if
|
241
|
+
# Must contain at least one entry if `false_mutations` is empty, and at most
|
242
242
|
# 100000.
|
243
243
|
# @!attribute [rw] false_mutations
|
244
244
|
# @return [Array<Google::Bigtable::V2::Mutation>]
|
245
|
-
# Changes to be atomically applied to the specified row if
|
246
|
-
# does not yield any cells when applied to
|
245
|
+
# Changes to be atomically applied to the specified row if `predicate_filter`
|
246
|
+
# does not yield any cells when applied to `row_key`. Entries are applied in
|
247
247
|
# order, meaning that earlier mutations can be masked by later ones.
|
248
|
-
# Must contain at least one entry if
|
248
|
+
# Must contain at least one entry if `true_mutations` is empty, and at most
|
249
249
|
# 100000.
|
250
250
|
class CheckAndMutateRowRequest; end
|
251
251
|
|
252
252
|
# Response message for Bigtable.CheckAndMutateRow.
|
253
253
|
# @!attribute [rw] predicate_matched
|
254
254
|
# @return [true, false]
|
255
|
-
# Whether or not the request's
|
255
|
+
# Whether or not the request's `predicate_filter` yielded any results for
|
256
256
|
# the specified row.
|
257
257
|
class CheckAndMutateRowResponse; end
|
258
258
|
|
@@ -262,7 +262,7 @@ module Google
|
|
262
262
|
# The unique name of the table to which the read/modify/write rules should be
|
263
263
|
# applied.
|
264
264
|
# Values are of the form
|
265
|
-
#
|
265
|
+
# `projects/<project>/instances/<instance>/tables/<table>`.
|
266
266
|
# @!attribute [rw] app_profile_id
|
267
267
|
# @return [String]
|
268
268
|
# This value specifies routing for replication. If not specified, the
|