Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord (v1.9.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord.

A data change record contains a set of changes to a table with the same modification type (insert, update, or delete) committed at the same commit timestamp in one change stream partition for the same transaction. Multiple data change records can be returned for the same transaction across multiple change stream partitions.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#column_metadata

def column_metadata() -> ::Array<::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::ColumnMetadata>
Returns

#column_metadata=

def column_metadata=(value) -> ::Array<::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::ColumnMetadata>
Parameter
Returns

#commit_timestamp

def commit_timestamp() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Indicates the timestamp in which the change was committed. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

#commit_timestamp=

def commit_timestamp=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Indicates the timestamp in which the change was committed. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.
Returns
  • (::Google::Protobuf::Timestamp) — Indicates the timestamp in which the change was committed. DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

#is_last_record_in_transaction_in_partition

def is_last_record_in_transaction_in_partition() -> ::Boolean
Returns
  • (::Boolean) — Indicates whether this is the last record for a transaction in the current partition. Clients can use this field to determine when all records for a transaction in the current partition have been received.

#is_last_record_in_transaction_in_partition=

def is_last_record_in_transaction_in_partition=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether this is the last record for a transaction in the current partition. Clients can use this field to determine when all records for a transaction in the current partition have been received.
Returns
  • (::Boolean) — Indicates whether this is the last record for a transaction in the current partition. Clients can use this field to determine when all records for a transaction in the current partition have been received.

#is_system_transaction

def is_system_transaction() -> ::Boolean
Returns
  • (::Boolean) — Indicates whether the transaction is a system transaction. System transactions include those issued by time-to-live (TTL), column backfill, etc.

#is_system_transaction=

def is_system_transaction=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether the transaction is a system transaction. System transactions include those issued by time-to-live (TTL), column backfill, etc.
Returns
  • (::Boolean) — Indicates whether the transaction is a system transaction. System transactions include those issued by time-to-live (TTL), column backfill, etc.

#mod_type

def mod_type() -> ::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::ModType
Returns

#mod_type=

def mod_type=(value) -> ::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::ModType
Parameter
Returns

#mods

def mods() -> ::Array<::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::Mod>
Returns

#mods=

def mods=(value) -> ::Array<::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::Mod>
Parameter
Returns

#number_of_partitions_in_transaction

def number_of_partitions_in_transaction() -> ::Integer
Returns
  • (::Integer) — Indicates the number of partitions that return data change records for this transaction. This value can be helpful in assembling all records associated with a particular transaction.

#number_of_partitions_in_transaction=

def number_of_partitions_in_transaction=(value) -> ::Integer
Parameter
  • value (::Integer) — Indicates the number of partitions that return data change records for this transaction. This value can be helpful in assembling all records associated with a particular transaction.
Returns
  • (::Integer) — Indicates the number of partitions that return data change records for this transaction. This value can be helpful in assembling all records associated with a particular transaction.

#number_of_records_in_transaction

def number_of_records_in_transaction() -> ::Integer
Returns
  • (::Integer) — Indicates the number of data change records that are part of this transaction across all change stream partitions. This value can be used to assemble all the records associated with a particular transaction.

#number_of_records_in_transaction=

def number_of_records_in_transaction=(value) -> ::Integer
Parameter
  • value (::Integer) — Indicates the number of data change records that are part of this transaction across all change stream partitions. This value can be used to assemble all the records associated with a particular transaction.
Returns
  • (::Integer) — Indicates the number of data change records that are part of this transaction across all change stream partitions. This value can be used to assemble all the records associated with a particular transaction.

#record_sequence

def record_sequence() -> ::String
Returns
  • (::String) — Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition. To guarantee ordered processing, the reader should process records (of potentially different types) in record_sequence order for a specific timestamp in the same partition.

    The record sequence number ordering across partitions is only meaningful in the context of a specific transaction. Record sequence numbers are unique across partitions for a specific transaction. Sort the DataChangeRecords for the same server_transaction_id by record_sequence to reconstruct the ordering of the changes within the transaction.

#record_sequence=

def record_sequence=(value) -> ::String
Parameter
  • value (::String) — Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition. To guarantee ordered processing, the reader should process records (of potentially different types) in record_sequence order for a specific timestamp in the same partition.

    The record sequence number ordering across partitions is only meaningful in the context of a specific transaction. Record sequence numbers are unique across partitions for a specific transaction. Sort the DataChangeRecords for the same server_transaction_id by record_sequence to reconstruct the ordering of the changes within the transaction.

Returns
  • (::String) — Record sequence numbers are unique and monotonically increasing (but not necessarily contiguous) for a specific timestamp across record types in the same partition. To guarantee ordered processing, the reader should process records (of potentially different types) in record_sequence order for a specific timestamp in the same partition.

    The record sequence number ordering across partitions is only meaningful in the context of a specific transaction. Record sequence numbers are unique across partitions for a specific transaction. Sort the DataChangeRecords for the same server_transaction_id by record_sequence to reconstruct the ordering of the changes within the transaction.

#server_transaction_id

def server_transaction_id() -> ::String
Returns
  • (::String) — Provides a globally unique string that represents the transaction in which the change was committed. Multiple transactions can have the same commit timestamp, but each transaction has a unique server_transaction_id.

#server_transaction_id=

def server_transaction_id=(value) -> ::String
Parameter
  • value (::String) — Provides a globally unique string that represents the transaction in which the change was committed. Multiple transactions can have the same commit timestamp, but each transaction has a unique server_transaction_id.
Returns
  • (::String) — Provides a globally unique string that represents the transaction in which the change was committed. Multiple transactions can have the same commit timestamp, but each transaction has a unique server_transaction_id.

#table

def table() -> ::String
Returns
  • (::String) — Name of the table affected by the change.

#table=

def table=(value) -> ::String
Parameter
  • value (::String) — Name of the table affected by the change.
Returns
  • (::String) — Name of the table affected by the change.

#transaction_tag

def transaction_tag() -> ::String
Returns
  • (::String) — Indicates the transaction tag associated with this transaction.

#transaction_tag=

def transaction_tag=(value) -> ::String
Parameter
  • value (::String) — Indicates the transaction tag associated with this transaction.
Returns
  • (::String) — Indicates the transaction tag associated with this transaction.

#value_capture_type

def value_capture_type() -> ::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::ValueCaptureType
Returns

#value_capture_type=

def value_capture_type=(value) -> ::Google::Cloud::Spanner::V1::ChangeStreamRecord::DataChangeRecord::ValueCaptureType
Parameter
Returns