org.apache.hadoop.hbase.client

Class Append

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:

CellScannable, Attributes, Row, org.apache.hadoop.hbase.io.HeapSize

@InterfaceAudience.Public
public class Append
extends Mutation

Performs Append operations on a single row.

This operation ensures atomicty to readers. Appends 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 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 addColumn(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

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

COMPARATOR

Constructor Summary

Constructors

Constructor and Description
Append(Append appendToCopy) 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.
Append(byte[] row, long ts, NavigableMap<byte[],List<Cell>> familyMap) Construct the Append with user defined data.

Method Summary

Modifier and Type	Method and Description
Append	add(Cell cell) Add column and value to this Append operation.
Append	addColumn(byte[] family, byte[] qualifier, byte[] value) Add the specified column and value to this Append operation.
protected long	extraHeapSize() Subclasses should override this method to add the heap size of their own fields.
CellBuilder	getCellBuilder(CellBuilderType type) get a CellBuilder instance that already has relevant Type and Row set.
TimeRange	getTimeRange() Gets the TimeRange used for this append.
boolean	isReturnResults() Returns current setting for returnResults
Append	setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms) Set the ACL for this operation.
Append	setACL(String user, org.apache.hadoop.hbase.security.access.Permission perms) Set the ACL for this operation.
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	setId(String id) This method allows you to set an identifier on an operation.
Append	setPriority(int priority)
Append	setReturnResults(boolean returnResults) True (default) if the append operation should return the results.
Append	setTimeRange(long minStamp, long maxStamp) Sets the TimeRange to be used on the Get for this append.
Append	setTimestamp(long timestamp) Set the timestamp of the delete.
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, get, getACL, getCellBuilder, getCellBuilder, getCellVisibility, getClusterIds, getDurability, getFamilyCellMap, getFingerprint, getRow, getTimestamp, getTTL, has, has, has, has, has, heapSize, isEmpty, numFamilies, size, toMap

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

getAttribute, getAttributeSize, getAttributesMap, getId, getPriority

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 appendToCopy)

Copy constructor

Parameters:

appendToCopy - append to copy

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.

Append

public Append(byte[] row,
              long ts,
              NavigableMap<byte[],List<Cell>> familyMap)

Construct the Append with user defined data. NOTED: 1) all cells in the familyMap must have the Type.Put 2) the row of each cell must be same with passed row.

Parameters:

row - row. CAN'T be null

ts - timestamp

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

Method Detail

setTimeRange

public Append setTimeRange(long minStamp,
                           long maxStamp)

Sets the TimeRange to be used on the Get for this append.

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 append, you can potentially gain some performance with a more optimal Get operation. Be careful adding the time range to this class as you will update the old cell if the time range doesn't include the latest cells.

This range is used as [minStamp, maxStamp).

Parameters:

minStamp - minimum timestamp value, inclusive

maxStamp - maximum timestamp value, exclusive

getTimeRange

public TimeRange getTimeRange()

Gets the TimeRange used for this append.

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

setReturnResults

public Append setReturnResults(boolean 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

addColumn

public Append addColumn(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

add

public Append add(Cell cell)

Add column and value to this Append operation.

Returns:

This instance

setTimestamp

public Append setTimestamp(long timestamp)

Description copied from class: Mutation

Set the timestamp of the delete.

Overrides:

setTimestamp in class Mutation

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. id to set for the scan

Overrides:

setId in class OperationWithAttributes

setDurability

public Append setDurability(Durability d)

Description copied from class: Mutation

Set the durability for this mutation

Overrides:

setDurability 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.

Overrides:

setCellVisibility in class Mutation

setACL

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

Description copied from class: Mutation

Set the ACL for this operation.

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)

Description copied from class: Mutation

Set the ACL for this operation.

Overrides:

setACL in class Mutation

Parameters:

perms - A map of permissions for a user or users

setPriority

public Append setPriority(int priority)

Overrides:

setPriority in class OperationWithAttributes

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

getCellBuilder

public CellBuilder getCellBuilder(CellBuilderType type)

Description copied from class: Mutation

get a CellBuilder instance that already has relevant Type and Row set.

Specified by:

getCellBuilder in class Mutation

Parameters:

type - e.g CellBuilderType.SHALLOW_COPY

Returns:

CellBuilder which already has relevant Type and Row set.