Synchronize new proto/yaml changes.
PiperOrigin-RevId: 235082938
This commit is contained in:
parent
9cf63704bd
commit
acf32a44d9
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright 2018 Google LLC.
|
||||
// Copyright 2018 Google LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
|
|
@ -11,7 +11,6 @@
|
|||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
|
|
@ -21,7 +20,6 @@ import "google/api/annotations.proto";
|
|||
import "google/protobuf/empty.proto";
|
||||
import "google/protobuf/struct.proto";
|
||||
import "google/protobuf/timestamp.proto";
|
||||
import "google/rpc/status.proto";
|
||||
import "google/spanner/v1/keys.proto";
|
||||
import "google/spanner/v1/mutation.proto";
|
||||
import "google/spanner/v1/result_set.proto";
|
||||
|
|
@ -83,9 +81,7 @@ service Spanner {
|
|||
};
|
||||
}
|
||||
|
||||
// Ends a session, releasing server resources associated with it. This will
|
||||
// asynchronously trigger cancellation of any operations that are running with
|
||||
// this session.
|
||||
// Ends a session, releasing server resources associated with it.
|
||||
rpc DeleteSession(DeleteSessionRequest) returns (google.protobuf.Empty) {
|
||||
option (google.api.http) = {
|
||||
delete: "/v1/{name=projects/*/instances/*/databases/*/sessions/*}"
|
||||
|
|
@ -122,32 +118,6 @@ service Spanner {
|
|||
};
|
||||
}
|
||||
|
||||
// Executes a batch of SQL DML statements. This method allows many statements
|
||||
// to be run with lower latency than submitting them sequentially with
|
||||
// [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
|
||||
//
|
||||
// Statements are executed in order, sequentially.
|
||||
// [ExecuteBatchDmlResponse][Spanner.ExecuteBatchDmlResponse] will contain a
|
||||
// [ResultSet][google.spanner.v1.ResultSet] for each DML statement that has successfully executed. If a
|
||||
// statement fails, its error status will be returned as part of the
|
||||
// [ExecuteBatchDmlResponse][Spanner.ExecuteBatchDmlResponse]. Execution will
|
||||
// stop at the first failed statement; the remaining statements will not run.
|
||||
//
|
||||
// ExecuteBatchDml is expected to return an OK status with a response even if
|
||||
// there was an error while processing one of the DML statements. Clients must
|
||||
// inspect response.status to determine if there were any errors while
|
||||
// processing the request.
|
||||
//
|
||||
// See more details in
|
||||
// [ExecuteBatchDmlRequest][Spanner.ExecuteBatchDmlRequest] and
|
||||
// [ExecuteBatchDmlResponse][Spanner.ExecuteBatchDmlResponse].
|
||||
rpc ExecuteBatchDml(ExecuteBatchDmlRequest) returns (ExecuteBatchDmlResponse) {
|
||||
option (google.api.http) = {
|
||||
post: "/v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeBatchDml"
|
||||
body: "*"
|
||||
};
|
||||
}
|
||||
|
||||
// Reads rows from the database using key lookups and scans, as a
|
||||
// simple key/value style alternative to
|
||||
// [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to
|
||||
|
|
@ -440,97 +410,6 @@ message ExecuteSqlRequest {
|
|||
int64 seqno = 9;
|
||||
}
|
||||
|
||||
// The request for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]
|
||||
message ExecuteBatchDmlRequest {
|
||||
// A single DML statement.
|
||||
message Statement {
|
||||
// Required. The DML string.
|
||||
string sql = 1;
|
||||
|
||||
// The DML string can contain parameter placeholders. A parameter
|
||||
// placeholder consists of `'@'` followed by the parameter
|
||||
// name. Parameter names consist of any combination of letters,
|
||||
// numbers, and underscores.
|
||||
//
|
||||
// Parameters can appear anywhere that a literal value is expected. The
|
||||
// same parameter name can be used more than once, for example:
|
||||
// `"WHERE id > @msg_id AND id < @msg_id + 100"`
|
||||
//
|
||||
// It is an error to execute an SQL statement with unbound parameters.
|
||||
//
|
||||
// Parameter values are specified using `params`, which is a JSON
|
||||
// object whose keys are parameter names, and whose values are the
|
||||
// corresponding parameter values.
|
||||
google.protobuf.Struct params = 2;
|
||||
|
||||
// It is not always possible for Cloud Spanner to infer the right SQL type
|
||||
// from a JSON value. For example, values of type `BYTES` and values
|
||||
// of type `STRING` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings.
|
||||
//
|
||||
// In these cases, `param_types` can be used to specify the exact
|
||||
// SQL type for some or all of the SQL statement parameters. See the
|
||||
// definition of [Type][google.spanner.v1.Type] for more information
|
||||
// about SQL types.
|
||||
map<string, Type> param_types = 3;
|
||||
}
|
||||
|
||||
// Required. The session in which the DML statements should be performed.
|
||||
string session = 1;
|
||||
|
||||
// The transaction to use. A ReadWrite transaction is required. Single-use
|
||||
// transactions are not supported (to avoid replay). The caller must either
|
||||
// supply an existing transaction ID or begin a new transaction.
|
||||
TransactionSelector transaction = 2;
|
||||
|
||||
// The list of statements to execute in this batch. Statements are executed
|
||||
// serially, such that the effects of statement i are visible to statement
|
||||
// i+1. Each statement must be a DML statement. Execution will stop at the
|
||||
// first failed statement; the remaining statements will not run.
|
||||
//
|
||||
// REQUIRES: statements_size() > 0.
|
||||
repeated Statement statements = 3;
|
||||
|
||||
// A per-transaction sequence number used to identify this request. This is
|
||||
// used in the same space as the seqno in
|
||||
// [ExecuteSqlRequest][Spanner.ExecuteSqlRequest]. See more details
|
||||
// in [ExecuteSqlRequest][Spanner.ExecuteSqlRequest].
|
||||
int64 seqno = 4;
|
||||
}
|
||||
|
||||
// The response for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]. Contains a list
|
||||
// of [ResultSet][google.spanner.v1.ResultSet], one for each DML statement that has successfully executed.
|
||||
// If a statement fails, the error is returned as part of the response payload.
|
||||
// Clients can determine whether all DML statements have run successfully, or if
|
||||
// a statement failed, using one of the following approaches:
|
||||
//
|
||||
// 1. Check if 'status' field is OkStatus.
|
||||
// 2. Check if result_sets_size() equals the number of statements in
|
||||
// [ExecuteBatchDmlRequest][Spanner.ExecuteBatchDmlRequest].
|
||||
//
|
||||
// Example 1: A request with 5 DML statements, all executed successfully.
|
||||
// Result: A response with 5 ResultSets, one for each statement in the same
|
||||
// order, and an OK status.
|
||||
//
|
||||
// Example 2: A request with 5 DML statements. The 3rd statement has a syntax
|
||||
// error.
|
||||
// Result: A response with 2 ResultSets, for the first 2 statements that
|
||||
// run successfully, and a syntax error (INVALID_ARGUMENT) status. From
|
||||
// result_set_size() client can determine that the 3rd statement has failed.
|
||||
message ExecuteBatchDmlResponse {
|
||||
// ResultSets, one for each statement in the request that ran successfully, in
|
||||
// the same order as the statements in the request. Each [ResultSet][google.spanner.v1.ResultSet] will
|
||||
// not contain any rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each [ResultSet][google.spanner.v1.ResultSet] will
|
||||
// contain the number of rows modified by the statement.
|
||||
//
|
||||
// Only the first ResultSet in the response contains a valid
|
||||
// [ResultSetMetadata][google.spanner.v1.ResultSetMetadata].
|
||||
repeated ResultSet result_sets = 1;
|
||||
|
||||
// If all DML statements are executed successfully, status will be OK.
|
||||
// Otherwise, the error status of the first failed statement.
|
||||
google.rpc.Status status = 2;
|
||||
}
|
||||
|
||||
// Options for a PartitionQueryRequest and
|
||||
// PartitionReadRequest.
|
||||
message PartitionOptions {
|
||||
|
|
|
|||
|
|
@ -151,18 +151,6 @@ interfaces:
|
|||
field_name_patterns:
|
||||
session: session
|
||||
timeout_millis: 3600000
|
||||
- name: ExecuteBatchDml
|
||||
required_fields:
|
||||
- session
|
||||
- transaction
|
||||
- statements
|
||||
- seqno
|
||||
resource_name_treatment: STATIC_TYPES
|
||||
retry_codes_name: idempotent
|
||||
retry_params_name: default
|
||||
field_name_patterns:
|
||||
session: session
|
||||
timeout_millis: 30000
|
||||
- name: Read
|
||||
required_fields:
|
||||
- session
|
||||
|
|
@ -272,9 +260,6 @@ resource_name_generation:
|
|||
- message_name: ExecuteSqlRequest
|
||||
field_entity_map:
|
||||
session: session
|
||||
- message_name: ExecuteBatchDmlRequest
|
||||
field_entity_map:
|
||||
session: session
|
||||
- message_name: ReadRequest
|
||||
field_entity_map:
|
||||
session: session
|
||||
|
|
|
|||
Loading…
Reference in New Issue