Append (Apache HBase 2.0.0-SNAPSHOT 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.Append
      +
    +
  +
+

+
+
All Implemented Interfaces:
+
Comparable<Row>, org.apache.hadoop.hbase.CellScannable, Attributes, Row, org.apache.hadoop.hbase.io.HeapSize
+
+
+
+
```
@InterfaceAudience.Public
+public class Append
+extends Mutation
```
+
Performs Append operations on a single row. +
+ Note that this operation does not appear atomic to readers. Appends are done + under a single row lock, so write operations to a row are synchronized, but + readers do not take row locks so get and scan operations can see this + operation partially completed. +
+ To append to a set of columns of a row, instantiate an Append object with the + row to append to. At least one column to append must be specified using the + add(byte[], byte[], byte[]) method.
+

+ +

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

+ +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`Append(Append a)` + Copy constructor +
`Append(byte[] row)` + Create a Append operation for the specified row. +
`Append(byte[] rowArray, + int rowOffset, + int rowLength)` + Create a Append operation for the specified row. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Append`	`add(byte[] family, + byte[] qualifier, + byte[] value)` + Add the specified column and value to this Append operation. +
`Append`	`add(Cell cell)` + Add column and value to this Append operation. +
`boolean`	`isReturnResults()`
`Append`	`setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)`
`Append`	`setACL(String user, + org.apache.hadoop.hbase.security.access.Permission perms)`
`Append`	`setAttribute(String name, + byte[] value)` + Sets an attribute. +
`Append`	`setCellVisibility(org.apache.hadoop.hbase.security.visibility.CellVisibility expression)` + Sets the visibility expression associated with cells in this Mutation. +
`Append`	`setClusterIds(List<UUID> clusterIds)` + Marks that the clusters with the given clusterIds have consumed the mutation +
`Append`	`setDurability(Durability d)` + Set the durability for this mutation +
`Append`	`setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)` + Method for setting the put's familyMap +
`Append`	`setId(String id)` + This method allows you to set an identifier on an operation. +
`Append`	`setReturnResults(boolean returnResults)`
`Append`	`setTTL(long ttl)` + Set the TTL desired for the result of the mutation, in milliseconds. +

+ + +
Methods inherited from class org.apache.hadoop.hbase.client.Mutation
+cellScanner, compareTo, extraHeapSize, getACL, getCellVisibility, getClusterIds, getDurability, getFamilyCellMap, getFingerprint, getRow, getTimeStamp, getTTL, heapSize, isEmpty, numFamilies, 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, toString

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

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Append
    +
```
public Append(byte[] row)
```
    +
    Create a Append operation for the specified row. +
    + At least one column must be appended to.
    +
    +
    Parameters:
    +
    row - row key; makes a local copy of passed in array.
    +
    +
  + + + +
  - +
    Append
    +
```
public Append(Append a)
```
    +
    Copy constructor
    +
    +
    Parameters:
    +
    a -
    +
    +
  + + + +
  - +
    Append
    +
```
public Append(byte[] rowArray,
+              int rowOffset,
+              int rowLength)
```
    +
    Create a Append operation for the specified row. +
    + At least one column must be appended to.
    +
    +
    Parameters:
    +
    rowArray - Makes a copy out of this buffer.
    +
    rowOffset -
    +
    rowLength -
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    setReturnResults
    +
```
public Append setReturnResults(boolean returnResults)
```
    +
    +
    Parameters:
    +
    returnResults - True (default) if the append 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
    +
    +
  + + + +
  - +
    add
    +
```
public Append add(byte[] family,
+                  byte[] qualifier,
+                  byte[] value)
```
    +
    Add the specified column and value to this Append operation.
    +
    +
    Parameters:
    +
    family - family name
    +
    qualifier - column qualifier
    +
    value - value to append to specified column
    +
    Returns:
    +
    this
    +
    +
  + + + +
  - +
    add
    +
```
public Append add(Cell cell)
```
    +
    Add column and value to this Append operation.
    +
    +
    Parameters:
    +
    cell -
    +
    Returns:
    +
    This instance
    +
    +
  + + + +
  - +
    setAttribute
    +
```
public Append 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 Append 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
    +
    +
  + + + +
  - +
    setDurability
    +
```
public Append setDurability(Durability d)
```
    +
    Description copied from class: Mutation
    +
    Set the durability for this mutation
    +
    +
    Overrides:
    +
    setDurability in class Mutation
    +
    +
  + + + +
  - +
    setFamilyCellMap
    +
```
public Append setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)
```
    +
    Description copied from class: Mutation
    +
    Method for setting the put's familyMap
    +
    +
    Overrides:
    +
    setFamilyCellMap in class Mutation
    +
    +
  + + + +
  - +
    setClusterIds
    +
```
public Append 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 Append setCellVisibility(org.apache.hadoop.hbase.security.visibility.CellVisibility expression)
```
    +
    Description copied from class: Mutation
    +
    Sets the visibility expression associated with cells in this Mutation. + It is illegal to set CellVisibility on Delete mutation.
    +
    +
    Overrides:
    +
    setCellVisibility in class Mutation
    +
    +
  + + + +
  - +
    setACL
    +
```
public Append 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 Append 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 Append 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 Append

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

Append

Append

Append

Method Detail

setReturnResults

isReturnResults

add

add

setAttribute

setId

setDurability

setFamilyCellMap

setClusterIds

setCellVisibility

setACL

setACL

setTTL