org.apache.hadoop.hbase.client

Class Query

java.lang.Object

org.apache.hadoop.hbase.client.Operation

org.apache.hadoop.hbase.client.OperationWithAttributes

org.apache.hadoop.hbase.client.Query

All Implemented Interfaces:

Attributes

Direct Known Subclasses:

Get, Scan

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public abstract class Query
extends OperationWithAttributes

Field Summary

Fields

Modifier and Type	Field and Description
protected Consistency	consistency
protected Filter	filter
protected int	targetReplicaId

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

ID_ATRIBUTE

Constructor Summary

Constructors

Constructor and Description
Query()

Method Summary

Modifier and Type	Method and Description
byte[]	getACL()
Authorizations	getAuthorizations()
Consistency	getConsistency() Returns the consistency level for this operation
Filter	getFilter()
IsolationLevel	getIsolationLevel()
int	getReplicaId() Returns region replica id where Query will fetch data from.
Query	setACL(Map<String,Permission> perms)
Query	setACL(String user, Permission perms)
Query	setAuthorizations(Authorizations authorizations) Sets the authorizations to be used by this Query
Query	setConsistency(Consistency consistency) Sets the consistency level for this operation
Query	setFilter(Filter filter) Apply the specified server-side filter when performing the Query.
Query	setIsolationLevel(IsolationLevel level) Set the isolation level for this query.
Query	setReplicaId(int Id) Specify region replica id where Query will fetch data from.

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

getAttribute, getAttributeSize, getAttributesMap, getId, setAttribute, setId

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

getFingerprint, toJSON, toJSON, toMap, toMap, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

filter

protected Filter filter

targetReplicaId

protected int targetReplicaId

consistency

protected Consistency consistency

Constructor Detail

Query

public Query()

Method Detail

getFilter

public Filter getFilter()

Returns:

Filter

setFilter

public Query setFilter(Filter filter)

Apply the specified server-side filter when performing the Query. Only Filter.filterKeyValue(Cell) is called AFTER all tests for ttl, column match, deletes and max versions have been run.

Parameters:

filter - filter to run on the server

Returns:

this for invocation chaining

setAuthorizations

public Query setAuthorizations(Authorizations authorizations)

Sets the authorizations to be used by this Query

Parameters:

authorizations -

getAuthorizations

public Authorizations getAuthorizations()
                                 throws DeserializationException

Returns:

The authorizations this Query is associated with.

Throws:

DeserializationException

getACL

public byte[] getACL()

Returns:

The serialized ACL for this operation, or null if none

setACL

public Query setACL(String user,
                    Permission perms)

Parameters:

user - User short name

perms - Permissions for the user

setACL

public Query setACL(Map<String,Permission> perms)

Parameters:

perms - A map of permissions for a user or users

getConsistency

public Consistency getConsistency()

Returns the consistency level for this operation

Returns:

the consistency level

setConsistency

public Query setConsistency(Consistency consistency)

Sets the consistency level for this operation

Parameters:

consistency - the consistency level

setReplicaId

public Query setReplicaId(int Id)

Specify region replica id where Query will fetch data from. Use this together with setConsistency(Consistency) passing Consistency.TIMELINE to read data from a specific replicaId.
Expert: This is an advanced API exposed. Only use it if you know what you are doing

Parameters:

Id -

getReplicaId

public int getReplicaId()

Returns region replica id where Query will fetch data from.

Returns:

region replica id or -1 if not set.

setIsolationLevel

public Query setIsolationLevel(IsolationLevel level)

Set the isolation level for this query. If the isolation level is set to READ_UNCOMMITTED, then this query will return data from committed and uncommitted transactions. If the isolation level is set to READ_COMMITTED, then this query will return data from committed transactions only. If a isolation level is not explicitly set on a Query, then it is assumed to be READ_COMMITTED.

Parameters:

level - IsolationLevel for this query

getIsolationLevel

public IsolationLevel getIsolationLevel()

Returns:

The isolation level of this query. If no isolation level was set for this query object, then it returns READ_COMMITTED.