org.apache.accumulo.core.data

Class Mutation

java.lang.Object

org.apache.accumulo.core.data.Mutation

All Implemented Interfaces:

org.apache.hadoop.io.Writable

public class Mutation
extends Object
implements org.apache.hadoop.io.Writable

Mutation represents an action that manipulates a row in a table. A mutation holds a list of column/value pairs that represent an atomic set of modifications to make to a row.

Convenience methods which takes columns and value as CharSequence (String implements CharSequence) are provided. CharSequence is converted to UTF-8 by constructing a new Text object.

When always passing in the same data as a CharSequence/String, its probably more efficient to call the Text put methods. This way the data is only encoded once and only one Text object is created.

All of the put methods append data to the mutation, they do not overwrite anything that was previously put. The mutation holds a list of all column/values that were put into it. The putDelete() methods do not remove something that was previously added to the mutation, rather they indicate that Accumulo should insert a delete marker for that row column.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mutation.SERIALIZED_FORMAT

Constructor Summary

Constructors

Constructor and Description
Mutation()
Mutation(byte[] row)
Mutation(byte[] row, int start, int length)
Mutation(CharSequence row)
Mutation(Mutation m)
Mutation(org.apache.hadoop.io.Text row)
Mutation(org.apache.accumulo.core.data.thrift.TMutation tmutation)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	droppingOldTimestamp(long ts)
boolean	equals(Mutation m)
boolean	equals(Object o)
long	estimatedMemoryUsed()
byte[]	getRow()
protected Mutation.SERIALIZED_FORMAT	getSerializedFormat()
List<ColumnUpdate>	getUpdates()
int	hashCode()
protected ColumnUpdate	newColumnUpdate(byte[] cf, byte[] cq, byte[] cv, boolean hasts, long ts, boolean deleted, byte[] val)
long	numBytes()
void	put(byte[] columnFamily, byte[] columnQualifier, byte[] value)
void	put(byte[] columnFamily, byte[] columnQualifier, ColumnVisibility columnVisibility, byte[] value)
void	put(byte[] columnFamily, byte[] columnQualifier, ColumnVisibility columnVisibility, long timestamp, byte[] value)
void	put(byte[] columnFamily, byte[] columnQualifier, long timestamp, byte[] value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, CharSequence value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, ColumnVisibility columnVisibility, CharSequence value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, ColumnVisibility columnVisibility, long timestamp, CharSequence value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, ColumnVisibility columnVisibility, long timestamp, Value value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, ColumnVisibility columnVisibility, Value value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, long timestamp, CharSequence value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, long timestamp, Value value)
void	put(CharSequence columnFamily, CharSequence columnQualifier, Value value)
void	put(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, ColumnVisibility columnVisibility, long timestamp, Value value)
void	put(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, ColumnVisibility columnVisibility, Value value)
void	put(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, long timestamp, Value value)
void	put(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, Value value)
void	putDelete(byte[] columnFamily, byte[] columnQualifier)
void	putDelete(byte[] columnFamily, byte[] columnQualifier, ColumnVisibility columnVisibility)
void	putDelete(byte[] columnFamily, byte[] columnQualifier, ColumnVisibility columnVisibility, long timestamp)
void	putDelete(byte[] columnFamily, byte[] columnQualifier, long timestamp)
void	putDelete(CharSequence columnFamily, CharSequence columnQualifier)
void	putDelete(CharSequence columnFamily, CharSequence columnQualifier, ColumnVisibility columnVisibility)
void	putDelete(CharSequence columnFamily, CharSequence columnQualifier, ColumnVisibility columnVisibility, long timestamp)
void	putDelete(CharSequence columnFamily, CharSequence columnQualifier, long timestamp)
void	putDelete(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier)
void	putDelete(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, ColumnVisibility columnVisibility)
void	putDelete(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, ColumnVisibility columnVisibility, long timestamp)
void	putDelete(org.apache.hadoop.io.Text columnFamily, org.apache.hadoop.io.Text columnQualifier, long timestamp)
void	readFields(DataInput in)
int	size()
org.apache.accumulo.core.data.thrift.TMutation	toThrift() Creates a TMutation object containing this Mutation's data.
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Mutation

public Mutation(byte[] row)

Since:

1.5.0

Mutation

public Mutation(byte[] row,
        int start,
        int length)

Since:

1.5.0

Mutation

public Mutation(org.apache.hadoop.io.Text row)

Mutation

public Mutation(CharSequence row)

Mutation

public Mutation()

Mutation

public Mutation(org.apache.accumulo.core.data.thrift.TMutation tmutation)

Mutation

public Mutation(Mutation m)

Method Detail

getRow

public byte[] getRow()

put

public void put(org.apache.hadoop.io.Text columnFamily,
       org.apache.hadoop.io.Text columnQualifier,
       Value value)

put

public void put(org.apache.hadoop.io.Text columnFamily,
       org.apache.hadoop.io.Text columnQualifier,
       ColumnVisibility columnVisibility,
       Value value)

put

public void put(org.apache.hadoop.io.Text columnFamily,
       org.apache.hadoop.io.Text columnQualifier,
       long timestamp,
       Value value)

put

public void put(org.apache.hadoop.io.Text columnFamily,
       org.apache.hadoop.io.Text columnQualifier,
       ColumnVisibility columnVisibility,
       long timestamp,
       Value value)

putDelete

public void putDelete(org.apache.hadoop.io.Text columnFamily,
             org.apache.hadoop.io.Text columnQualifier)

putDelete

public void putDelete(org.apache.hadoop.io.Text columnFamily,
             org.apache.hadoop.io.Text columnQualifier,
             ColumnVisibility columnVisibility)

putDelete

public void putDelete(org.apache.hadoop.io.Text columnFamily,
             org.apache.hadoop.io.Text columnQualifier,
             long timestamp)

putDelete

public void putDelete(org.apache.hadoop.io.Text columnFamily,
             org.apache.hadoop.io.Text columnQualifier,
             ColumnVisibility columnVisibility,
             long timestamp)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       Value value)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       ColumnVisibility columnVisibility,
       Value value)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       long timestamp,
       Value value)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       ColumnVisibility columnVisibility,
       long timestamp,
       Value value)

putDelete

public void putDelete(CharSequence columnFamily,
             CharSequence columnQualifier)

putDelete

public void putDelete(CharSequence columnFamily,
             CharSequence columnQualifier,
             ColumnVisibility columnVisibility)

putDelete

public void putDelete(CharSequence columnFamily,
             CharSequence columnQualifier,
             long timestamp)

putDelete

public void putDelete(CharSequence columnFamily,
             CharSequence columnQualifier,
             ColumnVisibility columnVisibility,
             long timestamp)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       CharSequence value)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       ColumnVisibility columnVisibility,
       CharSequence value)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       long timestamp,
       CharSequence value)

put

public void put(CharSequence columnFamily,
       CharSequence columnQualifier,
       ColumnVisibility columnVisibility,
       long timestamp,
       CharSequence value)

put

public void put(byte[] columnFamily,
       byte[] columnQualifier,
       byte[] value)

Since:

1.5.0

put

public void put(byte[] columnFamily,
       byte[] columnQualifier,
       ColumnVisibility columnVisibility,
       byte[] value)

Since:

1.5.0

put

public void put(byte[] columnFamily,
       byte[] columnQualifier,
       long timestamp,
       byte[] value)

Since:

1.5.0

put

public void put(byte[] columnFamily,
       byte[] columnQualifier,
       ColumnVisibility columnVisibility,
       long timestamp,
       byte[] value)

Since:

1.5.0

putDelete

public void putDelete(byte[] columnFamily,
             byte[] columnQualifier)

Since:

1.5.0

putDelete

public void putDelete(byte[] columnFamily,
             byte[] columnQualifier,
             ColumnVisibility columnVisibility)

Since:

1.5.0

putDelete

public void putDelete(byte[] columnFamily,
             byte[] columnQualifier,
             long timestamp)

Since:

1.5.0

putDelete

public void putDelete(byte[] columnFamily,
             byte[] columnQualifier,
             ColumnVisibility columnVisibility,
             long timestamp)

Since:

1.5.0

getUpdates

public List<ColumnUpdate> getUpdates()

newColumnUpdate

protected ColumnUpdate newColumnUpdate(byte[] cf,
                           byte[] cq,
                           byte[] cv,
                           boolean hasts,
                           long ts,
                           boolean deleted,
                           byte[] val)

numBytes

public long numBytes()

estimatedMemoryUsed

public long estimatedMemoryUsed()

size

public int size()

Returns:

the number of column value pairs added to the mutation

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

droppingOldTimestamp

protected void droppingOldTimestamp(long ts)

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Mutation m)

toThrift

public org.apache.accumulo.core.data.thrift.TMutation toThrift()

Creates a TMutation object containing this Mutation's data. Note that this method will move the Mutation into a "serialized" state that will prevent users from adding more data via Mutation#put().

Returns:

a thrift form of this Mutation

getSerializedFormat

protected Mutation.SERIALIZED_FORMAT getSerializedFormat()