google::cloud::spanner::v1::CommitOptions Class Reference

Set options on calls to spanner::Client::Commit(). More...

#include <google/cloud/spanner/commit_options.h>

Public Member Functions
	CommitOptions ()=default
	Default options: no stats. More...
CommitOptions &	set_return_stats (bool return_stats)
	Set whether the CommitResult should contain CommitStats. More...
bool	return_stats () const
	Whether the CommitResult should contain CommitStats. More...
CommitOptions &	set_request_priority (absl::optional< RequestPriority > request_priority)
	Set the priority of the spanner::Client::Commit() call. More...
absl::optional< RequestPriority >	request_priority () const
	The priority of the spanner::Client::Commit() call. More...
CommitOptions &	set_transaction_tag (absl::optional< std::string > transaction_tag)
	Set the transaction tag for the spanner::Client::Commit() call. More...
absl::optional< std::string > const &	transaction_tag () const
	The transaction tag for the spanner::Client::Commit() call. More...

Detailed Description

Set options on calls to spanner::Client::Commit().

Example

  auto commit = client.Commit(
      spanner::Mutations{
          spanner::UpdateMutationBuilder(
              "Albums", {"SingerId", "AlbumId", "MarketingBudget"})
              .EmplaceRow(1, 1, 200000)
              .EmplaceRow(2, 2, 400000)
              .Build()},
      spanner::CommitOptions{}.set_return_stats(true));

Definition at line 34 of file commit_options.h.

Constructor & Destructor Documentation

CommitOptions()

google::cloud::spanner::v1::CommitOptions::CommitOptions ( )

default

Default options: no stats.

Member Function Documentation

request_priority()

absl::optional<RequestPriority> google::cloud::spanner::v1::CommitOptions::request_priority ( ) const

inline

The priority of the spanner::Client::Commit() call.

Definition at line 56 of file commit_options.h.

return_stats()

bool google::cloud::spanner::v1::CommitOptions::return_stats ( ) const

inline

Whether the CommitResult should contain CommitStats.

Definition at line 46 of file commit_options.h.

set_request_priority()

CommitOptions& google::cloud::spanner::v1::CommitOptions::set_request_priority ( absl::optional< RequestPriority >  request_priority )

inline

Set the priority of the spanner::Client::Commit() call.

Definition at line 49 of file commit_options.h.

set_return_stats()

CommitOptions& google::cloud::spanner::v1::CommitOptions::set_return_stats ( bool  return_stats )

inline

Set whether the CommitResult should contain CommitStats.

Definition at line 40 of file commit_options.h.

set_transaction_tag()

CommitOptions& google::cloud::spanner::v1::CommitOptions::set_transaction_tag ( absl::optional< std::string >  transaction_tag )

inline

Set the transaction tag for the spanner::Client::Commit() call.

Ignored for the overload that already takes a spanner::Transaction.

Definition at line 64 of file commit_options.h.

transaction_tag()

absl::optional<std::string> const& google::cloud::spanner::v1::CommitOptions::transaction_tag ( ) const

inline

The transaction tag for the spanner::Client::Commit() call.

Definition at line 71 of file commit_options.h.