Package org.apache.hadoop.hbase.quotas

Class QuotaUtil

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaTableUtil

org.apache.hadoop.hbase.quotas.QuotaUtil

@Private
@Evolving
public class QuotaUtil
extends QuotaTableUtil

Helper class to interact with the quota table

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	QuotaUtil.KeyFromRow<T>

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.quotas.QuotaTableUtil

QuotaTableUtil.NamespaceQuotasVisitor, QuotaTableUtil.QuotasVisitor, QuotaTableUtil.TableQuotasVisitor, QuotaTableUtil.UserQuotasVisitor

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_READ_CAPACITY_UNIT
static final long	DEFAULT_WRITE_CAPACITY_UNIT
private static final org.slf4j.Logger	LOG
static final String	QUOTA_CONF_KEY
static final String	QUOTA_DEFAULT_USER_MACHINE_READ_NUM
static final String	QUOTA_DEFAULT_USER_MACHINE_READ_SIZE
static final String	QUOTA_DEFAULT_USER_MACHINE_REQUEST_NUM
static final String	QUOTA_DEFAULT_USER_MACHINE_REQUEST_SIZE
static final String	QUOTA_DEFAULT_USER_MACHINE_WRITE_NUM
static final String	QUOTA_DEFAULT_USER_MACHINE_WRITE_SIZE
private static final boolean	QUOTA_ENABLED_DEFAULT
static final HTableDescriptor	QUOTA_TABLE_DESC	Table descriptor for Quota internal table
static final String	READ_CAPACITY_UNIT_CONF_KEY
static final String	WRITE_CAPACITY_UNIT_CONF_KEY

Fields inherited from class org.apache.hadoop.hbase.quotas.QuotaTableUtil

QUOTA_FAMILY_INFO, QUOTA_FAMILY_USAGE, QUOTA_NAMESPACE_ROW_KEY_PREFIX, QUOTA_POLICY_COLUMN, QUOTA_QUALIFIER_POLICY, QUOTA_QUALIFIER_SETTINGS, QUOTA_QUALIFIER_SETTINGS_PREFIX, QUOTA_REGION_SERVER_ROW_KEY, QUOTA_REGION_SERVER_ROW_KEY_PREFIX, QUOTA_SNAPSHOT_SIZE_QUALIFIER, QUOTA_TABLE_NAME, QUOTA_TABLE_ROW_KEY_PREFIX, QUOTA_USER_ROW_KEY_PREFIX

Constructor Summary

Constructors

Constructor	Description
QuotaUtil()

Method Summary

Modifier and Type	Method	Description
static void	addNamespaceQuota(Connection connection, String namespace, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
private static void	addQuotas(Connection connection, byte[] rowKey, byte[] qualifier, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
private static void	addQuotas(Connection connection, byte[] rowKey, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
static void	addRegionServerQuota(Connection connection, String regionServer, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
static void	addTableQuota(Connection connection, TableName table, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
static void	addUserQuota(Connection connection, String user, String namespace, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
static void	addUserQuota(Connection connection, String user, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
static void	addUserQuota(Connection connection, String user, TableName table, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
private static Optional<org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota>	buildDefaultTimedQuota(org.apache.hadoop.conf.Configuration conf, String key)
protected static UserQuotaState	buildDefaultUserQuotaState(org.apache.hadoop.conf.Configuration conf, long nowTs)
static long	calculateMutationSize(Mutation mutation)
static long	calculateResultSize(List<Result> results)
static long	calculateResultSize(Result result)
private static void	checkRSQuotaToEnableExceedThrottle(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotas)
static void	deleteNamespaceQuota(Connection connection, String namespace)
private static void	deleteQuotas(Connection connection, byte[] rowKey)
private static void	deleteQuotas(Connection connection, byte[] rowKey, byte[] qualifier)
static void	deleteRegionServerQuota(Connection connection, String regionServer)
static void	deleteTableQuota(Connection connection, TableName table)
static void	deleteUserQuota(Connection connection, String user)
static void	deleteUserQuota(Connection connection, String user, String namespace)
static void	deleteUserQuota(Connection connection, String user, TableName table)
static void	disableTableIfNotDisabled(Connection conn, TableName tableName)	Method to disable a table, if not already disabled.
private static void	doDelete(Connection connection, Delete delete)
private static void	doPut(Connection connection, Put put)
static void	enableTableIfNotEnabled(Connection conn, TableName tableName)	Method to enable a table, if not already enabled.
static <K> Map<K,QuotaState>	fetchGlobalQuotas(String type, Connection connection, List<Get> gets, QuotaUtil.KeyFromRow<K> kfr)
static Map<String,QuotaState>	fetchNamespaceQuotas(Connection connection, List<Get> gets, double factor)
static Map<String,QuotaState>	fetchRegionServerQuotas(Connection connection, List<Get> gets)
static Map<TableName,QuotaState>	fetchTableQuotas(Connection connection, List<Get> gets, Map<TableName,Double> tableMachineFactors)
static Map<String,UserQuotaState>	fetchUserQuotas(Connection connection, List<Get> gets, Map<TableName,Double> tableMachineQuotaFactors, double factor)
static OperationQuota.OperationType	getQuotaOperationType(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Action action, boolean hasCondition)
static OperationQuota.OperationType	getQuotaOperationType(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.MutateRequest mutateRequest)
private static OperationQuota.OperationType	getQuotaOperationType(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.MutationProto mutationProto, boolean hasCondition)
protected static boolean	isExceedThrottleQuotaEnabled(Connection connection)
static boolean	isQuotaEnabled(org.apache.hadoop.conf.Configuration conf)	Returns true if the support for quota is enabled
protected static void	switchExceedThrottleQuota(Connection connection, boolean exceedThrottleQuotaEnabled)
private static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	updateClusterQuotaToMachineQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotas, double factor)	Convert cluster scope quota to machine scope quota
private static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota	updateTimedQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota, double factor)

Methods inherited from class org.apache.hadoop.hbase.quotas.QuotaTableUtil

createDeletesForExistingNamespaceSnapshotSizes, createDeletesForExistingNamespaceSnapshotSizes, createDeletesForExistingSnapshotsFromScan, createDeletesForExistingTableSnapshotSizes, createDeletesForExistingTableSnapshotSizes, createGetNamespaceSnapshotSize, createPutForNamespaceSnapshotSize, createPutForSnapshotSize, createPutForSpaceSnapshot, createScanForNamespaceSnapshotSizes, createScanForNamespaceSnapshotSizes, createScanForSpaceSnapshotSizes, createScanForSpaceSnapshotSizes, deleteTableUsageSnapshotsForNamespace, doGet, doGet, extractQuotaSnapshot, extractSnapshotNameFromSizeCell, extractSnapshotSize, getCurrentSnapshotFromQuotaTable, getExceedThrottleQuotaRowKey, getNamespaceFromRowKey, getNamespaceQuota, getNamespaceRowKey, getNamespaceRowKeyRegex, getNamespaceSnapshots, getNamespaceSnapshotSize, getObservedSnapshotSizes, getProtoViolationPolicy, getRegionServerFromRowKey, getRegionServerQuota, getRegionServerRowKey, getSettingsQualifierForUserNamespace, getSettingsQualifierForUserTable, getSettingsQualifierRegexForUserNamespace, getSettingsQualifierRegexForUserTable, getSnapshots, getSnapshotSizeQualifier, getTableFromRowKey, getTableQuota, getTableRowKey, getTableRowKeyRegex, getTableSnapshots, getUserFromRowKey, getUserQuota, getUserQuota, getUserQuota, getUserRowKey, getUserRowKeyRegex, getViolationPolicy, isEmptyQuota, isNamespaceRowKey, isRegionServerRowKey, isTableRowKey, isUserRowKey, makeFilter, makeGetForNamespaceQuotas, makeGetForRegionServerQuotas, makeGetForSnapshotSize, makeGetForTableQuotas, makeGetForUserQuotas, makeQuotaSnapshotGetForTable, makeQuotaSnapshotScan, makeQuotaSnapshotScanForTable, makeScan, parseNamespaceResult, parseNamespaceResult, parseResult, parseResultToCollection, parseSnapshotSize, parseTableResult, parseTableResult, parseUserResult, parseUserResult, quotasFromData, quotasFromData, quotasToData

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

QUOTA_CONF_KEY

public static final String QUOTA_CONF_KEY

See Also:

• Constant Field Values

QUOTA_ENABLED_DEFAULT

private static final boolean QUOTA_ENABLED_DEFAULT

See Also:

• Constant Field Values

READ_CAPACITY_UNIT_CONF_KEY

public static final String READ_CAPACITY_UNIT_CONF_KEY

See Also:

• Constant Field Values

DEFAULT_READ_CAPACITY_UNIT

public static final long DEFAULT_READ_CAPACITY_UNIT

See Also:

• Constant Field Values

WRITE_CAPACITY_UNIT_CONF_KEY

public static final String WRITE_CAPACITY_UNIT_CONF_KEY

See Also:

• Constant Field Values

DEFAULT_WRITE_CAPACITY_UNIT

public static final long DEFAULT_WRITE_CAPACITY_UNIT

See Also:

• Constant Field Values

QUOTA_DEFAULT_USER_MACHINE_READ_NUM

public static final String QUOTA_DEFAULT_USER_MACHINE_READ_NUM

See Also:

• Constant Field Values

QUOTA_DEFAULT_USER_MACHINE_READ_SIZE

public static final String QUOTA_DEFAULT_USER_MACHINE_READ_SIZE

See Also:

• Constant Field Values

QUOTA_DEFAULT_USER_MACHINE_REQUEST_NUM

public static final String QUOTA_DEFAULT_USER_MACHINE_REQUEST_NUM

See Also:

• Constant Field Values

QUOTA_DEFAULT_USER_MACHINE_REQUEST_SIZE

public static final String QUOTA_DEFAULT_USER_MACHINE_REQUEST_SIZE

See Also:

• Constant Field Values

QUOTA_DEFAULT_USER_MACHINE_WRITE_NUM

public static final String QUOTA_DEFAULT_USER_MACHINE_WRITE_NUM

See Also:

• Constant Field Values

QUOTA_DEFAULT_USER_MACHINE_WRITE_SIZE

public static final String QUOTA_DEFAULT_USER_MACHINE_WRITE_SIZE

See Also:

• Constant Field Values

QUOTA_TABLE_DESC

public static final HTableDescriptor QUOTA_TABLE_DESC

Table descriptor for Quota internal table

Constructor Details

QuotaUtil

public QuotaUtil()

Method Details

isQuotaEnabled

public static boolean isQuotaEnabled(org.apache.hadoop.conf.Configuration conf)

Returns true if the support for quota is enabled

addTableQuota

public static void addTableQuota(Connection connection,
 TableName table,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                          throws IOException

Throws:

IOException

deleteTableQuota

public static void deleteTableQuota(Connection connection,
 TableName table)
                             throws IOException

Throws:

IOException

addNamespaceQuota

public static void addNamespaceQuota(Connection connection,
 String namespace,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                              throws IOException

Throws:

IOException

deleteNamespaceQuota

public static void deleteNamespaceQuota(Connection connection,
 String namespace)
                                 throws IOException

Throws:

IOException

addUserQuota

public static void addUserQuota(Connection connection,
 String user,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                         throws IOException

Throws:

IOException

addUserQuota

public static void addUserQuota(Connection connection,
 String user,
 TableName table,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                         throws IOException

Throws:

IOException

addUserQuota

public static void addUserQuota(Connection connection,
 String user,
 String namespace,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                         throws IOException

Throws:

IOException

deleteUserQuota

public static void deleteUserQuota(Connection connection,
 String user)
                            throws IOException

Throws:

IOException

deleteUserQuota

public static void deleteUserQuota(Connection connection,
 String user,
 TableName table)
                            throws IOException

Throws:

IOException

deleteUserQuota

public static void deleteUserQuota(Connection connection,
 String user,
 String namespace)
                            throws IOException

Throws:

IOException

addRegionServerQuota

public static void addRegionServerQuota(Connection connection,
 String regionServer,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                                 throws IOException

Throws:

IOException

deleteRegionServerQuota

public static void deleteRegionServerQuota(Connection connection,
 String regionServer)
                                    throws IOException

Throws:

IOException

getQuotaOperationType

public static OperationQuota.OperationType getQuotaOperationType(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Action action,
 boolean hasCondition)

getQuotaOperationType

public static OperationQuota.OperationType getQuotaOperationType(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.MutateRequest mutateRequest)

getQuotaOperationType

private static OperationQuota.OperationType getQuotaOperationType(org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.MutationProto mutationProto,
 boolean hasCondition)

switchExceedThrottleQuota

protected static void switchExceedThrottleQuota(Connection connection,
 boolean exceedThrottleQuotaEnabled)
                                         throws IOException

Throws:

IOException

checkRSQuotaToEnableExceedThrottle

private static void checkRSQuotaToEnableExceedThrottle(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotas)
                                                throws IOException

Throws:

IOException

isExceedThrottleQuotaEnabled

protected static boolean isExceedThrottleQuotaEnabled(Connection connection)
                                               throws IOException

Throws:

IOException

addQuotas

private static void addQuotas(Connection connection,
 byte[] rowKey,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                       throws IOException

Throws:

IOException

addQuotas

private static void addQuotas(Connection connection,
 byte[] rowKey,
 byte[] qualifier,
 org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                       throws IOException

Throws:

IOException

deleteQuotas

private static void deleteQuotas(Connection connection,
 byte[] rowKey)
                          throws IOException

Throws:

IOException

deleteQuotas

private static void deleteQuotas(Connection connection,
 byte[] rowKey,
 byte[] qualifier)
                          throws IOException

Throws:

IOException

fetchUserQuotas

public static Map<String,UserQuotaState> fetchUserQuotas(Connection connection,
 List<Get> gets,
 Map<TableName,Double> tableMachineQuotaFactors,
 double factor)
                                                  throws IOException

Throws:

IOException

buildDefaultUserQuotaState

protected static UserQuotaState buildDefaultUserQuotaState(org.apache.hadoop.conf.Configuration conf,
 long nowTs)

buildDefaultTimedQuota

private static Optional<org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota> buildDefaultTimedQuota(org.apache.hadoop.conf.Configuration conf,
 String key)

fetchTableQuotas

public static Map<TableName,QuotaState> fetchTableQuotas(Connection connection,
 List<Get> gets,
 Map<TableName,Double> tableMachineFactors)
                                                  throws IOException

Throws:

IOException

fetchNamespaceQuotas

public static Map<String,QuotaState> fetchNamespaceQuotas(Connection connection,
 List<Get> gets,
 double factor)
                                                   throws IOException

Throws:

IOException

fetchRegionServerQuotas

public static Map<String,QuotaState> fetchRegionServerQuotas(Connection connection,
 List<Get> gets)
                                                      throws IOException

Throws:

IOException

fetchGlobalQuotas

public static <K> Map<K,QuotaState> fetchGlobalQuotas(String type,
 Connection connection,
 List<Get> gets,
 QuotaUtil.KeyFromRow<K> kfr)
                                               throws IOException

Throws:

IOException

updateClusterQuotaToMachineQuota

private static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas updateClusterQuotaToMachineQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotas,
 double factor)

Convert cluster scope quota to machine scope quota

Parameters:

quotas - the original quota

factor - factor used to divide cluster limiter to machine limiter

Returns:

the converted quota whose quota limiters all in machine scope

updateTimedQuota

private static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota updateTimedQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota,
 double factor)

doPut

private static void doPut(Connection connection,
 Put put)
                   throws IOException

Throws:

IOException

doDelete

private static void doDelete(Connection connection,
 Delete delete)
                      throws IOException

Throws:

IOException

calculateMutationSize

public static long calculateMutationSize(Mutation mutation)

calculateResultSize

public static long calculateResultSize(Result result)

calculateResultSize

public static long calculateResultSize(List<Result> results)

enableTableIfNotEnabled

public static void enableTableIfNotEnabled(Connection conn,
 TableName tableName)
                                    throws IOException

Method to enable a table, if not already enabled. This method suppresses TableNotDisabledException and TableNotFoundException, if thrown while enabling the table.

Parameters:

conn - connection to re-use

tableName - name of the table to be enabled

Throws:

IOException

disableTableIfNotDisabled

public static void disableTableIfNotDisabled(Connection conn,
 TableName tableName)
                                      throws IOException

Method to disable a table, if not already disabled. This method suppresses TableNotEnabledException, if thrown while disabling the table.

Parameters:

conn - connection to re-use

tableName - table name which has moved into space quota violation

Throws:

IOException