DataChangeRecord

import type { DataChangeRecord } from "https://googleapis.deno.dev/v1/spanner:v1.ts";

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.

interface DataChangeRecord {

columnMetadata?: ColumnMetadata[];

commitTimestamp?: Date;

isLastRecordInTransactionInPartition?: boolean;

isSystemTransaction?: boolean;

mods?: Mod[];

modType?:

| "MOD_TYPE_UNSPECIFIED"

| "INSERT"

| "UPDATE"

| "DELETE";

numberOfPartitionsInTransaction?: number;

numberOfRecordsInTransaction?: number;

recordSequence?: string;

serverTransactionId?: string;

table?: string;

transactionTag?: string;

valueCaptureType?:

| "VALUE_CAPTURE_TYPE_UNSPECIFIED"

| "OLD_AND_NEW_VALUES"

| "NEW_VALUES"

| "NEW_ROW"

| "NEW_ROW_AND_OLD_VALUES";

}

§Properties

columnMetadata?: ColumnMetadata[]

[src]

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

commitTimestamp?: Date

[src]

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.

isLastRecordInTransactionInPartition?: boolean

[src]

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.

isSystemTransaction?: boolean

[src]

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

mods?: Mod[]

[src]

Describes the changes that were made.

modType?: "MOD_TYPE_UNSPECIFIED" | "INSERT" | "UPDATE" | "DELETE"

[src]

Describes the type of change.

numberOfPartitionsInTransaction?: number

[src]

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.

numberOfRecordsInTransaction?: number

[src]

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.

recordSequence?: string

[src]

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.

serverTransactionId?: string

[src]

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?: string

[src]

Name of the table affected by the change.

transactionTag?: string

[src]

Indicates the transaction tag associated with this transaction.

valueCaptureType?: "VALUE_CAPTURE_TYPE_UNSPECIFIED" | "OLD_AND_NEW_VALUES" | "NEW_VALUES" | "NEW_ROW" | "NEW_ROW_AND_OLD_VALUES"

[src]

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