com.netflix.astyanax.recipes.uniqueness

Class MultiRowUniquenessConstraint

java.lang.Object

com.netflix.astyanax.recipes.uniqueness.MultiRowUniquenessConstraint

All Implemented Interfaces:

UniquenessConstraint

public class MultiRowUniquenessConstraint
extends java.lang.Object
implements UniquenessConstraint

Check uniqueness for multiple rows. This test is done by 1. First writing a unique column to all rows, in a single batch. Include a TTL for some failure conditions. 2. Reading back the unique columns from each row (must be done in a separate call) and making sure there is only one such column 3. Committing the columns without a TTL

Constructor Summary

Constructors

Constructor and Description
MultiRowUniquenessConstraint(com.netflix.astyanax.Keyspace keyspace)

Method Summary

Methods

Modifier and Type	Method and Description
void	acquire() Acquire the row(s) for uniqueness.
void	acquireAndApplyMutation(com.google.common.base.Function<com.netflix.astyanax.MutationBatch,java.lang.Boolean> callback) Acquire the uniqueness constraint and call the mutate callback to fill a mutation.
void	acquireAndMutate(com.netflix.astyanax.MutationBatch mutation) Deprecated.
java.lang.String	getLockColumn()
void	release() Release the uniqueness lock for this row.
MultiRowUniquenessConstraint	withColumnPrefix(java.lang.String prefix) Specify the prefix that uniquely distinguishes the lock columns from data columns
MultiRowUniquenessConstraint	withConsistencyLevel(com.netflix.astyanax.model.ConsistencyLevel consistencyLevel) Consistency level used
MultiRowUniquenessConstraint	withLockId(java.lang.String column) Override the autogenerated lock column.
MultiRowUniquenessConstraint	withRow(com.netflix.astyanax.model.ColumnFamily<java.lang.String,java.lang.String> columnFamily, java.lang.String rowKey) Add a row to the set of rows being tested for uniqueness
MultiRowUniquenessConstraint	withTtl(java.lang.Integer ttl) TTL to use for the uniquness operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiRowUniquenessConstraint

public MultiRowUniquenessConstraint(com.netflix.astyanax.Keyspace keyspace)

Method Detail

withTtl

public MultiRowUniquenessConstraint withTtl(java.lang.Integer ttl)

TTL to use for the uniquness operation. This is the TTL for the columns to expire in the event of a client crash before the uniqueness can be committed

Parameters:

ttl -

withColumnPrefix

public MultiRowUniquenessConstraint withColumnPrefix(java.lang.String prefix)

Specify the prefix that uniquely distinguishes the lock columns from data columns

Parameters:

prefix -

withLockId

public MultiRowUniquenessConstraint withLockId(java.lang.String column)

Override the autogenerated lock column.

Parameters:

column -

withConsistencyLevel

public MultiRowUniquenessConstraint withConsistencyLevel(com.netflix.astyanax.model.ConsistencyLevel consistencyLevel)

Consistency level used

Parameters:

consistencyLevel -

withRow

public MultiRowUniquenessConstraint withRow(com.netflix.astyanax.model.ColumnFamily<java.lang.String,java.lang.String> columnFamily,
                                   java.lang.String rowKey)

Add a row to the set of rows being tested for uniqueness

Parameters:

columnFamily -

rowKey -

getLockColumn

public java.lang.String getLockColumn()

Returns:

Return the lock column written to ALL rows

acquire

public void acquire()
             throws NotUniqueException,
                    java.lang.Exception

Description copied from interface: UniquenessConstraint

Acquire the row(s) for uniqueness. Call release() when the uniqueness on the row(s) is no longer needed, such as when deleting the rows.

Specified by:

acquire in interface UniquenessConstraint

Throws:

NotUniqueException

java.lang.Exception

acquireAndApplyMutation

public void acquireAndApplyMutation(com.google.common.base.Function<com.netflix.astyanax.MutationBatch,java.lang.Boolean> callback)
                             throws NotUniqueException,
                                    java.lang.Exception

Description copied from interface: UniquenessConstraint

Acquire the uniqueness constraint and call the mutate callback to fill a mutation.

Specified by:

acquireAndApplyMutation in interface UniquenessConstraint

Throws:

NotUniqueException

java.lang.Exception

acquireAndMutate

@Deprecated
public void acquireAndMutate(com.netflix.astyanax.MutationBatch mutation)
                      throws NotUniqueException,
                             java.lang.Exception

Deprecated.

Description copied from interface: UniquenessConstraint

Acquire the uniqueness constraint and apply the final mutation if the row is found to be unique

Specified by:

acquireAndMutate in interface UniquenessConstraint

Throws:

NotUniqueException

java.lang.Exception

release

public void release()
             throws java.lang.Exception

Description copied from interface: UniquenessConstraint

Release the uniqueness lock for this row. Only call this when you no longer need the uniqueness lock

Specified by:

release in interface UniquenessConstraint

Throws:

java.lang.Exception