org.apache.hadoop.hbase.quotas

Class QuotaTableUtil

java.lang.Object

org.apache.hadoop.hbase.quotas.QuotaTableUtil

Direct Known Subclasses:

QuotaUtil

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

Helper class to interact with the quota table.

Nested Class Summary

ROW-KEY	FAM/QUAL	DATA
n.<namespace>	q:s	<global-quotas>
n.<namespace>	u:p	<namespace-quota policy>
n.<namespace>	u:s	<SpaceQuotaSnapshot>
t.<table>	q:s	<global-quotas>
t.<table>	u:p	<table-quota policy>
t.<table>	u:ss.<snapshot name>	<SpaceQuotaSnapshot>
u.<user>	q:s	<global-quotas>
u.<user>	q:s.<table>	<table-quotas>
u.<user>	q:s.<ns>	<namespace-quotas>

Nested Classes

Modifier and Type	Class and Description
static interface	QuotaTableUtil.NamespaceQuotasVisitor
static interface	QuotaTableUtil.QuotasVisitor
static interface	QuotaTableUtil.TableQuotasVisitor
static interface	QuotaTableUtil.UserQuotasVisitor

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
protected static byte[]	QUOTA_FAMILY_INFO
protected static byte[]	QUOTA_FAMILY_USAGE
protected static byte[]	QUOTA_NAMESPACE_ROW_KEY_PREFIX
protected static String	QUOTA_POLICY_COLUMN
protected static byte[]	QUOTA_QUALIFIER_POLICY
protected static byte[]	QUOTA_QUALIFIER_SETTINGS
protected static byte[]	QUOTA_QUALIFIER_SETTINGS_PREFIX
protected static byte[]	QUOTA_SNAPSHOT_SIZE_QUALIFIER
static TableName	QUOTA_TABLE_NAME System table for quotas
protected static byte[]	QUOTA_TABLE_ROW_KEY_PREFIX
protected static byte[]	QUOTA_USER_ROW_KEY_PREFIX

Constructor Summary

Constructors

Constructor and Description
QuotaTableUtil()

Method Summary

Modifier and Type	Method and Description
(package private) static Get	createGetNamespaceSnapshotSize(String namespace) Creates a Get to fetch the namespace's total snapshot size.
(package private) static Put	createPutForNamespaceSnapshotSize(String namespace, long size) Creates a Put for the namespace's total snapshot size.
(package private) static Put	createPutForSnapshotSize(TableName tableName, String snapshot, long size) Creates a Put to persist the current size of the snapshot with respect to the given table.
(package private) static Put	createPutForSpaceSnapshot(TableName tableName, SpaceQuotaSnapshot snapshot) Creates a Put to store the given snapshot for the given tableName in the quota table.
(package private) static Scan	createScanForSpaceSnapshotSizes()
(package private) static Scan	createScanForSpaceSnapshotSizes(TableName table)
protected static Result	doGet(Connection connection, Get get)
protected static Result[]	doGet(Connection connection, List<Get> gets)
static void	extractQuotaSnapshot(Result result, Map<TableName,SpaceQuotaSnapshot> snapshots) Extracts the SpaceViolationPolicy and TableName from the provided Result and adds them to the given Map.
protected static String	extractSnapshotNameFromSizeCell(Cell c)
protected static long	extractSnapshotSize(byte[] data, int offset, int length)
static SpaceQuotaSnapshot	getCurrentSnapshot(Connection conn, String namespace) Returns the Master's view of a quota on the given namespace or null if the Master has no quota information on that namespace.
static SpaceQuotaSnapshot	getCurrentSnapshot(Connection conn, TableName tn) Returns the Master's view of a quota on the given tableName or null if the Master has no quota information on that table.
static SpaceQuotaSnapshot	getCurrentSnapshotFromQuotaTable(Connection conn, TableName tableName) Returns the current space quota snapshot of the given tableName from QuotaTableUtil.QUOTA_TABLE_NAME or null if the no quota information is available for that tableName.
static Map<TableName,Long>	getMasterReportedTableSizes(Connection conn) Fetches the table sizes on the filesystem as tracked by the HBase Master.
protected static String	getNamespaceFromRowKey(byte[] key)
static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getNamespaceQuota(Connection connection, String namespace)
protected static byte[]	getNamespaceRowKey(String namespace)
protected static String	getNamespaceRowKeyRegex(String namespace)
(package private) static long	getNamespaceSnapshotSize(Connection conn, String namespace) Fetches the computed size of all snapshots against tables in a namespace for space quotas.
static Map<String,Long>	getObservedSnapshotSizes(Connection conn) Fetches any persisted HBase snapshot sizes stored in the quota table.
protected static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota	getProtoViolationPolicy(SpaceViolationPolicy policy)
private static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getQuotas(Connection connection, byte[] rowKey)
private static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getQuotas(Connection connection, byte[] rowKey, byte[] qualifier)
static Map<TableName,SpaceQuotaSnapshot>	getRegionServerQuotaSnapshots(Connection conn, ServerName regionServer) Fetches the observed SpaceQuotaSnapshots observed by a RegionServer.
private static String	getRowKeyRegEx(byte[] prefix, String regex)
protected static byte[]	getSettingsQualifierForUserNamespace(String namespace)
protected static byte[]	getSettingsQualifierForUserTable(TableName tableName)
protected static String	getSettingsQualifierRegexForUserNamespace(String namespace)
protected static String	getSettingsQualifierRegexForUserTable(String table)
static Map<TableName,SpaceQuotaSnapshot>	getSnapshots(Connection conn) Fetches all SpaceQuotaSnapshot objects from the hbase:quota table.
protected static byte[]	getSnapshotSizeQualifier(String snapshotName)
protected static TableName	getTableFromRowKey(byte[] key)
static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getTableQuota(Connection connection, TableName table)
protected static byte[]	getTableRowKey(TableName table)
protected static String	getTableRowKeyRegex(String table)
protected static String	getUserFromRowKey(byte[] key)
static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getUserQuota(Connection connection, String user)
static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getUserQuota(Connection connection, String user, String namespace)
static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	getUserQuota(Connection connection, String user, TableName table)
protected static byte[]	getUserRowKey(String user)
protected static String	getUserRowKeyRegex(String user)
protected static SpaceViolationPolicy	getViolationPolicy(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota proto)
static boolean	isEmptyQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotas)
protected static boolean	isNamespaceRowKey(byte[] key)
protected static boolean	isTableRowKey(byte[] key)
protected static boolean	isUserRowKey(byte[] key)
static Filter	makeFilter(QuotaFilter filter) converts quotafilter to serializeable filterlists.
static Get	makeGetForNamespaceQuotas(String namespace)
(package private) static Get	makeGetForSnapshotSize(TableName tn, String snapshot) Creates a Get for the HBase snapshot's size against the given table.
static Get	makeGetForTableQuotas(TableName table)
static Get	makeGetForUserQuotas(String user, Iterable<TableName> tables, Iterable<String> namespaces)
static Get	makeQuotaSnapshotGetForTable(TableName tn) Creates a Get which returns only SpaceQuotaSnapshot from the quota table for a specific table.
static Scan	makeQuotaSnapshotScan() Creates a Scan which returns only quota snapshots from the quota table.
static Scan	makeQuotaSnapshotScanForTable(TableName tn) Creates a Scan which returns only SpaceQuotaSnapshot from the quota table for a specific table.
static Scan	makeScan(QuotaFilter filter)
static void	parseNamespaceResult(Result result, QuotaTableUtil.NamespaceQuotasVisitor visitor)
protected static void	parseNamespaceResult(String namespace, Result result, QuotaTableUtil.NamespaceQuotasVisitor visitor)
static void	parseResult(Result result, QuotaTableUtil.QuotasVisitor visitor)
static void	parseResultToCollection(Result result, Collection<QuotaSettings> quotaSettings)
(package private) static long	parseSnapshotSize(Cell c) Parses the snapshot size from the given Cell's value.
static void	parseTableResult(Result result, QuotaTableUtil.TableQuotasVisitor visitor)
protected static void	parseTableResult(TableName table, Result result, QuotaTableUtil.TableQuotasVisitor visitor)
static void	parseUserResult(Result result, QuotaTableUtil.UserQuotasVisitor visitor)
protected static void	parseUserResult(String userName, Result result, QuotaTableUtil.UserQuotasVisitor visitor)
protected static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	quotasFromData(byte[] data)
protected static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas	quotasFromData(byte[] data, int offset, int length)
protected static byte[]	quotasToData(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)

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.slf4j.Logger LOG

QUOTA_TABLE_NAME

public static final TableName QUOTA_TABLE_NAME

System table for quotas

QUOTA_FAMILY_INFO

protected static final byte[] QUOTA_FAMILY_INFO

QUOTA_FAMILY_USAGE

protected static final byte[] QUOTA_FAMILY_USAGE

QUOTA_QUALIFIER_SETTINGS

protected static final byte[] QUOTA_QUALIFIER_SETTINGS

QUOTA_QUALIFIER_SETTINGS_PREFIX

protected static final byte[] QUOTA_QUALIFIER_SETTINGS_PREFIX

QUOTA_QUALIFIER_POLICY

protected static final byte[] QUOTA_QUALIFIER_POLICY

QUOTA_SNAPSHOT_SIZE_QUALIFIER

protected static final byte[] QUOTA_SNAPSHOT_SIZE_QUALIFIER

QUOTA_POLICY_COLUMN

protected static final String QUOTA_POLICY_COLUMN

QUOTA_USER_ROW_KEY_PREFIX

protected static final byte[] QUOTA_USER_ROW_KEY_PREFIX

QUOTA_TABLE_ROW_KEY_PREFIX

protected static final byte[] QUOTA_TABLE_ROW_KEY_PREFIX

QUOTA_NAMESPACE_ROW_KEY_PREFIX

protected static final byte[] QUOTA_NAMESPACE_ROW_KEY_PREFIX

Constructor Detail

QuotaTableUtil

public QuotaTableUtil()

Method Detail

getTableQuota

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

Throws:

IOException

getNamespaceQuota

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

Throws:

IOException

getUserQuota

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

Throws:

IOException

getUserQuota

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

Throws:

IOException

getUserQuota

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

Throws:

IOException

getQuotas

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

Throws:

IOException

getQuotas

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

Throws:

IOException

makeGetForTableQuotas

public static Get makeGetForTableQuotas(TableName table)

makeGetForNamespaceQuotas

public static Get makeGetForNamespaceQuotas(String namespace)

makeGetForUserQuotas

public static Get makeGetForUserQuotas(String user,
                                       Iterable<TableName> tables,
                                       Iterable<String> namespaces)

makeScan

public static Scan makeScan(QuotaFilter filter)

makeFilter

public static Filter makeFilter(QuotaFilter filter)

converts quotafilter to serializeable filterlists.

makeQuotaSnapshotScan

public static Scan makeQuotaSnapshotScan()

Creates a Scan which returns only quota snapshots from the quota table.

getSnapshots

public static Map<TableName,SpaceQuotaSnapshot> getSnapshots(Connection conn)
                                                      throws IOException

Fetches all SpaceQuotaSnapshot objects from the hbase:quota table.

Parameters:

conn - The HBase connection

Returns:

A map of table names and their computed snapshot.

Throws:

IOException

makeQuotaSnapshotScanForTable

public static Scan makeQuotaSnapshotScanForTable(TableName tn)

Creates a Scan which returns only SpaceQuotaSnapshot from the quota table for a specific table.

Parameters:

tn - Optionally, a table name to limit the scan's rowkey space. Can be null.

makeQuotaSnapshotGetForTable

public static Get makeQuotaSnapshotGetForTable(TableName tn)

Creates a Get which returns only SpaceQuotaSnapshot from the quota table for a specific table.

Parameters:

tn - table name to get from. Can't be null.

extractQuotaSnapshot

public static void extractQuotaSnapshot(Result result,
                                        Map<TableName,SpaceQuotaSnapshot> snapshots)

Extracts the SpaceViolationPolicy and TableName from the provided Result and adds them to the given Map. If the result does not contain the expected information or the serialized policy in the value is invalid, this method will throw an IllegalArgumentException.

Parameters:

result - A row from the quota table.

snapshots - A map of snapshots to add the result of this method into.

parseResult

public static void parseResult(Result result,
                               QuotaTableUtil.QuotasVisitor visitor)
                        throws IOException

Throws:

IOException

parseResultToCollection

public static void parseResultToCollection(Result result,
                                           Collection<QuotaSettings> quotaSettings)
                                    throws IOException

Throws:

IOException

parseNamespaceResult

public static void parseNamespaceResult(Result result,
                                        QuotaTableUtil.NamespaceQuotasVisitor visitor)
                                 throws IOException

Throws:

IOException

parseNamespaceResult

protected static void parseNamespaceResult(String namespace,
                                           Result result,
                                           QuotaTableUtil.NamespaceQuotasVisitor visitor)
                                    throws IOException

Throws:

IOException

parseTableResult

public static void parseTableResult(Result result,
                                    QuotaTableUtil.TableQuotasVisitor visitor)
                             throws IOException

Throws:

IOException

parseTableResult

protected static void parseTableResult(TableName table,
                                       Result result,
                                       QuotaTableUtil.TableQuotasVisitor visitor)
                                throws IOException

Throws:

IOException

parseUserResult

public static void parseUserResult(Result result,
                                   QuotaTableUtil.UserQuotasVisitor visitor)
                            throws IOException

Throws:

IOException

parseUserResult

protected static void parseUserResult(String userName,
                                      Result result,
                                      QuotaTableUtil.UserQuotasVisitor visitor)
                               throws IOException

Throws:

IOException

createPutForSpaceSnapshot

static Put createPutForSpaceSnapshot(TableName tableName,
                                     SpaceQuotaSnapshot snapshot)

Creates a Put to store the given snapshot for the given tableName in the quota table.

makeGetForSnapshotSize

static Get makeGetForSnapshotSize(TableName tn,
                                  String snapshot)

Creates a Get for the HBase snapshot's size against the given table.

createPutForSnapshotSize

static Put createPutForSnapshotSize(TableName tableName,
                                    String snapshot,
                                    long size)

Creates a Put to persist the current size of the snapshot with respect to the given table.

createPutForNamespaceSnapshotSize

static Put createPutForNamespaceSnapshotSize(String namespace,
                                             long size)

Creates a Put for the namespace's total snapshot size.

getNamespaceSnapshotSize

static long getNamespaceSnapshotSize(Connection conn,
                                     String namespace)
                              throws IOException

Fetches the computed size of all snapshots against tables in a namespace for space quotas.

Throws:

IOException

createGetNamespaceSnapshotSize

static Get createGetNamespaceSnapshotSize(String namespace)

Creates a Get to fetch the namespace's total snapshot size.

parseSnapshotSize

static long parseSnapshotSize(Cell c)
                       throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException

Parses the snapshot size from the given Cell's value.

Throws:

org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException

createScanForSpaceSnapshotSizes

static Scan createScanForSpaceSnapshotSizes()

createScanForSpaceSnapshotSizes

static Scan createScanForSpaceSnapshotSizes(TableName table)

getObservedSnapshotSizes

public static Map<String,Long> getObservedSnapshotSizes(Connection conn)
                                                 throws IOException

Fetches any persisted HBase snapshot sizes stored in the quota table. The sizes here are computed relative to the table which the snapshot was created from. A snapshot's size will not include the size of files which the table still refers. These sizes, in bytes, are what is used internally to compute quota violation for tables and namespaces.

Returns:

A map of snapshot name to size in bytes per space quota computations

Throws:

IOException

getMasterReportedTableSizes

public static Map<TableName,Long> getMasterReportedTableSizes(Connection conn)
                                                       throws IOException

Fetches the table sizes on the filesystem as tracked by the HBase Master.

Throws:

IOException

getRegionServerQuotaSnapshots

public static Map<TableName,SpaceQuotaSnapshot> getRegionServerQuotaSnapshots(Connection conn,
                                                                              ServerName regionServer)
                                                                       throws IOException

Fetches the observed SpaceQuotaSnapshots observed by a RegionServer.

Throws:

IOException

getCurrentSnapshot

public static SpaceQuotaSnapshot getCurrentSnapshot(Connection conn,
                                                    TableName tn)
                                             throws IOException

Returns the Master's view of a quota on the given tableName or null if the Master has no quota information on that table.

Throws:

IOException

getCurrentSnapshot

public static SpaceQuotaSnapshot getCurrentSnapshot(Connection conn,
                                                    String namespace)
                                             throws IOException

Returns the Master's view of a quota on the given namespace or null if the Master has no quota information on that namespace.

Throws:

IOException

getCurrentSnapshotFromQuotaTable

public static SpaceQuotaSnapshot getCurrentSnapshotFromQuotaTable(Connection conn,
                                                                  TableName tableName)
                                                           throws IOException

Returns the current space quota snapshot of the given tableName from QuotaTableUtil.QUOTA_TABLE_NAME or null if the no quota information is available for that tableName.

Parameters:

conn - connection to re-use

tableName - name of the table whose current snapshot is to be retreived

Throws:

IOException

quotasFromData

protected static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotasFromData(byte[] data)
                                                                                              throws IOException

Throws:

IOException

quotasFromData

protected static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotasFromData(byte[] data,
                                                                                                     int offset,
                                                                                                     int length)
                                                                                              throws IOException

Throws:

IOException

quotasToData

protected static byte[] quotasToData(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas data)
                              throws IOException

Throws:

IOException

isEmptyQuota

public static boolean isEmptyQuota(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas quotas)

doGet

protected static Result doGet(Connection connection,
                              Get get)
                       throws IOException

Throws:

IOException

doGet

protected static Result[] doGet(Connection connection,
                                List<Get> gets)
                         throws IOException

Throws:

IOException

getUserRowKey

protected static byte[] getUserRowKey(String user)

getTableRowKey

protected static byte[] getTableRowKey(TableName table)

getNamespaceRowKey

protected static byte[] getNamespaceRowKey(String namespace)

getSettingsQualifierForUserTable

protected static byte[] getSettingsQualifierForUserTable(TableName tableName)

getSettingsQualifierForUserNamespace

protected static byte[] getSettingsQualifierForUserNamespace(String namespace)

getUserRowKeyRegex

protected static String getUserRowKeyRegex(String user)

getTableRowKeyRegex

protected static String getTableRowKeyRegex(String table)

getNamespaceRowKeyRegex

protected static String getNamespaceRowKeyRegex(String namespace)

getRowKeyRegEx

private static String getRowKeyRegEx(byte[] prefix,
                                     String regex)

getSettingsQualifierRegexForUserTable

protected static String getSettingsQualifierRegexForUserTable(String table)

getSettingsQualifierRegexForUserNamespace

protected static String getSettingsQualifierRegexForUserNamespace(String namespace)

isNamespaceRowKey

protected static boolean isNamespaceRowKey(byte[] key)

getNamespaceFromRowKey

protected static String getNamespaceFromRowKey(byte[] key)

isTableRowKey

protected static boolean isTableRowKey(byte[] key)

getTableFromRowKey

protected static TableName getTableFromRowKey(byte[] key)

isUserRowKey

protected static boolean isUserRowKey(byte[] key)

getUserFromRowKey

protected static String getUserFromRowKey(byte[] key)

getProtoViolationPolicy

protected static org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota getProtoViolationPolicy(SpaceViolationPolicy policy)

getViolationPolicy

protected static SpaceViolationPolicy getViolationPolicy(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.SpaceQuota proto)

getSnapshotSizeQualifier

protected static byte[] getSnapshotSizeQualifier(String snapshotName)

extractSnapshotNameFromSizeCell

protected static String extractSnapshotNameFromSizeCell(Cell c)

extractSnapshotSize

protected static long extractSnapshotSize(byte[] data,
                                          int offset,
                                          int length)
                                   throws org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException

Throws:

org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException