org.hbase.async

Class GetRequest

java.lang.Object

org.hbase.async.HBaseRpc

org.hbase.async.GetRequest

All Implemented Interfaces:

HBaseRpc.HasFamily, HBaseRpc.HasKey, HBaseRpc.HasQualifiers, HBaseRpc.HasTable, HBaseRpc.HasTimestamp

public final class GetRequest
extends HBaseRpc
implements HBaseRpc.HasTable, HBaseRpc.HasKey, HBaseRpc.HasFamily, HBaseRpc.HasQualifiers

Reads something from HBase.

A note on passing byte arrays in argument

None of the method that receive a byte[] in argument will copy it. For more info, please refer to the documentation of HBaseRpc.

A note on passing Strings in argument

All strings are assumed to use the platform's default charset.

Nested Class Summary

Nested classes/interfaces inherited from class org.hbase.async.HBaseRpc

HBaseRpc.HasFamily, HBaseRpc.HasKey, HBaseRpc.HasQualifier, HBaseRpc.HasQualifiers, HBaseRpc.HasTable, HBaseRpc.HasTimestamp, HBaseRpc.HasValue, HBaseRpc.HasValues

Constructor Summary

Constructors

Constructor and Description
GetRequest(byte[] table, byte[] key) Constructor.
GetRequest(byte[] table, byte[] key, byte[] family) Constructor.
GetRequest(byte[] table, byte[] key, byte[] family, byte[] qualifier) Constructor.
GetRequest(String table, byte[] key) Constructor.
GetRequest(String table, String key) Constructor.
GetRequest(String table, String key, String family) Constructor.
GetRequest(String table, String key, String family, String qualifier) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearFilter() Clears any filter that was previously set on this get request.
byte[]	family() Returns the family this RPC is for.
GetRequest	family(byte[] family) Specifies a particular column family to get.
GetRequest	family(String family) Specifies a particular column family to get.
ScanFilter	getFilter() Returns the possibly-null filter applied to cells in this row.
long	getMaxTimestamp() Returns the maximum timestamp to scan (exclusive).
long	getMinTimestamp() Returns the minimum timestamp to scan (inclusive).
byte[]	key() Returns the row key this RPC is for.
int	maxVersions() Returns the maximum number of versions to return for each cell scanned.
GetRequest	maxVersions(int versions) Sets the maximum number of versions to return for each cell read.
GetRequest	qualifier(byte[] qualifier) Specifies a particular column qualifier to get.
GetRequest	qualifier(String qualifier) Specifies a particular column qualifier to get.
byte[][]	qualifiers() Returns the column qualifiers this RPC is for.
GetRequest	qualifiers(byte[][] qualifiers) Specifies a particular set of column qualifiers to get.
void	setBufferable(boolean bufferable) Sets whether or not this RPC is can be buffered on the client side.
void	setDurable(boolean durable) Changes the durability setting of this edit.
GetRequest	setFilter(ScanFilter filter) Specifies the filter to apply to cells in this row.
GetRequest	setMaxTimestamp(long timestamp) Sets the maximum timestamp to scan (exclusive).
GetRequest	setMinTimestamp(long timestamp) Sets the minimum timestamp to scan (inclusive).
void	setServerBlockCache(boolean populate_blockcache)
GetRequest	setTimeRange(long min_timestamp, long max_timestamp) Sets the time range to scan.
byte[]	table() Returns the name of the table this RPC is for.
long	timestamp() Returns the strictly positive timestamp contained in this RPC.
String	toString()
GetRequest	withRowLock(RowLock lock) Specifies an explicit row lock to use with this request.

Methods inherited from class org.hbase.async.HBaseRpc

failfast, getTimeout, isProbe, isTraceRPC, setFailfast, setProbe, setTimeout, setTraceRPC

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hbase.async.HBaseRpc.HasFamily

family

Constructor Detail

GetRequest

public GetRequest(byte[] table,
                  byte[] key)

Constructor. These byte arrays will NOT be copied.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table.

GetRequest

public GetRequest(String table,
                  byte[] key)

Constructor.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table. This byte array will NOT be copied.

GetRequest

public GetRequest(String table,
                  String key)

Constructor.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table.

GetRequest

public GetRequest(byte[] table,
                  byte[] key,
                  byte[] family)

Constructor. These byte arrays will NOT be copied.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table.

family - The column family.

Since:

1.5

GetRequest

public GetRequest(String table,
                  String key,
                  String family)

Constructor.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table.

family - The column family.

Since:

1.5

GetRequest

public GetRequest(byte[] table,
                  byte[] key,
                  byte[] family,
                  byte[] qualifier)

Constructor. These byte arrays will NOT be copied.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table.

family - The column family.

qualifier - The column qualifier.

Since:

1.5

GetRequest

public GetRequest(String table,
                  String key,
                  String family,
                  String qualifier)

Constructor.

Parameters:

table - The non-empty name of the table to use.

key - The row key to get in that table.

family - The column family.

qualifier - The column qualifier.

Since:

1.5

Method Detail

family

public GetRequest family(byte[] family)

Specifies a particular column family to get.

Parameters:

family - The column family. This byte array will NOT be copied.

Returns:

this, always.

family

public GetRequest family(String family)

Specifies a particular column family to get.

qualifier

public GetRequest qualifier(byte[] qualifier)

Specifies a particular column qualifier to get.

Parameters:

qualifier - The column qualifier. This byte array will NOT be copied.

Returns:

this, always.

qualifiers

public GetRequest qualifiers(byte[][] qualifiers)

Specifies a particular set of column qualifiers to get.

Parameters:

qualifiers - The column qualifiers. This byte array will NOT be copied.

Returns:

this, always.

Since:

1.1

qualifier

public GetRequest qualifier(String qualifier)

Specifies a particular column qualifier to get.

withRowLock

public GetRequest withRowLock(RowLock lock)

Specifies an explicit row lock to use with this request.

maxVersions

public GetRequest maxVersions(int versions)

Sets the maximum number of versions to return for each cell read.

By default only the most recent version of each cell is read. If you want to get all possible versions available, pass Integer.MAX_VALUE in argument.

Parameters:

versions - A strictly positive number of versions to return.

Returns:

this, always.

Throws:

IllegalArgumentException - if versions <= 0

Since:

1.4

maxVersions

public int maxVersions()

Returns the maximum number of versions to return for each cell scanned.

Returns:

A strictly positive integer.

Since:

1.4

setMinTimestamp

public GetRequest setMinTimestamp(long timestamp)

Sets the minimum timestamp to scan (inclusive).

KeyValues that have a timestamp strictly less than this one will not be returned by the scanner. HBase has internal optimizations to avoid loading in memory data filtered out in some cases.

Parameters:

timestamp - The minimum timestamp to scan (inclusive).

Returns:

Throws:

IllegalArgumentException - if timestamp < 0.

IllegalArgumentException - if timestamp > getMaxTimestamp().

Since:

1.7

See Also:

setTimeRange(long, long)

getMinTimestamp

public long getMinTimestamp()

Returns the minimum timestamp to scan (inclusive).

Returns:

A positive integer.

Since:

1.7

setMaxTimestamp

public GetRequest setMaxTimestamp(long timestamp)

Sets the maximum timestamp to scan (exclusive).

KeyValues that have a timestamp greater than or equal to this one will not be returned by the scanner. HBase has internal optimizations to avoid loading in memory data filtered out in some cases.

Parameters:

timestamp - The maximum timestamp to scan (exclusive).

Returns:

Throws:

IllegalArgumentException - if timestamp < 0.

IllegalArgumentException - if timestamp < getMinTimestamp().

Since:

1.7

See Also:

setTimeRange(long, long)

getMaxTimestamp

public long getMaxTimestamp()

Returns the maximum timestamp to scan (exclusive).

Returns:

A positive integer.

Since:

1.7

setTimeRange

public GetRequest setTimeRange(long min_timestamp,
                               long max_timestamp)

Sets the time range to scan.

KeyValues that have a timestamp that do not fall in the range [min_timestamp; max_timestamp[ will not be returned by the scanner. HBase has internal optimizations to avoid loading in memory data filtered out in some cases.

Parameters:

min_timestamp - The minimum timestamp to scan (inclusive).

max_timestamp - The maximum timestamp to scan (exclusive).

Returns:

Throws:

IllegalArgumentException - if min_timestamp < 0

IllegalArgumentException - if max_timestamp < 0

IllegalArgumentException - if min_timestamp > max_timestamp

Since:

1.7

setFilter

public GetRequest setFilter(ScanFilter filter)

Specifies the filter to apply to cells in this row.

Parameters:

filter - The filter. If null, then no filter will be used.

Returns:

Since:

1.7

getFilter

public ScanFilter getFilter()

Returns the possibly-null filter applied to cells in this row.

Since:

1.7

clearFilter

public void clearFilter()

Clears any filter that was previously set on this get request.

This is a shortcut for setFilter(org.hbase.async.ScanFilter)(null)

Since:

1.7

table

public byte[] table()

Description copied from interface: HBaseRpc.HasTable

Returns the name of the table this RPC is for.

DO NOT MODIFY THE CONTENTS OF THE ARRAY RETURNED.

Specified by:

table in interface HBaseRpc.HasTable

Returns:

the name of the table this RPC is for.

key

public byte[] key()

Description copied from interface: HBaseRpc.HasKey

Returns the row key this RPC is for.

DO NOT MODIFY THE CONTENTS OF THE ARRAY RETURNED.

Specified by:

key in interface HBaseRpc.HasKey

Returns:

the row key this RPC is for.

qualifiers

public byte[][] qualifiers()

Description copied from interface: HBaseRpc.HasQualifiers

Returns the column qualifiers this RPC is for.

DO NOT MODIFY THE CONTENTS OF THE ARRAY RETURNED.

Specified by:

qualifiers in interface HBaseRpc.HasQualifiers

Returns:

the column qualifiers this RPC is for.

toString

public String toString()

Overrides:

toString in class HBaseRpc

setServerBlockCache

public void setServerBlockCache(boolean populate_blockcache)

setBufferable

public final void setBufferable(boolean bufferable)

Sets whether or not this RPC is can be buffered on the client side. The default is true.

Setting this to false bypasses the client-side buffering, which is used to send RPCs in batches for greater throughput, and causes this RPC to be sent directly to the server.

Parameters:

bufferable - Whether or not this RPC can be buffered (i.e. delayed) before being sent out to HBase.

See Also:

HBaseClient.setFlushInterval(short)

setDurable

public final void setDurable(boolean durable)

Changes the durability setting of this edit. The default is true. Make sure you've read and understood the data durability section before setting this to false.

Parameters:

durable - Whether or not this edit should be stored with data durability guarantee.

family

public final byte[] family()

Description copied from interface: HBaseRpc.HasFamily

Returns the family this RPC is for.

DO NOT MODIFY THE CONTENTS OF THE ARRAY RETURNED.

Specified by:

family in interface HBaseRpc.HasFamily

Returns:

the family this RPC is for.

timestamp

public final long timestamp()

Description copied from interface: HBaseRpc.HasTimestamp

Returns the strictly positive timestamp contained in this RPC.

Specified by:

timestamp in interface HBaseRpc.HasTimestamp

Returns:

the strictly positive timestamp contained in this RPC.