org.apache.hadoop.hbase.client

Class Put

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

All Implemented Interfaces:

java.lang.Comparable<Row>, CellScannable, Attributes, Row, HeapSize

@InterfaceAudience.Public
 @InterfaceStability.Stable
public class Put
extends Mutation
implements HeapSize, java.lang.Comparable<Row>

Used to perform Put operations for a single row.

To perform a Put, instantiate a Put object with the row to insert to and for eachumn to be inserted, execute add or add if setting the timestamp.

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
Put(byte[] row) Create a Put operation for the specified row.
Put(byte[] rowArray, int rowOffset, int rowLength) We make a copy of the passed in row key to keep local.
Put(byte[] rowArray, int rowOffset, int rowLength, long ts) We make a copy of the passed in row key to keep local.
Put(byte[] row, long ts) Create a Put operation for the specified row, using a given timestamp.
Put(java.nio.ByteBuffer row)
Put(java.nio.ByteBuffer row, long ts)
Put(Put putToCopy) Copy constructor.

Method Summary

Modifier and Type	Method and Description
Put	add(byte[] family, byte[] qualifier, byte[] value) Deprecated. Since 1.0.0. Use addColumn(byte[], byte[], byte[])
Put	add(byte[] family, byte[] qualifier, long ts, byte[] value) Deprecated. Since 1.0.0. Use addColumn(byte[], byte[], long, byte[])
Put	add(byte[] family, java.nio.ByteBuffer qualifier, long ts, java.nio.ByteBuffer value) Deprecated. Since 1.0.0. Use addColumn(byte[], ByteBuffer, long, ByteBuffer)
Put	add(Cell kv) Add the specified KeyValue to this Put operation.
Put	addColumn(byte[] family, byte[] qualifier, byte[] value) Add the specified column and value to this Put operation.
Put	addColumn(byte[] family, byte[] qualifier, long ts, byte[] value) Add the specified column and value, with the specified timestamp as its version to this Put operation.
Put	addColumn(byte[] family, java.nio.ByteBuffer qualifier, long ts, java.nio.ByteBuffer value) Add the specified column and value, with the specified timestamp as its version to this Put operation.
Put	addImmutable(byte[] family, byte[] qualifier, byte[] value) See add(byte[], byte[], byte[]).
Put	addImmutable(byte[] family, byte[] qualifier, byte[] value, Tag[] tag) This expects that the underlying arrays won't change.
Put	addImmutable(byte[] family, byte[] qualifier, long ts, byte[] value) See add(byte[], byte[], long, byte[]).
Put	addImmutable(byte[] family, byte[] qualifier, long ts, byte[] value, Tag[] tag) This expects that the underlying arrays won't change.
Put	addImmutable(byte[] family, java.nio.ByteBuffer qualifier, long ts, java.nio.ByteBuffer value) See add(byte[], ByteBuffer, long, ByteBuffer).
Put	addImmutable(byte[] family, java.nio.ByteBuffer qualifier, long ts, java.nio.ByteBuffer value, Tag[] tag) This expects that the underlying arrays won't change.
java.util.List<Cell>	get(byte[] family, byte[] qualifier) Returns a list of all KeyValue objects with matching column family and qualifier.
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.
Put	setACL(java.util.Map<java.lang.String,Permission> perms)
Put	setACL(java.lang.String user, Permission perms)
Put	setAttribute(java.lang.String name, byte[] value) Sets an attribute.
Put	setCellVisibility(CellVisibility expression) Sets the visibility expression associated with cells in this Mutation.
Put	setClusterIds(java.util.List<java.util.UUID> clusterIds) Marks that the clusters with the given clusterIds have consumed the mutation
Put	setDurability(Durability d) Set the durability for this mutation
Put	setFamilyCellMap(java.util.NavigableMap<byte[],java.util.List<Cell>> map) Method for setting the put's familyMap
Put	setFamilyMap(java.util.NavigableMap<byte[],java.util.List<KeyValue>> map) Deprecated.
Put	setId(java.lang.String id) This method allows you to set an identifier on an operation.
Put	setTTL(long ttl) Set the TTL desired for the result of the mutation, in milliseconds.
Put	setWriteToWAL(boolean write) Deprecated.

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

cellScanner, compareTo, extraHeapSize, getACL, getCellVisibility, getClusterIds, getDurability, getFamilyCellMap, getFamilyMap, getFingerprint, getRow, getTimeStamp, getTTL, getWriteToWAL, 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

Methods inherited from interface org.apache.hadoop.hbase.io.HeapSize

heapSize

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

Put

public Put(byte[] row)

Create a Put operation for the specified row.

Parameters:

row - row key

Put

public Put(byte[] row,
           long ts)

Create a Put operation for the specified row, using a given timestamp.

Parameters:

row - row key; we make a copy of what we are passed to keep local.

ts - timestamp

Put

public Put(byte[] rowArray,
           int rowOffset,
           int rowLength)

We make a copy of the passed in row key to keep local.

Parameters:

rowArray -

rowOffset -

rowLength -

Put

public Put(java.nio.ByteBuffer row,
           long ts)

Parameters:

row - row key; we make a copy of what we are passed to keep local.

ts - timestamp

Put

public Put(java.nio.ByteBuffer row)

Parameters:

row - row key; we make a copy of what we are passed to keep local.

Put

public Put(byte[] rowArray,
           int rowOffset,
           int rowLength,
           long ts)

We make a copy of the passed in row key to keep local.

Parameters:

rowArray -

rowOffset -

rowLength -

ts -

Put

public Put(Put putToCopy)

Copy constructor. Creates a Put operation cloned from the specified Put.

Parameters:

putToCopy - put to copy

Method Detail

add

@Deprecated
public Put add(byte[] family,
                           byte[] qualifier,
                           byte[] value)

Deprecated. Since 1.0.0. Use addColumn(byte[], byte[], byte[])

Add the specified column and value to this Put operation.

Parameters:

family - family name

qualifier - column qualifier

value - column value

Returns:

this

addColumn

public Put addColumn(byte[] family,
                     byte[] qualifier,
                     byte[] value)

Add the specified column and value to this Put operation.

Parameters:

family - family name

qualifier - column qualifier

value - column value

Returns:

this

addImmutable

public Put addImmutable(byte[] family,
                        byte[] qualifier,
                        byte[] value)

See add(byte[], byte[], byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

addImmutable

public Put addImmutable(byte[] family,
                        byte[] qualifier,
                        byte[] value,
                        Tag[] tag)

This expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

add

@Deprecated
public Put add(byte[] family,
                           byte[] qualifier,
                           long ts,
                           byte[] value)

Deprecated. Since 1.0.0. Use addColumn(byte[], byte[], long, byte[])

Add the specified column and value, with the specified timestamp as its version to this Put operation.

Parameters:

family - family name

qualifier - column qualifier

ts - version timestamp

value - column value

Returns:

this

addColumn

public Put addColumn(byte[] family,
                     byte[] qualifier,
                     long ts,
                     byte[] value)

Add the specified column and value, with the specified timestamp as its version to this Put operation.

Parameters:

family - family name

qualifier - column qualifier

ts - version timestamp

value - column value

Returns:

this

addImmutable

public Put addImmutable(byte[] family,
                        byte[] qualifier,
                        long ts,
                        byte[] value)

See add(byte[], byte[], long, byte[]). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

addImmutable

public Put addImmutable(byte[] family,
                        byte[] qualifier,
                        long ts,
                        byte[] value,
                        Tag[] tag)

This expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

addImmutable

public Put addImmutable(byte[] family,
                        java.nio.ByteBuffer qualifier,
                        long ts,
                        java.nio.ByteBuffer value,
                        Tag[] tag)

This expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

add

@Deprecated
public Put add(byte[] family,
                           java.nio.ByteBuffer qualifier,
                           long ts,
                           java.nio.ByteBuffer value)

Deprecated. Since 1.0.0. Use addColumn(byte[], ByteBuffer, long, ByteBuffer)

Add the specified column and value, with the specified timestamp as its version to this Put operation.

Parameters:

family - family name

qualifier - column qualifier

ts - version timestamp

value - column value

Returns:

this

addColumn

public Put addColumn(byte[] family,
                     java.nio.ByteBuffer qualifier,
                     long ts,
                     java.nio.ByteBuffer value)

Add the specified column and value, with the specified timestamp as its version to this Put operation.

Parameters:

family - family name

qualifier - column qualifier

ts - version timestamp

value - column value

Returns:

this

addImmutable

public Put addImmutable(byte[] family,
                        java.nio.ByteBuffer qualifier,
                        long ts,
                        java.nio.ByteBuffer value)

See add(byte[], ByteBuffer, long, ByteBuffer). This version expects that the underlying arrays won't change. It's intended for usage internal HBase to and for advanced client applications.

add

public Put add(Cell kv)
        throws java.io.IOException

Add the specified KeyValue to this Put operation. Operation assumes that the passed KeyValue is immutable and its backing array will not be modified for the duration of this Put.

Parameters:

kv - individual KeyValue

Returns:

this

Throws:

java.io.IOException - e

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 java.util.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.

setAttribute

public Put setAttribute(java.lang.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 Put setId(java.lang.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 Put 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 Put setDurability(Durability d)

Description copied from class: Mutation

Set the durability for this mutation

Overrides:

setDurability in class Mutation

setFamilyCellMap

public Put setFamilyCellMap(java.util.NavigableMap<byte[],java.util.List<Cell>> map)

Description copied from class: Mutation

Method for setting the put's familyMap

Overrides:

setFamilyCellMap in class Mutation

setFamilyMap

@Deprecated
public Put setFamilyMap(java.util.NavigableMap<byte[],java.util.List<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 Put setClusterIds(java.util.List<java.util.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 Put setCellVisibility(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 Put setACL(java.lang.String user,
                  Permission perms)

Overrides:

setACL in class Mutation

Parameters:

user - User short name

perms - Permissions for the user

setACL

public Put setACL(java.util.Map<java.lang.String,Permission> perms)

Overrides:

setACL in class Mutation

Parameters:

perms - A map of permissions for a user or users

setTTL

public Put 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