Cloud Spanner V1 Client - Class PartitionStartRecord (1.104.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class PartitionStartRecord.

A partition start record serves as a notification that the client should schedule the partitions to be queried. PartitionStartRecord returns information about one or more partitions.

Generated from protobuf message google.spanner.v1.ChangeStreamRecord.PartitionStartRecord

Namespace

Google \ Cloud \ Spanner \ V1 \ ChangeStreamRecord

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ start_timestamp Google\Protobuf\Timestamp

Start timestamp at which the partitions should be queried to return change stream records with timestamps >= start_timestamp. 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.
↳ partition_tokens array

Unique partition identifiers to be used in queries.

getStartTimestamp

Start timestamp at which the partitions should be queried to return change stream records with timestamps >= start_timestamp.

DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTimestamp

clearStartTimestamp

setStartTimestamp

Start timestamp at which the partitions should be queried to return change stream records with timestamps >= start_timestamp.

DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps, PartitionEventRecord.commit_timestamps, and PartitionEndRecord.end_timestamps can have the same value in the same partition.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRecordSequence

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.

Returns
Type Description
string

setRecordSequence

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getPartitionTokens

Unique partition identifiers to be used in queries.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPartitionTokens

Unique partition identifiers to be used in queries.

Parameter
Name Description
var string[]
Returns
Type Description
$this