org.apache.beam.sdk.io.gcp.spanner.changestreams.dao

Class PartitionMetadataDao.InTransactionContext

java.lang.Object

org.apache.beam.sdk.io.gcp.spanner.changestreams.dao.PartitionMetadataDao.InTransactionContext

Enclosing class:

PartitionMetadataDao

public static class PartitionMetadataDao.InTransactionContext
extends java.lang.Object

Represents the execution of a read / write transaction in Cloud Spanner.

Constructor Summary

Constructors

Constructor and Description
InTransactionContext(java.lang.String metadataTableName, TransactionContext transaction) Constructs a context to execute a user defined function transactionally.

Method Summary

Modifier and Type	Method and Description
Struct	getPartition(java.lang.String partitionToken) Fetches the partition metadata row data for the given partition token.
java.lang.Void	insert(PartitionMetadata row) Inserts the partition metadata.
java.lang.Void	updateToFinished(java.lang.String partitionToken) Updates a partition row to PartitionMetadata.State.FINISHED state.
java.lang.Void	updateToRunning(java.lang.String partitionToken) Updates a partition row to PartitionMetadata.State.RUNNING state.
java.lang.Void	updateToScheduled(java.util.List<java.lang.String> partitionTokens) Updates multiple partition rows to PartitionMetadata.State.SCHEDULED state.
java.lang.Void	updateWatermark(java.lang.String partitionToken, com.google.cloud.Timestamp watermark) Update the partition watermark to the given timestamp.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InTransactionContext

public InTransactionContext(java.lang.String metadataTableName,
                            TransactionContext transaction)

Constructs a context to execute a user defined function transactionally.

Parameters:

metadataTableName - the name of the partition metadata table

transaction - the underlying client library transaction to be executed

Method Detail

insert

public java.lang.Void insert(PartitionMetadata row)

Inserts the partition metadata.

Parameters:

row - the partition metadata to be inserted

updateToScheduled

public java.lang.Void updateToScheduled(java.util.List<java.lang.String> partitionTokens)

Updates multiple partition rows to PartitionMetadata.State.SCHEDULED state.

Parameters:

partitionTokens - the partitions' unique identifiers

updateToRunning

public java.lang.Void updateToRunning(java.lang.String partitionToken)

Updates a partition row to PartitionMetadata.State.RUNNING state.

Parameters:

partitionToken - the partition unique identifier

updateToFinished

public java.lang.Void updateToFinished(java.lang.String partitionToken)

Updates a partition row to PartitionMetadata.State.FINISHED state.

Parameters:

partitionToken - the partition unique identifier

updateWatermark

public java.lang.Void updateWatermark(java.lang.String partitionToken,
                                      com.google.cloud.Timestamp watermark)

Update the partition watermark to the given timestamp.

Parameters:

partitionToken - the partition unique identifier

watermark - the new partition watermark

Returns:

the commit timestamp of the read / write transaction

getPartition

@Nullable
public Struct getPartition(java.lang.String partitionToken)

Fetches the partition metadata row data for the given partition token.

Parameters:

partitionToken - the partition unique identifier

Returns:

the partition metadata for the given token if it exists as a struct. Otherwise, it returns null.