Class 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.

Inheritance
object
DataChangeRecord
Implements
Inherited Members
Namespace: Google.Apis.Spanner.v1.Data
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class DataChangeRecord : IDirectResponseSchema

Properties

ColumnMetadata

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

Declaration
[JsonProperty("columnMetadata")]
public virtual IList<ColumnMetadata> ColumnMetadata { get; set; }
Property Value
Type Description
IList<ColumnMetadata>

CommitTimestamp

object representation of CommitTimestampRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CommitTimestampDateTimeOffset instead.")]
public virtual object CommitTimestamp { get; set; }
Property Value
Type Description
object

CommitTimestampDateTimeOffset

DateTimeOffset representation of CommitTimestampRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CommitTimestampDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CommitTimestampRaw

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.

Declaration
[JsonProperty("commitTimestamp")]
public virtual string CommitTimestampRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

IsLastRecordInTransactionInPartition

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.

Declaration
[JsonProperty("isLastRecordInTransactionInPartition")]
public virtual bool? IsLastRecordInTransactionInPartition { get; set; }
Property Value
Type Description
bool?

IsSystemTransaction

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

Declaration
[JsonProperty("isSystemTransaction")]
public virtual bool? IsSystemTransaction { get; set; }
Property Value
Type Description
bool?

ModType

Describes the type of change.

Declaration
[JsonProperty("modType")]
public virtual string ModType { get; set; }
Property Value
Type Description
string

Mods

Describes the changes that were made.

Declaration
[JsonProperty("mods")]
public virtual IList<Mod> Mods { get; set; }
Property Value
Type Description
IList<Mod>

NumberOfPartitionsInTransaction

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.

Declaration
[JsonProperty("numberOfPartitionsInTransaction")]
public virtual int? NumberOfPartitionsInTransaction { get; set; }
Property Value
Type Description
int?

NumberOfRecordsInTransaction

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.

Declaration
[JsonProperty("numberOfRecordsInTransaction")]
public virtual int? NumberOfRecordsInTransaction { get; set; }
Property Value
Type Description
int?

RecordSequence

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.

Declaration
[JsonProperty("recordSequence")]
public virtual string RecordSequence { get; set; }
Property Value
Type Description
string

ServerTransactionId

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.

Declaration
[JsonProperty("serverTransactionId")]
public virtual string ServerTransactionId { get; set; }
Property Value
Type Description
string

Table

Name of the table affected by the change.

Declaration
[JsonProperty("table")]
public virtual string Table { get; set; }
Property Value
Type Description
string

TransactionTag

Indicates the transaction tag associated with this transaction.

Declaration
[JsonProperty("transactionTag")]
public virtual string TransactionTag { get; set; }
Property Value
Type Description
string

ValueCaptureType

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

Declaration
[JsonProperty("valueCaptureType")]
public virtual string ValueCaptureType { get; set; }
Property Value
Type Description
string

Implements