Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Commit 433a8e3

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add fields and the BackupType proto for Hot Backups (#1439)
* feat: add fields and the BackupType proto for Hot Backups docs: clarify comments and fix typos PiperOrigin-RevId: 658791576 Source-Link: googleapis/googleapis@c93b54f Source-Link: googleapis/googleapis-gen@e52ba38 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTUyYmEzOGE5NWE4MmY3NTg4ZDBkZDNhMjI4NGM5ODg1MGRhYjllMSJ9 feat: add MergeToCell to Mutation APIs PiperOrigin-RevId: 654025780 Source-Link: googleapis/googleapis@9effffd Source-Link: googleapis/googleapis-gen@28db5a5 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjhkYjVhNWRmN2M0YzI0YWRiM2IwMTA4NmMzZGIyYWY5NzYyNDFiMyJ9 feat: Add min, max, hll aggregators and more types docs: Corrected various type documentation PiperOrigin-RevId: 654022916 Source-Link: googleapis/googleapis@157e3bf Source-Link: googleapis/googleapis-gen@f781685 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZjc4MTY4NWFkNTJkNThiMTk4YmFmOTVmYTEyMGQ4Nzg3N2IzZTQ2ZSJ9 feat: update Go Datastore import path feat: update Go Bigtable import path PiperOrigin-RevId: 651776284 Source-Link: googleapis/googleapis@b8eed55 Source-Link: googleapis/googleapis-gen@9d7fe2c Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOWQ3ZmUyYzQ4OGU4NzY3MWU2ODZlM2ExOWFhOGNmNGYwNzFlODA2YSJ9 feat: publish ProtoRows Message This is needed to parse ExecuteQuery responses PiperOrigin-RevId: 651386373 Source-Link: googleapis/googleapis@a5be6fa Source-Link: googleapis/googleapis-gen@d467ce8 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDQ2N2NlODkzYTA0YzQxZTUwNDk4MzM0NmMyMTVkNDFmZDI2MzY1MCJ9 feat: publish the Cloud Bigtable ExecuteQuery API The ExecuteQuery API will allow users to query Bigtable using SQL PiperOrigin-RevId: 650660213 Source-Link: googleapis/googleapis@f681f79 Source-Link: googleapis/googleapis-gen@3180845 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzE4MDg0NTQ4NzEzNjc5NDk1MmI4ZjM2NWZlNmM2ODY4OTk5ZDljMCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent ed942c5 commit 433a8e3

24 files changed

Lines changed: 33574 additions & 14738 deletions

‎protos/google/bigtable/admin/v2/bigtable_instance_admin.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import "google/protobuf/field_mask.proto";
2929
import "google/protobuf/timestamp.proto";
3030

3131
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
32-
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
32+
option go_package = "cloud.google.com/go/bigtable/admin/apiv2/adminpb;adminpb";
3333
option java_multiple_files = true;
3434
option java_outer_classname = "BigtableInstanceAdminProto";
3535
option java_package = "com.google.bigtable.admin.v2";

‎protos/google/bigtable/admin/v2/bigtable_table_admin.proto‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import "google/protobuf/field_mask.proto";
3131
import "google/protobuf/timestamp.proto";
3232

3333
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
34-
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
34+
option go_package = "cloud.google.com/go/bigtable/admin/apiv2/adminpb;adminpb";
3535
option java_multiple_files = true;
3636
option java_outer_classname = "BigtableTableAdminProto";
3737
option java_package = "com.google.bigtable.admin.v2";
@@ -360,7 +360,7 @@ service BigtableTableAdmin {
360360
// returned table [long-running operation][google.longrunning.Operation] can
361361
// be used to track the progress of the operation, and to cancel it. The
362362
// [metadata][google.longrunning.Operation.metadata] field type is
363-
// [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The
363+
// [RestoreTableMetadata][google.bigtable.admin.v2.RestoreTableMetadata]. The
364364
// [response][google.longrunning.Operation.response] type is
365365
// [Table][google.bigtable.admin.v2.Table], if successful.
366366
rpc RestoreTable(RestoreTableRequest) returns (google.longrunning.Operation) {
@@ -1219,7 +1219,7 @@ message ListBackupsResponse {
12191219
// [CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
12201220
message CopyBackupRequest {
12211221
// Required. The name of the destination cluster that will contain the backup
1222-
// copy. The cluster must already exists. Values are of the form:
1222+
// copy. The cluster must already exist. Values are of the form:
12231223
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
12241224
string parent = 1 [
12251225
(google.api.field_behavior) = REQUIRED,

‎protos/google/bigtable/admin/v2/common.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ package google.bigtable.admin.v2;
1919
import "google/protobuf/timestamp.proto";
2020

2121
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
22-
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
22+
option go_package = "cloud.google.com/go/bigtable/admin/apiv2/adminpb;adminpb";
2323
option java_multiple_files = true;
2424
option java_outer_classname = "CommonProto";
2525
option java_package = "com.google.bigtable.admin.v2";

‎protos/google/bigtable/admin/v2/instance.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import "google/bigtable/admin/v2/common.proto";
2222
import "google/protobuf/timestamp.proto";
2323

2424
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
25-
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
25+
option go_package = "cloud.google.com/go/bigtable/admin/apiv2/adminpb;adminpb";
2626
option java_multiple_files = true;
2727
option java_outer_classname = "InstanceProto";
2828
option java_package = "com.google.bigtable.admin.v2";

‎protos/google/bigtable/admin/v2/table.proto‎

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import "google/protobuf/timestamp.proto";
2424
import "google/rpc/status.proto";
2525

2626
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
27-
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
27+
option go_package = "cloud.google.com/go/bigtable/admin/apiv2/adminpb;adminpb";
2828
option java_multiple_files = true;
2929
option java_outer_classname = "TableProto";
3030
option java_package = "com.google.bigtable.admin.v2";
@@ -456,6 +456,23 @@ message Backup {
456456
READY = 2;
457457
}
458458

459+
// The type of the backup.
460+
enum BackupType {
461+
// Not specified.
462+
BACKUP_TYPE_UNSPECIFIED = 0;
463+
464+
// The default type for Cloud Bigtable managed backups. Supported for
465+
// backups created in both HDD and SSD instances. Requires optimization when
466+
// restored to a table in an SSD instance.
467+
STANDARD = 1;
468+
469+
// A backup type with faster restore to SSD performance. Only supported for
470+
// backups created in SSD instances. A new SSD table restored from a hot
471+
// backup reaches production performance more quickly than a standard
472+
// backup.
473+
HOT = 2;
474+
}
475+
459476
// A globally unique identifier for the backup which cannot be
460477
// changed. Values are of the form
461478
// `projects/{project}/instances/{instance}/clusters/{cluster}/
@@ -478,14 +495,17 @@ message Backup {
478495

479496
// Output only. Name of the backup from which this backup was copied. If a
480497
// backup is not created by copying a backup, this field will be empty. Values
481-
// are of the form: projects/<project>/instances/<instance>/backups/<backup>.
498+
// are of the form:
499+
// projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>
482500
string source_backup = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
483501

484-
// Required. The expiration time of the backup, with microseconds
485-
// granularity that must be at least 6 hours and at most 90 days
486-
// from the time the request is received. Once the `expire_time`
487-
// has passed, Cloud Bigtable will delete the backup and free the
488-
// resources used by the backup.
502+
// Required. The expiration time of the backup.
503+
// When creating a backup or updating its `expire_time`, the value must be
504+
// greater than the backup creation time by:
505+
// - At least 6 hours
506+
// - At most 90 days
507+
//
508+
// Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
489509
google.protobuf.Timestamp expire_time = 3
490510
[(google.api.field_behavior) = REQUIRED];
491511

@@ -511,6 +531,19 @@ message Backup {
511531
// Output only. The encryption information for the backup.
512532
EncryptionInfo encryption_info = 9
513533
[(google.api.field_behavior) = OUTPUT_ONLY];
534+
535+
// Indicates the backup type of the backup.
536+
BackupType backup_type = 11;
537+
538+
// The time at which the hot backup will be converted to a standard backup.
539+
// Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the
540+
// hot backup to a standard backup. This value must be greater than the backup
541+
// creation time by:
542+
// - At least 24 hours
543+
//
544+
// This field only applies for hot backups. When creating or updating a
545+
// standard backup, attempting to set this field will fail the request.
546+
google.protobuf.Timestamp hot_to_standard_time = 12;
514547
}
515548

516549
// Information about a backup.
@@ -533,7 +566,8 @@ message BackupInfo {
533566

534567
// Output only. Name of the backup from which this backup was copied. If a
535568
// backup is not created by copying a backup, this field will be empty. Values
536-
// are of the form: projects/<project>/instances/<instance>/backups/<backup>.
569+
// are of the form:
570+
// projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>
537571
string source_backup = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
538572
}
539573

‎protos/google/bigtable/admin/v2/types.proto‎

Lines changed: 138 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ package google.bigtable.admin.v2;
1919
import "google/api/field_behavior.proto";
2020

2121
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
22-
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
22+
option go_package = "cloud.google.com/go/bigtable/admin/apiv2/adminpb;adminpb";
2323
option java_multiple_files = true;
2424
option java_outer_classname = "TypesProto";
2525
option java_package = "com.google.bigtable.admin.v2";
@@ -32,27 +32,22 @@ option ruby_package = "Google::Cloud::Bigtable::Admin::V2";
3232
//
3333
// For compatibility with Bigtable's existing untyped APIs, each `Type` includes
3434
// an `Encoding` which describes how to convert to/from the underlying data.
35-
// This might involve composing a series of steps into an "encoding chain," for
36-
// example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link"
37-
// in the encoding chain will be based an on existing GoogleSQL conversion
38-
// function like `CAST`.
3935
//
40-
// Each link in the encoding chain also defines the following properties:
41-
// * Natural sort: Does the encoded value sort consistently with the original
42-
// typed value? Note that Bigtable will always sort data based on the raw
43-
// encoded value, *not* the decoded type.
36+
// Each encoding also defines the following properties:
37+
//
38+
// * Order-preserving: Does the encoded value sort consistently with the
39+
// original typed value? Note that Bigtable will always sort data based on
40+
// the raw encoded value, *not* the decoded type.
4441
// - Example: BYTES values sort in the same order as their raw encodings.
45-
// - Counterexample: Encoding INT64 to a fixed-width STRING does *not*
46-
// preserve sort order when dealing with negative numbers.
47-
// INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001).
48-
// - The overall encoding chain has this property if *every* link does.
42+
// - Counterexample: Encoding INT64 as a fixed-width decimal string does
43+
// *not* preserve sort order when dealing with negative numbers.
44+
// `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`.
4945
// * Self-delimiting: If we concatenate two encoded values, can we always tell
5046
// where the first one ends and the second one begins?
5147
// - Example: If we encode INT64s to fixed-width STRINGs, the first value
5248
// will always contain exactly N digits, possibly preceded by a sign.
5349
// - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have
5450
// no way to tell where the first one ends.
55-
// - The overall encoding chain has this property if *any* link does.
5651
// * Compatibility: Which other systems have matching encoding schemes? For
5752
// example, does this encoding have a GoogleSQL equivalent? HBase? Java?
5853
message Type {
@@ -62,7 +57,7 @@ message Type {
6257
// Rules used to convert to/from lower level types.
6358
message Encoding {
6459
// Leaves the value "as-is"
65-
// * Natural sort? Yes
60+
// * Order-preserving? Yes
6661
// * Self-delimiting? No
6762
// * Compatibility? N/A
6863
message Raw {}
@@ -83,19 +78,27 @@ message Type {
8378
message String {
8479
// Rules used to convert to/from lower level types.
8580
message Encoding {
81+
// Deprecated: prefer the equivalent `Utf8Bytes`.
82+
message Utf8Raw {
83+
option deprecated = true;
84+
}
85+
8686
// UTF-8 encoding
87-
// * Natural sort? No (ASCII characters only)
87+
// * Order-preserving? Yes (code point order)
8888
// * Self-delimiting? No
8989
// * Compatibility?
9090
// - BigQuery Federation `TEXT` encoding
9191
// - HBase `Bytes.toBytes`
9292
// - Java `String#getBytes(StandardCharsets.UTF_8)`
93-
message Utf8Raw {}
93+
message Utf8Bytes {}
9494

9595
// Which encoding to use.
9696
oneof encoding {
97-
// Use `Utf8Raw` encoding.
98-
Utf8Raw utf8_raw = 1;
97+
// Deprecated: if set, converts to an empty `utf8_bytes`.
98+
Utf8Raw utf8_raw = 1 [deprecated = true];
99+
100+
// Use `Utf8Bytes` encoding.
101+
Utf8Bytes utf8_bytes = 2;
99102
}
100103
}
101104

@@ -110,14 +113,14 @@ message Type {
110113
message Encoding {
111114
// Encodes the value as an 8-byte big endian twos complement `Bytes`
112115
// value.
113-
// * Natural sort? No (positive values only)
116+
// * Order-preserving? No (positive values only)
114117
// * Self-delimiting? Yes
115118
// * Compatibility?
116119
// - BigQuery Federation `BINARY` encoding
117120
// - HBase `Bytes.toBytes`
118121
// - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`
119122
message BigEndianBytes {
120-
// The underlying `Bytes` type, which may be able to encode further.
123+
// Deprecated: ignored if set.
121124
Bytes bytes_type = 1;
122125
}
123126

@@ -132,6 +135,68 @@ message Type {
132135
Encoding encoding = 1;
133136
}
134137

138+
// bool
139+
// Values of type `Bool` are stored in `Value.bool_value`.
140+
message Bool {}
141+
142+
// Float32
143+
// Values of type `Float32` are stored in `Value.float_value`.
144+
message Float32 {}
145+
146+
// Float64
147+
// Values of type `Float64` are stored in `Value.float_value`.
148+
message Float64 {}
149+
150+
// Timestamp
151+
// Values of type `Timestamp` are stored in `Value.timestamp_value`.
152+
message Timestamp {}
153+
154+
// Date
155+
// Values of type `Date` are stored in `Value.date_value`.
156+
message Date {}
157+
158+
// A structured data value, consisting of fields which map to dynamically
159+
// typed values.
160+
// Values of type `Struct` are stored in `Value.array_value` where entries are
161+
// in the same order and number as `field_types`.
162+
message Struct {
163+
// A struct field and its type.
164+
message Field {
165+
// The field name (optional). Fields without a `field_name` are considered
166+
// anonymous and cannot be referenced by name.
167+
string field_name = 1;
168+
169+
// The type of values in this field.
170+
Type type = 2;
171+
}
172+
173+
// The names and types of the fields in this struct.
174+
repeated Field fields = 1;
175+
}
176+
177+
// An ordered list of elements of a given type.
178+
// Values of type `Array` are stored in `Value.array_value`.
179+
message Array {
180+
// The type of the elements in the array. This must not be `Array`.
181+
Type element_type = 1;
182+
}
183+
184+
// A mapping of keys to values of a given type.
185+
// Values of type `Map` are stored in a `Value.array_value` where each entry
186+
// is another `Value.array_value` with two elements (the key and the value,
187+
// in that order).
188+
// Normally encoded Map values won't have repeated keys, however, clients are
189+
// expected to handle the case in which they do. If the same key appears
190+
// multiple times, the _last_ value takes precedence.
191+
message Map {
192+
// The type of a map key.
193+
// Only `Bytes`, `String`, and `Int64` are allowed as key types.
194+
Type key_type = 1;
195+
196+
// The type of the values in a map.
197+
Type value_type = 2;
198+
}
199+
135200
// A value that combines incremental updates into a summarized value.
136201
//
137202
// Data is never directly written or read using type `Aggregate`. Writes will
@@ -143,6 +208,25 @@ message Type {
143208
// State: same as input
144209
message Sum {}
145210

211+
// Computes the max of the input values.
212+
// Allowed input: `Int64`
213+
// State: same as input
214+
message Max {}
215+
216+
// Computes the min of the input values.
217+
// Allowed input: `Int64`
218+
// State: same as input
219+
message Min {}
220+
221+
// Computes an approximate unique count over the input values. When using
222+
// raw data as input, be careful to use a consistent encoding. Otherwise
223+
// the same value encoded differently could count more than once, or two
224+
// distinct values could count as identical.
225+
// Input: Any, or omit for Raw
226+
// State: TBD
227+
// Special state conversions: `Int64` (the unique count estimate)
228+
message HyperLogLogPlusPlusUniqueCount {}
229+
146230
// Type of the inputs that are accumulated by this `Aggregate`, which must
147231
// specify a full encoding.
148232
// Use `AddInput` mutations to accumulate new inputs.
@@ -157,6 +241,15 @@ message Type {
157241
oneof aggregator {
158242
// Sum aggregator.
159243
Sum sum = 4;
244+
245+
// HyperLogLogPlusPlusUniqueCount aggregator.
246+
HyperLogLogPlusPlusUniqueCount hllpp_unique_count = 5;
247+
248+
// Max aggregator.
249+
Max max = 6;
250+
251+
// Min aggregator.
252+
Min min = 7;
160253
}
161254
}
162255

@@ -171,7 +264,31 @@ message Type {
171264
// Int64
172265
Int64 int64_type = 5;
173266

267+
// Float32
268+
Float32 float32_type = 12;
269+
270+
// Float64
271+
Float64 float64_type = 9;
272+
273+
// Bool
274+
Bool bool_type = 8;
275+
276+
// Timestamp
277+
Timestamp timestamp_type = 10;
278+
279+
// Date
280+
Date date_type = 11;
281+
174282
// Aggregate
175283
Aggregate aggregate_type = 6;
284+
285+
// Struct
286+
Struct struct_type = 7;
287+
288+
// Array
289+
Array array_type = 3;
290+
291+
// Map
292+
Map map_type = 4;
176293
}
177294
}

0 commit comments

Comments
 (0)