org.jsimpledb.kv.spanner

Class SpannerKVTransaction

java.lang.Object

org.jsimpledb.kv.util.ForwardingKVStore

org.jsimpledb.kv.spanner.SpannerKVTransaction

All Implemented Interfaces:

KVStore, KVTransaction

@ThreadSafe
public class SpannerKVTransaction
extends ForwardingKVStore
implements KVTransaction

SpannerKVDatabase transaction.

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseClient	client
protected TimestampBound	consistency
protected SpannerKVDatabase	kvdb
protected Logger	log
protected String	tableName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpannerKVTransaction(SpannerKVDatabase kvdb, DatabaseClient client, String tableName, TimestampBound consistency) Constructor.

Method Summary

Modifier and Type	Method and Description
void	commit()
protected KVStore	delegate()
byte[]	get(byte[] key)
KVPair	getAtLeast(byte[] minKey, byte[] maxKey)
KVPair	getAtMost(byte[] maxKey, byte[] minKey)
TimestampBound	getConsistency() Get the consistency level configured for this transaction.
SpannerKVDatabase	getKVDatabase()
CloseableIterator<KVPair>	getRange(byte[] minKey, byte[] maxKey, boolean reverse)
Timestamp	getTimestamp() Get the timestamp associated with this transaction.
boolean	isReadOnly()
boolean	isStrongConsistency() Convenience method to determine whether this transaction is using strong consistency.
CloseableKVStore	mutableSnapshot() Create a mutable snapshot of this transaction.
void	rollback()
void	setReadOnly(boolean readOnly)
void	setTimeout(long timeout) Set transaction timeout.
Future<Void>	watchKey(byte[] key) Set key watch.
protected RuntimeException	wrapException(SpannerException e)

Methods inherited from class org.jsimpledb.kv.util.ForwardingKVStore

adjustCounter, decodeCounter, encodeCounter, put, remove, removeRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jsimpledb.kv.KVStore

adjustCounter, decodeCounter, encodeCounter, getRange, getRange, put, remove, removeRange

Field Detail

log

protected final Logger log

kvdb

protected final SpannerKVDatabase kvdb

client

protected final DatabaseClient client

tableName

protected final String tableName

consistency

protected final TimestampBound consistency

Constructor Detail

SpannerKVTransaction

protected SpannerKVTransaction(SpannerKVDatabase kvdb,
                               DatabaseClient client,
                               String tableName,
                               TimestampBound consistency)

Constructor.

Parameters:

kvdb - associated database

client - client for access

tableName - Spanner key/value database table name

consistency - transaction consistency level

Throws:

IllegalArgumentException - if any paramter is null

Method Detail

getConsistency

public TimestampBound getConsistency()

Get the consistency level configured for this transaction.

Note that read-write transactions always use strong consistency.

Returns:

consistency of this transaction

isStrongConsistency

public boolean isStrongConsistency()

Convenience method to determine whether this transaction is using strong consistency.

Returns:

true if this transaction has strong consistency

getTimestamp

public Timestamp getTimestamp()

Get the timestamp associated with this transaction.

For read-only transactions, this returns the Spanner timestamp at which the data was accessed. It should not be invoked until at least one data query has occurred.

For read-write transactions, this returns the Spanner timestamp at which the changes were applied. It should not be invoked until the transaction is committed.

Returns:

this transaction's Spanner timestamp

Throws:

IllegalStateException - if timestamp is not available yet

getKVDatabase

public SpannerKVDatabase getKVDatabase()

Specified by:

getKVDatabase in interface KVTransaction

setTimeout

public void setTimeout(long timeout)

Set transaction timeout.

Currently not supported; this method does nothing.

Specified by:

setTimeout in interface KVTransaction

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface KVTransaction

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface KVTransaction

commit

public void commit()

Specified by:

commit in interface KVTransaction

rollback

public void rollback()

Specified by:

rollback in interface KVTransaction

watchKey

public Future<Void> watchKey(byte[] key)

Set key watch.

Key watches are not supported.

Specified by:

watchKey in interface KVTransaction

Throws:

UnsupportedOperationException - always

mutableSnapshot

public CloseableKVStore mutableSnapshot()

Create a mutable snapshot of this transaction.

This method is not supported.

With Spanner, a transaction is not needed to create mutable snapshots; instead, see SpannerKVDatabase.snapshot() and MutableView.

Specified by:

mutableSnapshot in interface KVTransaction

Throws:

UnsupportedOperationException - always

get

public byte[] get(byte[] key)

Specified by:

get in interface KVStore

Overrides:

get in class ForwardingKVStore

getAtLeast

public KVPair getAtLeast(byte[] minKey,
                         byte[] maxKey)

Specified by:

getAtLeast in interface KVStore

Overrides:

getAtLeast in class ForwardingKVStore

getAtMost

public KVPair getAtMost(byte[] maxKey,
                        byte[] minKey)

Specified by:

getAtMost in interface KVStore

Overrides:

getAtMost in class ForwardingKVStore

getRange

public CloseableIterator<KVPair> getRange(byte[] minKey,
                                          byte[] maxKey,
                                          boolean reverse)

Specified by:

getRange in interface KVStore

Overrides:

getRange in class ForwardingKVStore

delegate

protected KVStore delegate()

Specified by:

delegate in class ForwardingKVStore

wrapException

protected RuntimeException wrapException(SpannerException e)