commit_response.proto

// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// 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";

package google.spanner.v1;

import "google/api/annotations.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";

option csharp_namespace = "Google.Cloud.Spanner.V1";
option go_package = "google.golang.org/genproto/googleapis/spanner/v1;spanner";
option java_multiple_files = true;
option java_outer_classname = "CommitResponseProto";
option java_package = "com.google.spanner.v1";
option php_namespace = "Google\\Cloud\\Spanner\\V1";
option ruby_package = "Google::Cloud::Spanner::V1";

// The response for [Commit][google.spanner.v1.Spanner.Commit].
message CommitResponse {
  // Additional statistics about a commit.
  message CommitStats {
    // The total number of mutations for the transaction. Knowing the
    // `mutation_count` value can help you maximize the number of mutations
    // in a transaction and minimize the number of API round trips. You can
    // also monitor this value to prevent transactions from exceeding the system
    // [limit](https://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
    // If the number of mutations exceeds the limit, the server returns
    // [INVALID_ARGUMENT](https://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
    int64 mutation_count = 1;
  }

  // The Cloud Spanner timestamp at which the transaction committed.
  google.protobuf.Timestamp commit_timestamp = 1;

  // The statistics about this Commit. Not returned by default.
  // For more information, see
  // [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
  CommitStats commit_stats = 2;
}