Mutation (Apache HBase - Client 1.7.2 API)

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

所有已实现的接口:: Comparable<Row>, CellScannable, Attributes, Row, HeapSize

直接已知子类:: Append, Delete, Increment, Put

@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract class Mutation
extends OperationWithAttributes
implements Row, CellScannable, HeapSize

字段概要

字段
限定符和类型	字段和说明
`protected Durability`	`durability`
`protected NavigableMap<byte[],List<Cell>>`	`familyMap`
`static long`	`MUTATION_OVERHEAD`
`protected static String`	`RETURN_RESULTS` 已过时。 this field is private as of HBase 2.0.
`protected byte[]`	`row`
`protected long`	`ts`

从类继承的字段 org.apache.hadoop.hbase.client.OperationWithAttributes
ID_ATRIBUTE

构造器概要

构造器
构造器和说明

Mutation()

构造器
构造器和说明
`Mutation()`

方法概要

方法
限定符和类型	方法和说明
`CellScanner`	`cellScanner()`
`int`	`compareTo(Row d)`
`protected long`	`extraHeapSize()` Subclasses should override this method to add the heap size of their own fields.
`byte[]`	`getACL()`
`CellVisibility`	`getCellVisibility()`
`List<UUID>`	`getClusterIds()`
`Durability`	`getDurability()` Get the current durability
`NavigableMap<byte[],List<Cell>>`	`getFamilyCellMap()` Method for retrieving the put's familyMap
`NavigableMap<byte[],List<KeyValue>>`	`getFamilyMap()` 已过时。 use `getFamilyCellMap()` instead.
`Map<String,Object>`	`getFingerprint()` Compile the column family (i.e. schema) information into a Map.
`byte[]`	`getRow()` Method for retrieving the delete's row
`long`	`getTimeStamp()` Method for retrieving the timestamp
`long`	`getTTL()` Return the TTL requested for the result of the mutation, in milliseconds.
`boolean`	`getWriteToWAL()` 已过时。 Use `getDurability()` instead.
`long`	`heapSize()`
`boolean`	`isEmpty()` Method to check if the familyMap is empty
`protected boolean`	`isReturnResults()`
`int`	`numFamilies()`
`Mutation`	`setACL(Map<String,Permission> perms)`
`Mutation`	`setACL(String user, Permission perms)`
`Mutation`	`setCellVisibility(CellVisibility expression)` Sets the visibility expression associated with cells in this Mutation.
`Mutation`	`setClusterIds(List<UUID> clusterIds)` Marks that the clusters with the given clusterIds have consumed the mutation
`Mutation`	`setDurability(Durability d)` Set the durability for this mutation
`Mutation`	`setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)` Method for setting the put's familyMap
`Mutation`	`setFamilyMap(NavigableMap<byte[],List<KeyValue>> map)` 已过时。 use `setFamilyCellMap(NavigableMap)` instead.
`protected Mutation`	`setReturnResults(boolean returnResults)`
`Mutation`	`setTTL(long ttl)` Set the TTL desired for the result of the mutation, in milliseconds.
`Mutation`	`setWriteToWAL(boolean write)` 已过时。 Use `setDurability(Durability)` instead.
`int`	`size()` Number of KeyValues carried by this Mutation.
`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.

从类继承的方法 org.apache.hadoop.hbase.client.OperationWithAttributes
getAttribute, getAttributeSize, getAttributesMap, getId, getPriority, setAttribute, setId, setPriority

从类继承的方法 org.apache.hadoop.hbase.client.Operation
toJSON, toJSON, toMap, toString, toString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - MUTATION_OVERHEAD
```
public static final long MUTATION_OVERHEAD
```
  - RETURN_RESULTS
```
@Deprecated
protected static final String RETURN_RESULTS
```
    已过时。 this field is private as of HBase 2.0.
    
    另请参阅:
    常量字段值
  - row
```
protected byte[] row
```
  - ts
```
protected long ts
```
  - durability
```
protected Durability durability
```
  - familyMap
```
protected NavigableMap<byte[],List<Cell>> familyMap
```
- 构造器详细资料
  - Mutation
```
public Mutation()
```
- 方法详细资料
  - cellScanner
```
public CellScanner cellScanner()
```
    指定者:
    
    cellScanner 在接口中 CellScannable
  - 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.
    
    指定者:
    
    getFingerprint 在类中 Operation
    
    返回:
    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.
    
    指定者:
    
    toMap 在类中 Operation
    
    参数:
    maxCols - a limit on the number of columns output prior to truncation
    
    返回:
    Map
  - getWriteToWAL
```
@Deprecated
public boolean getWriteToWAL()
```
    已过时。 Use getDurability() instead.
    
    返回:
    true if edits should be applied to WAL, false if not
  - setWriteToWAL
```
@Deprecated
public Mutation setWriteToWAL(boolean write)
```
    已过时。 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)
    
    参数:
    write - true if edits should be written to WAL, false if not
  - setDurability
```
public Mutation setDurability(Durability d)
```
    Set the durability for this mutation
    
    参数:
    d -
  - getDurability
```
public Durability getDurability()
```
    Get the current durability
  - getFamilyCellMap
```
public NavigableMap<byte[],List<Cell>> getFamilyCellMap()
```
    Method for retrieving the put's familyMap
    
    返回:
    familyMap
  - setFamilyCellMap
```
public Mutation setFamilyCellMap(NavigableMap<byte[],List<Cell>> map)
```
    Method for setting the put's familyMap
  - getFamilyMap
```
@Deprecated
public NavigableMap<byte[],List<KeyValue>> getFamilyMap()
```
    已过时。 use getFamilyCellMap() instead.
    
    Method for retrieving the put's familyMap that is deprecated and inefficient.
    
    返回:
    the map
  - setFamilyMap
```
@Deprecated
public Mutation setFamilyMap(NavigableMap<byte[],List<KeyValue>> map)
```
    已过时。 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
    
    返回:
    true if empty, false otherwise
  - getRow
```
public byte[] getRow()
```
    Method for retrieving the delete's row
    
    指定者:
    
    getRow 在接口中 Row
    
    返回:
    row
  - compareTo
```
public int compareTo(Row d)
```
    指定者:
    
    compareTo 在接口中 Comparable<Row>
  - getTimeStamp
```
public long getTimeStamp()
```
    Method for retrieving the timestamp
    
    返回:
    timestamp
  - setClusterIds
```
public Mutation setClusterIds(List<UUID> clusterIds)
```
    Marks that the clusters with the given clusterIds have consumed the mutation
    
    参数:
    clusterIds - of the clusters that have consumed the mutation
  - getClusterIds
```
public List<UUID> getClusterIds()
```
    返回:
    the set of clusterIds that have consumed the mutation
  - setCellVisibility
```
public Mutation setCellVisibility(CellVisibility expression)
```
    Sets the visibility expression associated with cells in this Mutation.
    
    参数:
    expression -
  - getCellVisibility
```
public CellVisibility getCellVisibility()
                                 throws DeserializationException
```
    返回:
    CellVisibility associated with cells in this Mutation.
    
    抛出:
    
    DeserializationException
  - size
```
public int size()
```
    Number of KeyValues carried by this Mutation.
    
    返回:
    the total number of KeyValues
  - numFamilies
```
public int numFamilies()
```
    返回:
    the number of different families
  - heapSize
```
public long heapSize()
```
    指定者:
    
    heapSize 在接口中 HeapSize
    
    返回:
    Calculate what Mutation adds to class heap size.
  - getACL
```
public byte[] getACL()
```
    返回:
    The serialized ACL for this operation, or null if none
  - setACL
```
public Mutation setACL(String user,
              Permission perms)
```
    参数:
    user - User short name
    perms - Permissions for the user
  - setACL
```
public Mutation setACL(Map<String,Permission> perms)
```
    参数:
    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.
    
    返回:
    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.
    
    参数:
    ttl - the TTL desired for the result of the mutation, in milliseconds
    
    返回:
    this
  - isReturnResults
```
@InterfaceAudience.Private
protected boolean isReturnResults()
```
    返回:
    current value for returnResults
  - setReturnResults
```
@InterfaceAudience.Private
protected Mutation setReturnResults(boolean returnResults)
```
  - extraHeapSize
```
protected long extraHeapSize()
```
    Subclasses should override this method to add the heap size of their own fields.
    
    返回:
    the heap size to add (will be aligned).

类 Mutation

字段概要

从类继承的字段 org.apache.hadoop.hbase.client.OperationWithAttributes

构造器概要

方法概要

从类继承的方法 org.apache.hadoop.hbase.client.OperationWithAttributes

从类继承的方法 org.apache.hadoop.hbase.client.Operation

从类继承的方法 java.lang.Object

字段详细资料

MUTATION_OVERHEAD

RETURN_RESULTS

row

ts

durability

familyMap

构造器详细资料

Mutation

方法详细资料

cellScanner

getFingerprint

toMap

getWriteToWAL

setWriteToWAL

setDurability

getDurability

getFamilyCellMap

setFamilyCellMap

getFamilyMap

setFamilyMap

isEmpty

getRow

compareTo

getTimeStamp

setClusterIds

getClusterIds

setCellVisibility

getCellVisibility

size

numFamilies

heapSize

getACL

setACL

setACL

getTTL

setTTL

isReturnResults

setReturnResults

extraHeapSize