org.apache.hadoop.hbase.quotas

Class QuotaUtil

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaTableUtil

org.apache.hadoop.hbase.quotas.QuotaUtil

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class QuotaUtil
extends QuotaTableUtil

Helper class to interact with the quota table

Nested Class Summary

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 and Description
static long	DEFAULT_READ_CAPACITY_UNIT
static long	DEFAULT_WRITE_CAPACITY_UNIT
static String	QUOTA_CONF_KEY
static HTableDescriptor	QUOTA_TABLE_DESC Table descriptor for Quota internal table
static String	READ_CAPACITY_UNIT_CONF_KEY
static 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 and Description
QuotaUtil()

Method Summary

Modifier and Type	Method and Description
static void	addNamespaceQuota(Connection connection, String namespace, 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, 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, TableName table, org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
static long	calculateMutationSize(Mutation mutation)
static long	calculateResultSize(List<Result> results)
static long	calculateResultSize(Result result)
static void	deleteNamespaceQuota(Connection connection, String namespace)
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.
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, org.apache.hadoop.hbase.quotas.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)
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)

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

doGet, doGet, extractQuotaSnapshot, extractSnapshotNameFromSizeCell, extractSnapshotSize, getCurrentSnapshotFromQuotaTable, getExceedThrottleQuotaRowKey, getNamespaceFromRowKey, getNamespaceQuota, getNamespaceRowKey, getNamespaceRowKeyRegex, getNamespaceSnapshots, 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, makeGetForTableQuotas, makeGetForUserQuotas, makeQuotaSnapshotGetForTable, makeQuotaSnapshotScan, makeQuotaSnapshotScanForTable, makeScan, parseNamespaceResult, parseNamespaceResult, parseResult, parseResultToCollection, 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 Detail

QUOTA_CONF_KEY

public static final String QUOTA_CONF_KEY

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_TABLE_DESC

public static final HTableDescriptor QUOTA_TABLE_DESC

Table descriptor for Quota internal table

Constructor Detail

QuotaUtil

public QuotaUtil()

Method Detail

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

switchExceedThrottleQuota

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

Throws:

IOException

isExceedThrottleQuotaEnabled

protected static boolean isExceedThrottleQuotaEnabled(Connection connection)
                                               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

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,
                                                      org.apache.hadoop.hbase.quotas.QuotaUtil.KeyFromRow<K> kfr)
                                               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