Increment (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.client.Operation
- - org.apache.hadoop.hbase.client.OperationWithAttributes
  - - org.apache.hadoop.hbase.client.Mutation
    - - org.apache.hadoop.hbase.client.Increment

All Implemented Interfaces:

Comparable<Row>, org.apache.hadoop.hbase.CellScannable, Attributes, Row, org.apache.hadoop.hbase.io.HeapSize
```
@InterfaceAudience.Public
@InterfaceStability.Stable
public class Increment
extends Mutation
implements Comparable<Row>
```
Used to perform Increment operations on a single row.
This operation ensures atomicity to readers. Increments are done under a single row lock, so write operations to a row are synchronized, and readers are guaranteed to see this operation fully completed.
To increment columns of a row, instantiate an Increment object with the row to increment. At least one column to increment must be specified using the addColumn(byte[], byte[], long) method.

Field Summary
- Fields inherited from class org.apache.hadoop.hbase.client.Mutation
  durability, familyMap, MUTATION_OVERHEAD, RETURN_RESULTS, row, ts
- Fields inherited from class org.apache.hadoop.hbase.client.OperationWithAttributes
  ID_ATRIBUTE

Constructor Summary

Constructors
Constructor and Description
`Increment(byte[] row)` Create a Increment operation for the specified row.
`Increment(byte[] row, int offset, int length)` Create a Increment operation for the specified row.
`Increment(Increment i)` Copy constructor

Method Summary

Methods
Modifier and Type	Method and Description
`Increment`	`add(Cell cell)` Add the specified KeyValue to this operation.
`Increment`	`addColumn(byte[] family, byte[] qualifier, long amount)` Increment the column from the specific family with the specified qualifier by the specified amount.
`int`	`compareTo(Row i)`
`boolean`	`equals(Object obj)`
`protected long`	`extraHeapSize()` Subclasses should override this method to add the heap size of their own fields.
`Map<byte[],NavigableMap<byte[],Long>>`	`getFamilyMapOfLongs()` Before 0.95, when you called Increment#getFamilyMap(), you got back a map of families to a list of Longs.
`TimeRange`	`getTimeRange()` Gets the TimeRange used for this increment.
`boolean`	`hasFamilies()` Method for checking if any families have been inserted into this Increment
`int`	`hashCode()`
`boolean`	`isReturnResults()`
`int`	`numFamilies()` Method for retrieving the number of families to increment from
`Increment`	`setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)`
`Increment`	`setACL(String user, org.apache.hadoop.hbase.security.access.Permission perms)`
`Increment`	`setAttribute(String name, byte[] value)` Sets an attribute.
`Increment`	`setCellVisibility(org.apache.hadoop.hbase.security.visibility.CellVisibility expression)` Sets the visibility expression associated with cells in this Mutation.
`Increment`	`setClusterIds(List<UUID> clusterIds)` Marks that the clusters with the given clusterIds have consumed the mutation
`Increment`	`setDurability(Durability d)` Set the durability for this mutation
`Increment`	`setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)` Method for setting the put's familyMap
`Increment`	`setFamilyMap(NavigableMap<byte[],List<org.apache.hadoop.hbase.KeyValue>> map)` Deprecated.
`Increment`	`setId(String id)` This method allows you to set an identifier on an operation.
`Increment`	`setReturnResults(boolean returnResults)`
`Increment`	`setTimeRange(long minStamp, long maxStamp)` Sets the TimeRange to be used on the Get for this increment.
`Increment`	`setTTL(long ttl)` Set the TTL desired for the result of the mutation, in milliseconds.
`Increment`	`setWriteToWAL(boolean write)` Deprecated.
`String`	`toString()` Produces a string representation of this Operation.

Methods inherited from class org.apache.hadoop.hbase.client.Mutation
cellScanner, getACL, getCellVisibility, getClusterIds, getDurability, getFamilyCellMap, getFamilyMap, getFingerprint, getRow, getTimeStamp, getTTL, getWriteToWAL, heapSize, isEmpty, size, toMap

Methods inherited from class org.apache.hadoop.hbase.client.OperationWithAttributes
getAttribute, getAttributeSize, getAttributesMap, getId

Methods inherited from class org.apache.hadoop.hbase.client.Operation
toJSON, toJSON, toMap, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Increment
```
public Increment(byte[] row)
```
    Create a Increment operation for the specified row.
    At least one column must be incremented.
    
    Parameters:
    row - row key (we will make a copy of this).
  - Increment
```
public Increment(byte[] row,
         int offset,
         int length)
```
    Create a Increment operation for the specified row.
    At least one column must be incremented.
    
    Parameters:
    row - row key (we will make a copy of this).
  - Increment
```
public Increment(Increment i)
```
    Copy constructor
    
    Parameters:
    i -
- Method Detail
  - add
```
public Increment add(Cell cell)
              throws IOException
```
    Add the specified KeyValue to this operation.
    
    Parameters:
    cell - individual Cell
    
    Returns:
    this
    
    Throws:
    
    IOException - e
  - addColumn
```
public Increment addColumn(byte[] family,
                  byte[] qualifier,
                  long amount)
```
    Increment the column from the specific family with the specified qualifier by the specified amount.
    Overrides previous calls to addColumn for this family and qualifier.
    
    Parameters:
    family - family name
    qualifier - column qualifier
    amount - amount to increment by
    
    Returns:
    the Increment object
  - getTimeRange
```
public TimeRange getTimeRange()
```
    Gets the TimeRange used for this increment.
    
    Returns:
    TimeRange
  - setTimeRange
```
public Increment setTimeRange(long minStamp,
                     long maxStamp)
                       throws IOException
```
    Sets the TimeRange to be used on the Get for this increment.
    This is useful for when you have counters that only last for specific periods of time (ie. counters that are partitioned by time). By setting the range of valid times for this increment, you can potentially gain some performance with a more optimal Get operation.
    This range is used as [minStamp, maxStamp).
    
    Parameters:
    minStamp - minimum timestamp value, inclusive
    maxStamp - maximum timestamp value, exclusive
    
    Returns:
    this
    
    Throws:
    
    IOException - if invalid time range
  - setReturnResults
```
public Increment setReturnResults(boolean returnResults)
```
    Parameters:
    returnResults - True (default) if the increment operation should return the results. A client that is not interested in the result can save network bandwidth setting this to false.
  - isReturnResults
```
public boolean isReturnResults()
```
    Returns:
    current setting for returnResults
  - numFamilies
```
public int numFamilies()
```
    Method for retrieving the number of families to increment from
    
    Overrides:
    
    numFamilies in class Mutation
    
    Returns:
    number of families
  - hasFamilies
```
public boolean hasFamilies()
```
    Method for checking if any families have been inserted into this Increment
    
    Returns:
    true if familyMap is non empty false otherwise
  - getFamilyMapOfLongs
```
public Map<byte[],NavigableMap<byte[],Long>> getFamilyMapOfLongs()
```
    Before 0.95, when you called Increment#getFamilyMap(), you got back a map of families to a list of Longs. Now, Mutation.getFamilyCellMap() returns families by list of Cells. This method has been added so you can have the old behavior.
    
    Returns:
    Map of families to a Map of qualifiers and their Long increments.
    Since:
    
    0.95.0
  - toString
```
public String toString()
```
    Description copied from class: Operation
    
    Produces a string representation of this Operation. It defaults to a JSON representation, but falls back to a string representation of the fingerprint and details in the case of a JSON encoding failure.
    
    Overrides:
    
    toString in class Operation
    
    Returns:
    String
  - compareTo
```
public int compareTo(Row i)
```
    Specified by:
    
    compareTo in interface Comparable<Row>
    
    Overrides:
    
    compareTo in class Mutation
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - extraHeapSize
```
protected long extraHeapSize()
```
    Description copied from class: Mutation
    
    Subclasses should override this method to add the heap size of their own fields.
    
    Overrides:
    
    extraHeapSize in class Mutation
    
    Returns:
    the heap size to add (will be aligned).
  - setAttribute
```
public Increment setAttribute(String name,
                     byte[] value)
```
    Description copied from interface: Attributes
    
    Sets an attribute. In case value = null attribute is removed from the attributes map. Attribute names starting with _ indicate system attributes.
    
    Specified by:
    
    setAttribute in interface Attributes
    
    Overrides:
    
    setAttribute in class OperationWithAttributes
    
    Parameters:
    name - attribute name
    value - attribute value
  - setId
```
public Increment setId(String id)
```
    Description copied from class: OperationWithAttributes
    
    This method allows you to set an identifier on an operation. The original motivation for this was to allow the identifier to be used in slow query logging, but this could obviously be useful in other places. One use of this could be to put a class.method identifier in here to see where the slow query is coming from.
    
    Overrides:
    
    setId in class OperationWithAttributes
    
    Parameters:
    id - id to set for the scan
  - setWriteToWAL
```
@Deprecated
public Increment setWriteToWAL(boolean write)
```
    Deprecated.
    
    Description copied from class: Mutation
    
    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 Mutation.setDurability(Durability)
    
    Overrides:
    
    setWriteToWAL in class Mutation
    
    Parameters:
    write - true if edits should be written to WAL, false if not
  - setDurability
```
public Increment setDurability(Durability d)
```
    Description copied from class: Mutation
    
    Set the durability for this mutation
    
    Overrides:
    
    setDurability in class Mutation
  - setFamilyCellMap
```
public Increment setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)
```
    Description copied from class: Mutation
    
    Method for setting the put's familyMap
    
    Overrides:
    
    setFamilyCellMap in class Mutation
  - setFamilyMap
```
@Deprecated
public Increment setFamilyMap(NavigableMap<byte[],List<org.apache.hadoop.hbase.KeyValue>> map)
```
    Deprecated.
    
    Description copied from class: Mutation
    
    Method for setting the put's familyMap that is deprecated and inefficient.
    
    Overrides:
    
    setFamilyMap in class Mutation
  - setClusterIds
```
public Increment setClusterIds(List<UUID> clusterIds)
```
    Description copied from class: Mutation
    
    Marks that the clusters with the given clusterIds have consumed the mutation
    
    Overrides:
    
    setClusterIds in class Mutation
    
    Parameters:
    clusterIds - of the clusters that have consumed the mutation
  - setCellVisibility
```
public Increment setCellVisibility(org.apache.hadoop.hbase.security.visibility.CellVisibility expression)
```
    Description copied from class: Mutation
    
    Sets the visibility expression associated with cells in this Mutation.
    
    Overrides:
    
    setCellVisibility in class Mutation
  - setACL
```
public Increment setACL(String user,
               org.apache.hadoop.hbase.security.access.Permission perms)
```
    Overrides:
    
    setACL in class Mutation
    
    Parameters:
    user - User short name
    perms - Permissions for the user
  - setACL
```
public Increment setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)
```
    Overrides:
    
    setACL in class Mutation
    
    Parameters:
    perms - A map of permissions for a user or users
  - setTTL
```
public Increment setTTL(long ttl)
```
    Description copied from class: Mutation
    
    Set the TTL desired for the result of the mutation, in milliseconds.
    
    Overrides:
    
    setTTL in class Mutation
    
    Parameters:
    ttl - the TTL desired for the result of the mutation, in milliseconds
    
    Returns:
    this

Class Increment

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

Increment

Increment

Increment

Method Detail

add

addColumn

getTimeRange

setTimeRange

setReturnResults

isReturnResults

numFamilies

hasFamilies

getFamilyMapOfLongs

toString

compareTo

hashCode

equals

extraHeapSize

setAttribute

setId

setWriteToWAL

setDurability

setFamilyCellMap

setFamilyMap

setClusterIds

setCellVisibility

setACL

setACL

setTTL