Skip to content

Commit 97406be

Browse files
docs: A comment for field ranges in message .google.spanner.v1.KeySet is changed (#2407)
* docs: A comment for field `ranges` in message `.google.spanner.v1.KeySet` is changed docs: A comment for message `Mutation` is changed docs: A comment for field `columns` in message `.google.spanner.v1.Mutation` is changed docs: A comment for field `values` in message `.google.spanner.v1.Mutation` is changed docs: A comment for field `key_set` in message `.google.spanner.v1.Mutation` is changed docs: A comment for field `insert_or_update` in message `.google.spanner.v1.Mutation` is changed docs: A comment for field `replace` in message `.google.spanner.v1.Mutation` is changed docs: A comment for message `PlanNode` is changed docs: A comment for enum `Kind` is changed docs: A comment for field `variable` in message `.google.spanner.v1.PlanNode` is changed docs: A comment for field `index` in message `.google.spanner.v1.PlanNode` is changed docs: A comment for field `kind` in message `.google.spanner.v1.PlanNode` is changed docs: A comment for field `short_representation` in message `.google.spanner.v1.PlanNode` is changed docs: A comment for field `plan_nodes` in message `.google.spanner.v1.QueryPlan` is changed docs: A comment for method `CreateSession` in service `Spanner` is changed docs: A comment for method `GetSession` in service `Spanner` is changed docs: A comment for method `DeleteSession` in service `Spanner` is changed docs: A comment for method `ExecuteSql` in service `Spanner` is changed docs: A comment for method `ExecuteStreamingSql` in service `Spanner` is changed docs: A comment for method `Read` in service `Spanner` is changed docs: A comment for method `Commit` in service `Spanner` is changed docs: A comment for method `Rollback` in service `Spanner` is changed docs: A comment for method `PartitionQuery` in service `Spanner` is changed docs: A comment for method `PartitionRead` in service `Spanner` is changed docs: A comment for method `BatchWrite` in service `Spanner` is changed docs: A comment for field `session_template` in message `.google.spanner.v1.BatchCreateSessionsRequest` is changed docs: A comment for field `session_count` in message `.google.spanner.v1.BatchCreateSessionsRequest` is changed docs: A comment for field `approximate_last_use_time` in message `.google.spanner.v1.Session` is changed docs: A comment for field `multiplexed` in message `.google.spanner.v1.Session` is changed docs: A comment for enum `Priority` is changed docs: A comment for field `request_tag` in message `.google.spanner.v1.RequestOptions` is changed docs: A comment for field `transaction_tag` in message `.google.spanner.v1.RequestOptions` is changed docs: A comment for message `DirectedReadOptions` is changed docs: A comment for message `DirectedReadOptions` is changed docs: A comment for message `DirectedReadOptions` is changed docs: A comment for field `location` in message `.google.spanner.v1.DirectedReadOptions` is changed docs: A comment for field `auto_failover_disabled` in message `.google.spanner.v1.DirectedReadOptions` is changed docs: A comment for field `include_replicas` in message `.google.spanner.v1.DirectedReadOptions` is changed docs: A comment for field `exclude_replicas` in message `.google.spanner.v1.DirectedReadOptions` is changed docs: A comment for enum value `PROFILE` in enum `QueryMode` is changed docs: A comment for field `optimizer_version` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `optimizer_statistics_package` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `transaction` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `params` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `param_types` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `partition_token` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `seqno` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `data_boost_enabled` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `last_statement` in message `.google.spanner.v1.ExecuteSqlRequest` is changed docs: A comment for field `params` in message `.google.spanner.v1.ExecuteBatchDmlRequest` is changed docs: A comment for field `param_types` in message `.google.spanner.v1.ExecuteBatchDmlRequest` is changed docs: A comment for field `seqno` in message `.google.spanner.v1.ExecuteBatchDmlRequest` is changed docs: A comment for field `last_statements` in message `.google.spanner.v1.ExecuteBatchDmlRequest` is changed docs: A comment for field `precommit_token` in message `.google.spanner.v1.ExecuteBatchDmlResponse` is changed docs: A comment for message `PartitionOptions` is changed docs: A comment for field `partition_size_bytes` in message `.google.spanner.v1.PartitionOptions` is changed docs: A comment for field `max_partitions` in message `.google.spanner.v1.PartitionOptions` is changed docs: A comment for field `transaction` in message `.google.spanner.v1.PartitionQueryRequest` is changed docs: A comment for field `sql` in message `.google.spanner.v1.PartitionQueryRequest` is changed docs: A comment for field `params` in message `.google.spanner.v1.PartitionQueryRequest` is changed docs: A comment for field `param_types` in message `.google.spanner.v1.PartitionQueryRequest` is changed docs: A comment for field `key_set` in message `.google.spanner.v1.PartitionReadRequest` is changed docs: A comment for field `partition_token` in message `.google.spanner.v1.Partition` is changed docs: A comment for enum value `ORDER_BY_UNSPECIFIED` in enum `OrderBy` is changed docs: A comment for enum value `ORDER_BY_PRIMARY_KEY` in enum `OrderBy` is changed docs: A comment for enum value `LOCK_HINT_UNSPECIFIED` in enum `LockHint` is changed docs: A comment for enum value `LOCK_HINT_EXCLUSIVE` in enum `LockHint` is changed docs: A comment for field `key_set` in message `.google.spanner.v1.ReadRequest` is changed docs: A comment for field `limit` in message `.google.spanner.v1.ReadRequest` is changed docs: A comment for field `partition_token` in message `.google.spanner.v1.ReadRequest` is changed docs: A comment for field `data_boost_enabled` in message `.google.spanner.v1.ReadRequest` is changed docs: A comment for field `order_by` in message `.google.spanner.v1.ReadRequest` is changed docs: A comment for field `request_options` in message `.google.spanner.v1.BeginTransactionRequest` is changed docs: A comment for field `mutation_key` in message `.google.spanner.v1.BeginTransactionRequest` is changed docs: A comment for field `single_use_transaction` in message `.google.spanner.v1.CommitRequest` is changed docs: A comment for field `return_commit_stats` in message `.google.spanner.v1.CommitRequest` is changed docs: A comment for field `max_commit_delay` in message `.google.spanner.v1.CommitRequest` is changed docs: A comment for field `precommit_token` in message `.google.spanner.v1.CommitRequest` is changed docs: A comment for field `exclude_txn_from_change_streams` in message `.google.spanner.v1.BatchWriteRequest` is changed docs: A comment for enum value `SERIALIZABLE` in enum `IsolationLevel` is changed PiperOrigin-RevId: 800749899 Source-Link: googleapis/googleapis@39c8072 Source-Link: googleapis/googleapis-gen@42cfcdb Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDJjZmNkYmJhYjFjYmUxMmY0ZTA5Njg5NTkxZjlkZmYwNjlmMDg3ZSJ9 * 🦉 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 4466500 commit 97406be

File tree

7 files changed

+413
-409
lines changed

7 files changed

+413
-409
lines changed

protos/google/spanner/v1/keys.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@ message KeySet {
152152
// encoded as described [here][google.spanner.v1.TypeCode].
153153
repeated google.protobuf.ListValue keys = 1;
154154

155-
// A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
156-
// key range specifications.
155+
// A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more
156+
// information about key range specifications.
157157
repeated KeyRange ranges = 2;
158158

159159
// For convenience `all` can be set to `true` to indicate that this

protos/google/spanner/v1/mutation.proto

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,16 @@ option ruby_package = "Google::Cloud::Spanner::V1";
3232
// applied to a Cloud Spanner database by sending them in a
3333
// [Commit][google.spanner.v1.Spanner.Commit] call.
3434
message Mutation {
35-
// Arguments to [insert][google.spanner.v1.Mutation.insert], [update][google.spanner.v1.Mutation.update], [insert_or_update][google.spanner.v1.Mutation.insert_or_update], and
35+
// Arguments to [insert][google.spanner.v1.Mutation.insert],
36+
// [update][google.spanner.v1.Mutation.update],
37+
// [insert_or_update][google.spanner.v1.Mutation.insert_or_update], and
3638
// [replace][google.spanner.v1.Mutation.replace] operations.
3739
message Write {
3840
// Required. The table whose rows will be written.
3941
string table = 1 [(google.api.field_behavior) = REQUIRED];
4042

41-
// The names of the columns in [table][google.spanner.v1.Mutation.Write.table] to be written.
43+
// The names of the columns in
44+
// [table][google.spanner.v1.Mutation.Write.table] to be written.
4245
//
4346
// The list of columns must contain enough columns to allow
4447
// Cloud Spanner to derive values for all primary key columns in the
@@ -48,11 +51,13 @@ message Mutation {
4851
// The values to be written. `values` can contain more than one
4952
// list of values. If it does, then multiple rows are written, one
5053
// for each entry in `values`. Each list in `values` must have
51-
// exactly as many entries as there are entries in [columns][google.spanner.v1.Mutation.Write.columns]
52-
// above. Sending multiple lists is equivalent to sending multiple
53-
// `Mutation`s, each containing one `values` entry and repeating
54-
// [table][google.spanner.v1.Mutation.Write.table] and [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in each list are
55-
// encoded as described [here][google.spanner.v1.TypeCode].
54+
// exactly as many entries as there are entries in
55+
// [columns][google.spanner.v1.Mutation.Write.columns] above. Sending
56+
// multiple lists is equivalent to sending multiple `Mutation`s, each
57+
// containing one `values` entry and repeating
58+
// [table][google.spanner.v1.Mutation.Write.table] and
59+
// [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in
60+
// each list are encoded as described [here][google.spanner.v1.TypeCode].
5661
repeated google.protobuf.ListValue values = 3;
5762
}
5863

@@ -61,12 +66,12 @@ message Mutation {
6166
// Required. The table whose rows will be deleted.
6267
string table = 1 [(google.api.field_behavior) = REQUIRED];
6368

64-
// Required. The primary keys of the rows within [table][google.spanner.v1.Mutation.Delete.table] to delete. The
65-
// primary keys must be specified in the order in which they appear in the
66-
// `PRIMARY KEY()` clause of the table's equivalent DDL statement (the DDL
67-
// statement used to create the table).
68-
// Delete is idempotent. The transaction will succeed even if some or all
69-
// rows do not exist.
69+
// Required. The primary keys of the rows within
70+
// [table][google.spanner.v1.Mutation.Delete.table] to delete. The primary
71+
// keys must be specified in the order in which they appear in the `PRIMARY
72+
// KEY()` clause of the table's equivalent DDL statement (the DDL statement
73+
// used to create the table). Delete is idempotent. The transaction will
74+
// succeed even if some or all rows do not exist.
7075
KeySet key_set = 2 [(google.api.field_behavior) = REQUIRED];
7176
}
7277

@@ -80,19 +85,22 @@ message Mutation {
8085
// already exist, the transaction fails with error `NOT_FOUND`.
8186
Write update = 2;
8287

83-
// Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, then
84-
// its column values are overwritten with the ones provided. Any
85-
// column values not explicitly written are preserved.
88+
// Like [insert][google.spanner.v1.Mutation.insert], except that if the row
89+
// already exists, then its column values are overwritten with the ones
90+
// provided. Any column values not explicitly written are preserved.
8691
//
87-
// When using [insert_or_update][google.spanner.v1.Mutation.insert_or_update], just as when using [insert][google.spanner.v1.Mutation.insert], all `NOT
88-
// NULL` columns in the table must be given a value. This holds true
89-
// even when the row already exists and will therefore actually be updated.
92+
// When using
93+
// [insert_or_update][google.spanner.v1.Mutation.insert_or_update], just as
94+
// when using [insert][google.spanner.v1.Mutation.insert], all `NOT NULL`
95+
// columns in the table must be given a value. This holds true even when the
96+
// row already exists and will therefore actually be updated.
9097
Write insert_or_update = 3;
9198

92-
// Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, it is
93-
// deleted, and the column values provided are inserted
94-
// instead. Unlike [insert_or_update][google.spanner.v1.Mutation.insert_or_update], this means any values not
95-
// explicitly written become `NULL`.
99+
// Like [insert][google.spanner.v1.Mutation.insert], except that if the row
100+
// already exists, it is deleted, and the column values provided are
101+
// inserted instead. Unlike
102+
// [insert_or_update][google.spanner.v1.Mutation.insert_or_update], this
103+
// means any values not explicitly written become `NULL`.
96104
//
97105
// In an interleaved table, if you create the child table with the
98106
// `ON DELETE CASCADE` annotation, then replacing a parent row

protos/google/spanner/v1/query_plan.proto

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@ option java_package = "com.google.spanner.v1";
2626
option php_namespace = "Google\\Cloud\\Spanner\\V1";
2727
option ruby_package = "Google::Cloud::Spanner::V1";
2828

29-
// Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
29+
// Node information for nodes appearing in a
30+
// [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
3031
message PlanNode {
31-
// The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of
32-
// nodes that can appear in a query plan.
32+
// The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between
33+
// the two different kinds of nodes that can appear in a query plan.
3334
enum Kind {
3435
// Not specified.
3536
KIND_UNSPECIFIED = 0;
@@ -58,14 +59,14 @@ message PlanNode {
5859
// with the output variable.
5960
string type = 2;
6061

61-
// Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds
62-
// to an output variable of the parent node. The field carries the name of
63-
// the output variable.
64-
// For example, a `TableScan` operator that reads rows from a table will
65-
// have child links to the `SCALAR` nodes representing the output variables
66-
// created for each column that is read by the operator. The corresponding
67-
// `variable` fields will be set to the variable names assigned to the
68-
// columns.
62+
// Only present if the child node is
63+
// [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an
64+
// output variable of the parent node. The field carries the name of the
65+
// output variable. For example, a `TableScan` operator that reads rows from
66+
// a table will have child links to the `SCALAR` nodes representing the
67+
// output variables created for each column that is read by the operator.
68+
// The corresponding `variable` fields will be set to the variable names
69+
// assigned to the columns.
6970
string variable = 3;
7071
}
7172

@@ -83,14 +84,15 @@ message PlanNode {
8384
map<string, int32> subqueries = 2;
8485
}
8586

86-
// The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
87+
// The `PlanNode`'s index in [node
88+
// list][google.spanner.v1.QueryPlan.plan_nodes].
8789
int32 index = 1;
8890

8991
// Used to determine the type of node. May be needed for visualizing
9092
// different kinds of nodes differently. For example, If the node is a
91-
// [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation
92-
// which can be used to directly embed a description of the node in its
93-
// parent.
93+
// [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a
94+
// condensed representation which can be used to directly embed a description
95+
// of the node in its parent.
9496
Kind kind = 2;
9597

9698
// The display name for the node.
@@ -99,7 +101,8 @@ message PlanNode {
99101
// List of child node `index`es and their relationship to this parent.
100102
repeated ChildLink child_links = 4;
101103

102-
// Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
104+
// Condensed representation for
105+
// [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
103106
ShortRepresentation short_representation = 5;
104107

105108
// Attributes relevant to the node contained in a group of key-value pairs.
@@ -122,7 +125,7 @@ message PlanNode {
122125
// Contains an ordered list of nodes appearing in the query plan.
123126
message QueryPlan {
124127
// The nodes in the query plan. Plan nodes are returned in pre-order starting
125-
// with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id` corresponds to its index in
126-
// `plan_nodes`.
128+
// with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
129+
// corresponds to its index in `plan_nodes`.
127130
repeated PlanNode plan_nodes = 1;
128131
}

0 commit comments

Comments
 (0)