QuotaUtil (Apache HBase 1.2.12 API)

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
Modifier and Type Class and 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

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

Field Summary

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`
`static String`	`QUOTA_CONF_KEY`
`private static boolean`	`QUOTA_ENABLED_DEFAULT`
`static HTableDescriptor`	`QUOTA_TABLE_DESC` Table descriptor for Quota internal table

Fields inherited from class org.apache.hadoop.hbase.quotas.QuotaTableUtil
QUOTA_FAMILY_INFO, QUOTA_FAMILY_USAGE, QUOTA_NAMESPACE_ROW_KEY_PREFIX, QUOTA_QUALIFIER_SETTINGS, QUOTA_QUALIFIER_SETTINGS_PREFIX, QUOTA_TABLE_NAME, QUOTA_TABLE_ROW_KEY_PREFIX, QUOTA_USER_ROW_KEY_PREFIX

Constructor Summary

Constructors
Constructor and Description

QuotaUtil()

Constructors
Constructor and Description
`QuotaUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addNamespaceQuota(Connection connection, String namespace, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas data)`
`private static void`	`addQuotas(Connection connection, byte[] rowKey, byte[] qualifier, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas data)`
`private static void`	`addQuotas(Connection connection, byte[] rowKey, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas data)`
`static void`	`addTableQuota(Connection connection, TableName table, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas data)`
`static void`	`addUserQuota(Connection connection, String user, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas data)`
`static void`	`addUserQuota(Connection connection, String user, String namespace, org.apache.hadoop.hbase.protobuf.generated.QuotaProtos.Quotas data)`
`static void`	`addUserQuota(Connection connection, String user, TableName table, org.apache.hadoop.hbase.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)`
`private static void`	`deleteQuotas(Connection connection, byte[] rowKey)`
`private static void`	`deleteQuotas(Connection connection, byte[] rowKey, byte[] qualifier)`
`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)`
`private static void`	`doDelete(Connection connection, Delete delete)`
`private static void`	`doPut(Connection connection, Put put)`
`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)`
`static Map<TableName,QuotaState>`	`fetchTableQuotas(Connection connection, List<Get> gets)`
`static Map<String,UserQuotaState>`	`fetchUserQuotas(Connection connection, List<Get> gets)`
`static boolean`	`isQuotaEnabled(org.apache.hadoop.conf.Configuration conf)` Returns true if the support for quota is enabled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.apache.commons.logging.Log 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

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.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.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.protobuf.generated.QuotaProtos.Quotas data)
                         throws IOException

Throws:: IOException

addUserQuota

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

Throws:: IOException

addUserQuota

public static void addUserQuota(Connection connection,
                String user,
                String namespace,
                org.apache.hadoop.hbase.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

addQuotas

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

Throws:: IOException

addQuotas

private static void addQuotas(Connection connection,
             byte[] rowKey,
             byte[] qualifier,
             org.apache.hadoop.hbase.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)
                                                  throws IOException

Throws:: IOException

fetchTableQuotas

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

Throws:: IOException

fetchNamespaceQuotas

public static Map<String,QuotaState> fetchNamespaceQuotas(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

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)

Class QuotaUtil

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LOG

QUOTA_CONF_KEY

QUOTA_ENABLED_DEFAULT

QUOTA_TABLE_DESC

Constructor Detail

QuotaUtil

Method Detail

isQuotaEnabled

addTableQuota

deleteTableQuota

addNamespaceQuota

deleteNamespaceQuota

addUserQuota

addUserQuota

addUserQuota

deleteUserQuota

deleteUserQuota

deleteUserQuota

addQuotas

addQuotas

deleteQuotas

deleteQuotas

fetchUserQuotas

fetchTableQuotas

fetchNamespaceQuotas

fetchGlobalQuotas

doPut

doDelete

calculateMutationSize

calculateResultSize

calculateResultSize