Field Detail

• MUTATION_OVERHEAD

  public static final long MUTATION_OVERHEAD

• RETURN_RESULTS

  @Deprecated
  protected static final String RETURN_RESULTS

  Deprecated. this field is private as of HBase 2.0.

  See Also:

  Constant Field Values

• row

  protected byte[] row

• ts

  protected long ts

• durability

  protected Durability durability

• familyMap

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

Constructor Detail

• Mutation

  public Mutation()

Method Detail

• cellScanner

  public org.apache.hadoop.hbase.CellScanner cellScanner()

  Specified by:

  cellScanner in interface org.apache.hadoop.hbase.CellScannable

  Returns:

  A CellScanner over the contained Cells

• 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:

  Map

• 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:

  Map

• getWriteToWAL

  @Deprecated
  public boolean getWriteToWAL()

  Deprecated. Use getDurability() instead.

  Returns:

  true if edits should be applied to WAL, false if not

• setWriteToWAL

  @Deprecated
  public Mutation setWriteToWAL(boolean write)

  Deprecated. Use setDurability(Durability) instead.
  Set whether this Delete should be written to the WAL or not. Not writing the WAL means you may lose edits on server crash. This method will reset any changes made via setDurability(Durability)

  Parameters:

  write - true if edits should be written to WAL, false if not

• setDurability

  public Mutation setDurability(Durability d)

  Set the durability for this mutation

  Parameters:

  d -

• getDurability

  public Durability getDurability()

  Get the current durability

• getFamilyCellMap

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

  Method for retrieving the put's familyMap

  Returns:

  familyMap

• setFamilyCellMap

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

  Method for setting the put's familyMap

• getFamilyMap

  @Deprecated
  public NavigableMap<byte[],List<org.apache.hadoop.hbase.KeyValue>> getFamilyMap()

  Deprecated. use getFamilyCellMap() instead.
  Method for retrieving the put's familyMap that is deprecated and inefficient.

  Returns:

  the map

• setFamilyMap

  @Deprecated
  public Mutation setFamilyMap(NavigableMap<byte[],List<org.apache.hadoop.hbase.KeyValue>> map)

  Deprecated. use setFamilyCellMap(NavigableMap) instead.
  Method for setting the put's familyMap that is deprecated and inefficient.

• 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

  Returns:

  row

• compareTo

  public int compareTo(Row d)

  Specified by:

  compareTo in interface Comparable<Row>

• getTimeStamp

  public long getTimeStamp()

  Method for retrieving the timestamp

  Returns:

  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(org.apache.hadoop.hbase.security.visibility.CellVisibility expression)

  Sets the visibility expression associated with cells in this Mutation.

  Parameters:

  expression -

• getCellVisibility

  public org.apache.hadoop.hbase.security.visibility.CellVisibility getCellVisibility()
                                                                               throws org.apache.hadoop.hbase.exceptions.DeserializationException

  Returns:

  CellVisibility associated with cells in this Mutation.

  Throws:

  org.apache.hadoop.hbase.exceptions.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()

  Specified by:

  heapSize in interface org.apache.hadoop.hbase.io.HeapSize

  Returns:

  Calculate what Mutation adds to class heap size.

• getACL

  public byte[] getACL()

  Returns:

  The serialized ACL for this operation, or null if none

• setACL

  public Mutation setACL(String user,
                org.apache.hadoop.hbase.security.access.Permission perms)

  Parameters:

  user - User short name

  perms - Permissions for the user

• setACL

  public Mutation setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)

  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

  Returns:

  this

• 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).