Class: Google::Cloud::Spanner::V1::BatchWriteRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/v1/spanner.rb

Overview

The request for BatchWrite.

Defined Under Namespace

Classes: MutationGroup

Instance Attribute Summary collapse

Instance Attribute Details

#exclude_txn_from_change_streams ⇒ ::Boolean

Returns Optional. When exclude_txn_from_change_streams is set to true:

  • Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.
  • Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

When exclude_txn_from_change_streams is set to false or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.

Returns:

  • (::Boolean) —

    Optional. When exclude_txn_from_change_streams is set to true:

    • Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.
    • Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

    When exclude_txn_from_change_streams is set to false or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1090

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A group of mutations to be committed together. Related mutations should be
  # placed in a group. For example, two mutations inserting rows with the same
  # primary key prefix in both parent and child tables are related.
  # @!attribute [rw] mutations
  #   @return [::Array<::Google::Cloud::Spanner::V1::Mutation>]
  #     Required. The mutations in this group.
  class MutationGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#mutation_groups ⇒ ::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup>

Returns Required. The groups of mutations to be applied.

Returns:



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1090

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A group of mutations to be committed together. Related mutations should be
  # placed in a group. For example, two mutations inserting rows with the same
  # primary key prefix in both parent and child tables are related.
  # @!attribute [rw] mutations
  #   @return [::Array<::Google::Cloud::Spanner::V1::Mutation>]
  #     Required. The mutations in this group.
  class MutationGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#request_options ⇒ ::Google::Cloud::Spanner::V1::RequestOptions

Returns Common options for this request.

Returns:



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1090

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A group of mutations to be committed together. Related mutations should be
  # placed in a group. For example, two mutations inserting rows with the same
  # primary key prefix in both parent and child tables are related.
  # @!attribute [rw] mutations
  #   @return [::Array<::Google::Cloud::Spanner::V1::Mutation>]
  #     Required. The mutations in this group.
  class MutationGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#session ⇒ ::String

Returns Required. The session in which the batch request is to be run.

Returns:

  • (::String) —

    Required. The session in which the batch request is to be run.



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1090

class BatchWriteRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A group of mutations to be committed together. Related mutations should be
  # placed in a group. For example, two mutations inserting rows with the same
  # primary key prefix in both parent and child tables are related.
  # @!attribute [rw] mutations
  #   @return [::Array<::Google::Cloud::Spanner::V1::Mutation>]
  #     Required. The mutations in this group.
  class MutationGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end