org.apache.hadoop.hbase.client

Class Mutation

java.lang.Object

org.apache.hadoop.hbase.client.Operation

org.apache.hadoop.hbase.client.OperationWithAttributes

org.apache.hadoop.hbase.client.Mutation

All Implemented Interfaces:

Comparable<Row>, CellScannable, Attributes, Row, HeapSize

Direct Known Subclasses:

Append, Delete, Increment, Put

@InterfaceAudience.Public
public abstract class Mutation
extends OperationWithAttributes
implements Row, CellScannable, HeapSize

Field Summary

Fields

Modifier and Type	Field and Description
protected Durability	durability
protected NavigableMap<byte[],List<Cell>>	familyMap
static long	MUTATION_OVERHEAD
protected byte[]	row
protected long	ts

Fields inherited from class org.apache.hadoop.hbase.client.OperationWithAttributes

ID_ATRIBUTE

Fields inherited from interface org.apache.hadoop.hbase.client.Row

COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Mutation() empty construction.
protected	Mutation(byte[] row, long ts, NavigableMap<byte[],List<Cell>> familyMap) Construct the mutation with user defined data.
protected	Mutation(Mutation clone)

Method Summary

Modifier and Type	Method and Description
CellScanner	cellScanner()
int	compareTo(Row d) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Row.COMPARATOR instead
protected long	extraHeapSize() Subclasses should override this method to add the heap size of their own fields.
List<Cell>	get(byte[] family, byte[] qualifier) Returns a list of all KeyValue objects with matching column family and qualifier.
byte[]	getACL() Returns The serialized ACL for this operation, or null if none
CellVisibility	getCellVisibility() Returns CellVisibility associated with cells in this Mutation.
List<UUID>	getClusterIds() Returns the set of clusterIds that have consumed the mutation
Durability	getDurability() Get the current durability
NavigableMap<byte[],List<Cell>>	getFamilyCellMap() Method for retrieving the put's familyMap
Map<String,Object>	getFingerprint() Compile the column family (i.e.
byte[]	getRow() Method for retrieving the delete's row
long	getTimestamp() Method for retrieving the timestamp.
long	getTimeStamp() Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use getTimestamp() instead
long	getTTL() Return the TTL requested for the result of the mutation, in milliseconds.
boolean	has(byte[] family, byte[] qualifier) A convenience method to determine if this object's familyMap contains a value assigned to the given family & qualifier.
boolean	has(byte[] family, byte[] qualifier, byte[] value) A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp.
boolean	has(byte[] family, byte[] qualifier, long ts) A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp.
boolean	has(byte[] family, byte[] qualifier, long ts, byte[] value) A convenience method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp.
protected boolean	has(byte[] family, byte[] qualifier, long ts, byte[] value, boolean ignoreTS, boolean ignoreValue) Private method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp, respecting the 2 boolean arguments.
long	heapSize() Returns Calculate what Mutation adds to class heap size.
boolean	isEmpty() Method to check if the familyMap is empty
protected boolean	isReturnResults() Returns current value for returnResults
int	numFamilies() Returns the number of different families
Mutation	setACL(Map<String,Permission> perms) Set the ACL for this operation.
Mutation	setACL(String user, Permission perms) Set the ACL for this operation.
Mutation	setCellVisibility(CellVisibility expression) Sets the visibility expression associated with cells in this Mutation.
Mutation	setClusterIds(List<UUID> clusterIds) Marks that the clusters with the given clusterIds have consumed the mutation
Mutation	setDurability(Durability d) Set the durability for this mutation
Mutation	setFamilyCellMap(NavigableMap<byte[],List<Cell>> map) Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Mutation(byte[], long, NavigableMap) instead
protected Mutation	setReturnResults(boolean returnResults)
Mutation	setTimestamp(long timestamp) Set the timestamp of the delete.
Mutation	setTTL(long ttl) Set the TTL desired for the result of the mutation, in milliseconds.
int	size() Number of KeyValues carried by this Mutation.
Map<String,Object>	toMap(int maxCols) Compile the details beyond the scope of getFingerprint (row, columns, timestamps, etc.) into a Map along with the fingerprinted information.

Methods inherited from class org.apache.hadoop.hbase.client.OperationWithAttributes

getAttribute, getAttributeSize, getAttributesMap, getId, getPriority, setAttribute, setId, setPriority

Methods inherited from class org.apache.hadoop.hbase.client.Operation

toJSON, toJSON, toMap, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

MUTATION_OVERHEAD

public static final long MUTATION_OVERHEAD

row

protected byte[] row

ts

protected long ts

durability

protected Durability durability

familyMap

protected NavigableMap<byte[],List<Cell>> familyMap

Constructor Detail

Mutation

protected Mutation()

empty construction. We need this empty construction to keep binary compatibility.

Mutation

protected Mutation(Mutation clone)

Mutation

protected Mutation(byte[] row,
                   long ts,
                   NavigableMap<byte[],List<Cell>> familyMap)

Construct the mutation with user defined data.

Parameters:

row - row. CAN'T be null

ts - timestamp

familyMap - the map to collect all cells internally. CAN'T be null

Method Detail

cellScanner

public CellScanner cellScanner()

Specified by:

cellScanner in interface CellScannable

getFingerprint

public Map<String,Object> getFingerprint()

Compile the column family (i.e. schema) information into a Map. Useful for parsing and aggregation by debugging, logging, and administration tools.

Specified by:

getFingerprint in class Operation

Returns:

a map containing fingerprint information (i.e. column families)

toMap

public Map<String,Object> toMap(int maxCols)

Compile the details beyond the scope of getFingerprint (row, columns, timestamps, etc.) into a Map along with the fingerprinted information. Useful for debugging, logging, and administration tools.

Specified by:

toMap in class Operation

Parameters:

maxCols - a limit on the number of columns output prior to truncation

Returns:

a map containing parameters of a query (i.e. rows, columns...)

setDurability

public Mutation setDurability(Durability d)

Set the durability for this mutation

getDurability

public Durability getDurability()

Get the current durability

getFamilyCellMap

public NavigableMap<byte[],List<Cell>> getFamilyCellMap()

Method for retrieving the put's familyMap

setFamilyCellMap

@Deprecated
public Mutation setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Mutation(byte[], long, NavigableMap) instead

Method for setting the mutation's familyMap

isEmpty

public boolean isEmpty()

Method to check if the familyMap is empty

Returns:

true if empty, false otherwise

getRow

public byte[] getRow()

Method for retrieving the delete's row

Specified by:

getRow in interface Row

compareTo

@Deprecated
public int compareTo(Row d)

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use Row.COMPARATOR instead

Description copied from interface: Row

Compare this row to another row.

Specified by:

compareTo in interface Comparable<Row>

Specified by:

compareTo in interface Row

getTimeStamp

@Deprecated
public long getTimeStamp()

Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0. Use getTimestamp() instead

Method for retrieving the timestamp

getTimestamp

public long getTimestamp()

Method for retrieving the timestamp.

setClusterIds

public Mutation setClusterIds(List<UUID> clusterIds)

Marks that the clusters with the given clusterIds have consumed the mutation

Parameters:

clusterIds - of the clusters that have consumed the mutation

getClusterIds

public List<UUID> getClusterIds()

Returns the set of clusterIds that have consumed the mutation

setCellVisibility

public Mutation setCellVisibility(CellVisibility expression)

Sets the visibility expression associated with cells in this Mutation.

getCellVisibility

public CellVisibility getCellVisibility()
                                 throws DeserializationException

Returns CellVisibility associated with cells in this Mutation. n

Throws:

DeserializationException

size

public int size()

Number of KeyValues carried by this Mutation.

Returns:

the total number of KeyValues

numFamilies

public int numFamilies()

Returns the number of different families

heapSize

public long heapSize()

Returns Calculate what Mutation adds to class heap size.

Specified by:

heapSize in interface HeapSize

getACL

public byte[] getACL()

Returns The serialized ACL for this operation, or null if none

setACL

public Mutation setACL(String user,
                       Permission perms)

Set the ACL for this operation.

Parameters:

user - User short name

perms - Permissions for the user

setACL

public Mutation setACL(Map<String,Permission> perms)

Set the ACL for this operation.

Parameters:

perms - A map of permissions for a user or users

getTTL

public long getTTL()

Return the TTL requested for the result of the mutation, in milliseconds.

Returns:

the TTL requested for the result of the mutation, in milliseconds, or Long.MAX_VALUE if unset

setTTL

public Mutation setTTL(long ttl)

Set the TTL desired for the result of the mutation, in milliseconds.

Parameters:

ttl - the TTL desired for the result of the mutation, in milliseconds

isReturnResults

@InterfaceAudience.Private
protected boolean isReturnResults()

Returns current value for returnResults

setReturnResults

@InterfaceAudience.Private
protected Mutation setReturnResults(boolean returnResults)

extraHeapSize

protected long extraHeapSize()

Subclasses should override this method to add the heap size of their own fields.

Returns:

the heap size to add (will be aligned).

setTimestamp

public Mutation setTimestamp(long timestamp)

Set the timestamp of the delete.

has

public boolean has(byte[] family,
                   byte[] qualifier)

A convenience method to determine if this object's familyMap contains a value assigned to the given family & qualifier. Both given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

Returns:

returns true if the given family and qualifier already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier,
                   long ts)

A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp. All 3 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

ts - timestamp

Returns:

returns true if the given family, qualifier and timestamp already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier,
                   byte[] value)

A convenience method to determine if this object's familyMap contains a value assigned to the given family, qualifier and timestamp. All 3 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

value - value to check

Returns:

returns true if the given family, qualifier and value already has an existing KeyValue object in the family map.

has

public boolean has(byte[] family,
                   byte[] qualifier,
                   long ts,
                   byte[] value)

A convenience method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp. All 4 given arguments must match the KeyValue object to return true.

Parameters:

family - column family

qualifier - column qualifier

ts - timestamp

value - value to check

Returns:

returns true if the given family, qualifier timestamp and value already has an existing KeyValue object in the family map.

get

public List<Cell> get(byte[] family,
                      byte[] qualifier)

Returns a list of all KeyValue objects with matching column family and qualifier.

Parameters:

family - column family

qualifier - column qualifier

Returns:

a list of KeyValue objects with the matching family and qualifier, returns an empty list if one doesn't exist for the given family.

has

protected boolean has(byte[] family,
                      byte[] qualifier,
                      long ts,
                      byte[] value,
                      boolean ignoreTS,
                      boolean ignoreValue)

Private method to determine if this object's familyMap contains the given value assigned to the given family, qualifier and timestamp, respecting the 2 boolean arguments.