Struct DataChangeRecord 

#[non_exhaustive]
pub struct DataChangeRecord {

    pub commit_timestamp: Option<Timestamp>,
    pub record_sequence: String,
    pub server_transaction_id: String,
    pub is_last_record_in_transaction_in_partition: bool,
    pub table: String,
    pub column_metadata: Vec<ColumnMetadata>,
    pub mods: Vec<Mod>,
    pub mod_type: ModType,
    pub value_capture_type: ValueCaptureType,
    pub number_of_records_in_transaction: i32,
    pub number_of_partitions_in_transaction: i32,
    pub transaction_tag: String,
    pub is_system_transaction: bool,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

commit_timestamp: Option<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.

record_sequence: 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: 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.

is_last_record_in_transaction_in_partition: bool

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.

table: String

Name of the table affected by the change.

column_metadata: Vec<ColumnMetadata>

Provides metadata describing the columns associated with the mods listed below.

mods: Vec<Mod>

Describes the changes that were made.

mod_type: ModType

Describes the type of change.

value_capture_type: ValueCaptureType

Describes the value capture type that was specified in the change stream configuration when this change was captured.

number_of_records_in_transaction: i32

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_partitions_in_transaction: i32

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.

transaction_tag: String

Indicates the transaction tag associated with this transaction.

is_system_transaction: bool

Indicates whether the transaction is a system transaction. System transactions include those issued by time-to-live (TTL), column backfill, etc.

Implementations

impl DataChangeRecord

pub fn new() -> Self

Creates a new default instance.

pub fn set_commit_timestamp<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of commit_timestamp.

pub fn set_or_clear_commit_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of commit_timestamp.

pub fn set_record_sequence<T: Into<String>>(self, v: T) -> Self

Sets the value of record_sequence.

pub fn set_server_transaction_id<T: Into<String>>(self, v: T) -> Self

Sets the value of server_transaction_id.

pub fn set_is_last_record_in_transaction_in_partition<T: Into<bool>>( self, v: T, ) -> Self

Sets the value of is_last_record_in_transaction_in_partition.

pub fn set_table<T: Into<String>>(self, v: T) -> Self

Sets the value of table.

pub fn set_column_metadata<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ColumnMetadata>,

Sets the value of column_metadata.

pub fn set_mods<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Mod>,

Sets the value of mods.

pub fn set_mod_type<T: Into<ModType>>(self, v: T) -> Self

Sets the value of mod_type.

pub fn set_value_capture_type<T: Into<ValueCaptureType>>(self, v: T) -> Self

Sets the value of value_capture_type.

pub fn set_number_of_records_in_transaction<T: Into<i32>>(self, v: T) -> Self

Sets the value of number_of_records_in_transaction.

pub fn set_number_of_partitions_in_transaction<T: Into<i32>>(self, v: T) -> Self

Sets the value of number_of_partitions_in_transaction.

pub fn set_transaction_tag<T: Into<String>>(self, v: T) -> Self

Sets the value of transaction_tag.

pub fn set_is_system_transaction<T: Into<bool>>(self, v: T) -> Self

Sets the value of is_system_transaction.

Trait Implementations

impl Clone for DataChangeRecord

fn clone(&self) -> DataChangeRecord

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataChangeRecord

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DataChangeRecord

fn default() -> DataChangeRecord

Returns the “default value” for a type.

impl Message for DataChangeRecord

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DataChangeRecord

fn eq(&self, other: &DataChangeRecord) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DataChangeRecord