org.apache.hadoop.hbase.quotas

Interface OperationQuota

All Known Implementing Classes:

DefaultOperationQuota

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public interface OperationQuota

Interface that allows to check the quota available for an operation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OperationQuota.AvgOperationSize Keeps track of the average data size of operations like get, scan, mutate
static class	OperationQuota.OperationType

Method Summary

Modifier and Type	Method and Description
void	addGetResult(Result result) Add a get result.
void	addMutation(Mutation mutation) Add a mutation result.
void	addScanResult(List<Result> results) Add a scan result.
void	checkQuota(int numWrites, int numReads, int numScans) Checks if it is possible to execute the specified operation.
void	close() Cleanup method on operation completion
long	getAvgOperationSize(OperationQuota.OperationType type)
long	getReadAvailable()
long	getWriteAvailable()

Method Detail

checkQuota

void checkQuota(int numWrites,
                int numReads,
                int numScans)
         throws ThrottlingException

Checks if it is possible to execute the specified operation. The quota will be estimated based on the number of operations to perform and the average size accumulated during time.

Parameters:

numWrites - number of write operation that will be performed

numReads - number of small-read operation that will be performed

numScans - number of long-read operation that will be performed

Throws:

ThrottlingException - if the operation cannot be performed

close

void close()

Cleanup method on operation completion

addGetResult

void addGetResult(Result result)

Add a get result. This will be used to calculate the exact quota and have a better short-read average size for the next time.

addScanResult

void addScanResult(List<Result> results)

Add a scan result. This will be used to calculate the exact quota and have a better long-read average size for the next time.

addMutation

void addMutation(Mutation mutation)

Add a mutation result. This will be used to calculate the exact quota and have a better mutation average size for the next time.

getReadAvailable

long getReadAvailable()

Returns:

the number of bytes available to read to avoid exceeding the quota

getWriteAvailable

long getWriteAvailable()

Returns:

the number of bytes available to write to avoid exceeding the quota

getAvgOperationSize

long getAvgOperationSize(OperationQuota.OperationType type)

Returns:

the average data size of the specified operation