org.commonvox.hbase_column_manager

Class RepositoryAdmin

Object

RepositoryAdmin

public class RepositoryAdmin
extends Object

A RepositoryAdmin provides ColumnManager Repository maintenance and query facilities, as well as column-metadata discovery and full-schema export/import facilities; it is used as a complement to the standard Admin interface to provide for maintenance of optional ColumnDefinition structures and querying of ColumnAuditor structures.

Author:

Daniel Vimont

Constructor Summary

Constructors

Constructor and Description
RepositoryAdmin(Connection connection) Initialize a RepositoryAdmin object using a Connection provided by either a ConnectionFactory or MConnectionFactory.

Method Summary

Modifier and Type	Method and Description
void	addColumnAuditor(HTableDescriptor htd, HColumnDescriptor hcd, ColumnAuditor colAuditor) Add (or modify, if already existing) the submitted ColumnAuditor to the submitted Table and Column Family.
void	addColumnAuditor(TableName tableName, byte[] colFamily, ColumnAuditor colAuditor) Add (or modify, if already existing) the submitted ColumnAuditor to the submitted Table and Column Family.
void	addColumnAuditors(HTableDescriptor htd, HColumnDescriptor hcd, List<ColumnAuditor> colAuditors) Add (or modify, if already existing) the submitted ColumnAuditors to the submitted Table and Column Family.
void	addColumnAuditors(TableName tableName, byte[] colFamily, List<ColumnAuditor> colAuditors) Add (or modify, if already existing) the submitted ColumnAuditors to the submitted Table and Column Family.
void	addColumnDefinition(HTableDescriptor htd, HColumnDescriptor hcd, ColumnDefinition colDefinition) Add (or modify, if already existing) the submitted ColumnDefinition to the submitted Table and Column Family.
void	addColumnDefinition(TableName tableName, byte[] colFamily, ColumnDefinition colDefinition) Add (or modify, if already existing) the submitted ColumnDefinition to the submitted Table and Column Family.
void	addColumnDefinitions(HTableDescriptor htd, HColumnDescriptor hcd, List<ColumnDefinition> colDefinitions) Add (or modify, if already existing) the submitted ColumnDefinitions to the submitted Table and Column Family.
void	addColumnDefinitions(TableName tableName, byte[] colFamily, List<ColumnDefinition> colDefinitions) Add (or modify, if already existing) the submitted ColumnDefinitions to the submitted Table and Column Family.
boolean	columnDefinitionsEnforced(TableName tableName, byte[] colFamily) Ascertains whether or not column definition enforcement is enabled for a specified Column Family.
HTableMultiplexer	createHTableMultiplexer(int perRegionServerBufferQueueSize) NOTE: THIS METHOD IS NOT YET SUPPORTED! Create an HTableMultiplexer object. SPECIAL NOTE: An HTableMultiplexer returned by this method will (1) validate submitted Column qualifiers and values (if ColumnDefinitionsEnforced is set to true for the related Column Family), (2) process "put" requests in a standard manner (queuing them for subsequent asynchronous processing by HBase) and then (3) perform synchronous ColumnManager Repository processing upon the metadata of each successfully queued "put".
void	deleteColumnDefinition(HTableDescriptor htd, HColumnDescriptor hcd, byte[] colQualifier) Delete the ColumnDefinition (pertaining to the submitted Column Qualifier) from the submitted Table and Column Family.
void	deleteColumnDefinition(TableName tableName, byte[] colFamily, byte[] colQualifier) Delete the ColumnDefinition (pertaining to the submitted Column Qualifier) from the submitted Table and Column Family.
static void	deleteTempReportTables(Admin hbaseAdmin) Delete temp report Tables which might remain from any abnormally terminated invocations of the outputReportOnInvalidColumn* methods.
void	discoverColumnMetadata(boolean includeAllCells, boolean useMapreduce) Performs discovery of Column metadata for all ColumnManager-included user Tables, storing the results for each unique Column Qualifier as a ColumnAuditor object in the ColumnManager Repository; all such metadata is then retrievable via the getColumnAuditors and getColumnQualifiers methods.
void	discoverColumnMetadata(String namespace, boolean includeAllCells, boolean useMapreduce) Performs discovery of Column metadata for all ColumnManager-included user Tables in the submitted namespace, storing the results for each unique Column Qualifier as a ColumnAuditor object in the ColumnManager Repository; all such metadata is then retrievable via the getColumnAuditors and getColumnQualifiers methods.
void	discoverColumnMetadata(TableName tableName, boolean includeAllCells, boolean useMapreduce) Performs discovery of Column metadata for the specified Table, storing the results for each unique Column Qualifier as a ColumnAuditor object in the ColumnManager Repository; all such metadata is then retrievable via the getColumnAuditors and getColumnQualifiers methods.
void	dumpRepositoryTable() Causes the complete contents (all cells) of the Repository table to be "dumped" (written) to the logging facility, for maintenance or debugging purposes.
void	enableColumnAliases(boolean enabled, TableName tableName, byte[] colFamily) Enable/disable column aliasing for the specified Column Family.
void	enableColumnDefinitionEnforcement(boolean enabled, TableName tableName, byte[] colFamily) Enable/disable column definition enforcement for the specified Column Family.
void	exportSchema(File targetFile) Creates an external HBaseSchemaArchive (HSA) file in XML format* containing the complete metadata contents (i.e., all Namespace, Table, Column Family, ColumnAuditor, and ColumnDefinition metadata) of the ColumnManager metadata Repository.
void	exportSchema(File targetFile, String sourceNamespaceName) Creates an external HBaseSchemaArchive (HSA) file in XML format* containing the complete schema contents of the specified HBase Namespace.
void	exportSchema(File targetFile, TableName sourceTableName) Creates an external HBaseSchemaArchive (HSA) file in XML format* containing the complete schema contents of the specified HBase Table.
static String	generateHsaFileSummary(File sourceHsaFile) Generates a hierarchically-indented, text-based summary report of the contents of an external HBaseSchemaArchive (HSA) XML file*.
ChangeEventMonitor	getChangeEventMonitor() Get a ChangeEventMonitor object
Set<ColumnAuditor>	getColumnAuditors(HTableDescriptor htd, HColumnDescriptor hcd) Get ColumnAuditor objects from the Repository for a specified Table and Column Family.
Set<ColumnAuditor>	getColumnAuditors(TableName tableName, byte[] colFamily) Get ColumnAuditor objects from the Repository for a specified Table and Column Family.
Collection<ColumnDefinition>	getColumnDefinitions(HTableDescriptor htd, HColumnDescriptor hcd) Get ColumnDefinitions belonging to the submitted Table and Column Family.
Collection<ColumnDefinition>	getColumnDefinitions(TableName tableName, byte[] colFamily) Get ColumnDefinitions belonging to the submitted Table and Column Family.
Set<byte[]>	getColumnQualifiers(HTableDescriptor htd, HColumnDescriptor hcd) Get Column Qualifiers from the ColumnAuditor metadata in the Repository for a specified Table and Column Family.
Set<byte[]>	getColumnQualifiers(TableName tableName, byte[] colFamily) Get Column Qualifiers from the ColumnAuditor metadata in the Repository for a specified Table and Column Family.
static int	getRepositoryMaxVersions(Admin hbaseAdmin) Get the maxVersions setting for the Repository table (maximum versions for Repository to retain of each schema metadata attribute).
void	importColumnDefinitions(File sourceHsaFile) Import into the ColumnManager Repository all ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.
void	importColumnDefinitions(File sourceHsaFile, String namespace) Import into the ColumnManager Repository all of a specified Namespace's ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.
void	importColumnDefinitions(File sourceHsaFile, TableName tableName) Import into the ColumnManager Repository all of a specified Table's ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.
void	importColumnDefinitions(File sourceHsaFile, TableName tableName, byte[] colFamily) Import into the ColumnManager Repository all of a specified ColumnFamily's ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.
void	importSchema(File sourceHsaFile, boolean includeColumnAuditors) Import into HBase the complete contents of an external HBaseSchemaArchive (HSA) XML file*; this process will NOT overlay any existing Namespace and Table structures in HBase.
void	importSchema(File sourceHsaFile, String namespaceName, boolean includeColumnAuditors) Import a Namespace into HBase with all its component schema-objects as serialized in an external HBaseSchemaArchive (HSA) XML file*; this process will NOT overlay any existing Namespace and Table structures in HBase.
void	importSchema(File sourceHsaFile, TableName tableName, boolean includeColumnAuditors) Import a Table into HBase with all its component schema-objects as serialized in an external HBaseSchemaArchive (HSA) XML file*; this process will NOT overlay an existing Table (and its component structures) in HBase.
static void	installRepositoryStructures(Admin hbaseAdmin) Create namespace and table structures for Repository; note that these structures will automatically be created with the first invocation of MConnectionFactory.createConnection() if the structures do not already exist.
boolean	namespaceExists(NamespaceDescriptor nd) Namespace existence verification.
boolean	namespaceExists(String namespaceName) Namespace existence verification.
boolean	outputReportOnColumnQualifiers(File targetFile, String namespace) Generates and outputs a CSV-formatted report on all ColumnAuditors that have been captured or discovered pertaining to all ColumnManager-included user Tables within the submitted Namespace.
boolean	outputReportOnColumnQualifiers(File targetFile, TableName tableName) Generates and outputs a CSV-formatted report on all ColumnAuditors that have been captured or discovered pertaining to the submitted user Table.
boolean	outputReportOnColumnQualifiers(File targetFile, TableName tableName, byte[] colFamily) Generates and outputs a CSV-formatted report on all ColumnAuditors that have been captured or discovered pertaining to the submitted Column Family within the submitted user Table.
boolean	outputReportOnInvalidColumnLengths(File targetFile, TableName tableName, boolean verbose, boolean includeAllCells, boolean useMapreduce) Generates and outputs a CSV-formatted report of all invalid lengths of column values stored in a Table, as stipulated by the ColumnLength settings in the Table's ColumnDefinitions.
boolean	outputReportOnInvalidColumnLengths(File targetFile, TableName tableName, byte[] colFamily, boolean verbose, boolean includeAllCells, boolean useMapreduce) Generates and outputs a CSV-formatted report of all invalid lengths of column values stored in a Column Family, as stipulated by the ColumnLength settings in the Column Family's ColumnDefinitions.
boolean	outputReportOnInvalidColumnQualifiers(File targetFile, TableName tableName, boolean verbose, boolean useMapreduce) Generates and outputs a CSV-formatted report of all invalid column qualifiers stored in a Table, as stipulated by the Table's ColumnDefinitions.
boolean	outputReportOnInvalidColumnQualifiers(File targetFile, TableName tableName, byte[] colFamily, boolean verbose, boolean useMapreduce) Generates and outputs a CSV-formatted report of all invalid column qualifiers stored in a Column Family, as stipulated by the Column Family's ColumnDefinitions.
boolean	outputReportOnInvalidColumnValues(File targetFile, TableName tableName, boolean verbose, boolean includeAllCells, boolean useMapreduce) Generates and outputs a CSV-formatted report of all invalid column values stored in a Table, as stipulated by the ValidationRegex settings in the Table's ColumnDefinitions.
boolean	outputReportOnInvalidColumnValues(File targetFile, TableName tableName, byte[] colFamily, boolean verbose, boolean includeAllCells, boolean useMapreduce) Generates and outputs a CSV-formatted report of all invalid column values stored in a Column Family, as stipulated by the ValidationRegex settings in the Column Family's ColumnDefinitions.
static void	setRepositoryMaxVersions(Admin hbaseAdmin, int maxVersions) Allows administrative override of the default maxVersions setting for the Repository table.
static void	uninstallRepositoryStructures(Admin hbaseAdmin) Disable and delete Repository table and drop Repository namespace (for uninstall or reinstall of ColumnManager).

Methods inherited from class Object

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

Constructor Detail

RepositoryAdmin

public RepositoryAdmin(Connection connection)
                throws IOException

Initialize a RepositoryAdmin object using a Connection provided by either a ConnectionFactory or MConnectionFactory.

Parameters:

connection - An HBase Connection.

Throws:

IOException - if a remote or network exception occurs

Method Detail

installRepositoryStructures

public static void installRepositoryStructures(Admin hbaseAdmin)
                                        throws IOException

Create namespace and table structures for Repository; note that these structures will automatically be created with the first invocation of MConnectionFactory.createConnection() if the structures do not already exist.

Parameters:

hbaseAdmin - standard HBase Admin object

Throws:

IOException - if a remote or network exception occurs

setRepositoryMaxVersions

public static void setRepositoryMaxVersions(Admin hbaseAdmin,
                                            int maxVersions)
                                     throws IOException

Allows administrative override of the default maxVersions setting for the Repository table. The default setting is 50.

Parameters:

hbaseAdmin - Standard Admin object

maxVersions - Maximum versions for Repository to retain of each schema metadata attribute

Throws:

IOException - if a remote or network exception occurs

getRepositoryMaxVersions

public static int getRepositoryMaxVersions(Admin hbaseAdmin)
                                    throws IOException

Get the maxVersions setting for the Repository table (maximum versions for Repository to retain of each schema metadata attribute).

Parameters:

hbaseAdmin - Standard Admin object

Returns:

Maximum versions for Repository to retain of each schema metadata attribute

Throws:

IOException - if a remote or network exception occurs

uninstallRepositoryStructures

public static void uninstallRepositoryStructures(Admin hbaseAdmin)
                                          throws IOException

Disable and delete Repository table and drop Repository namespace (for uninstall or reinstall of ColumnManager).

Parameters:

hbaseAdmin - standard HBase Admin

Throws:

IOException - if a remote or network exception occurs

deleteTempReportTables

public static void deleteTempReportTables(Admin hbaseAdmin)
                                   throws IOException

Delete temp report Tables which might remain from any abnormally terminated invocations of the outputReportOnInvalidColumn* methods. Note that invocation of this method will cause any currently-running invocations of the outputReportOnInvalidColumn* methods to abnormally terminate.

Parameters:

hbaseAdmin - standard HBase Admin

Throws:

IOException - if a remote or network exception occurs

dumpRepositoryTable

public void dumpRepositoryTable()
                         throws IOException

Causes the complete contents (all cells) of the Repository table to be "dumped" (written) to the logging facility, for maintenance or debugging purposes.

Throws:

IOException - if a remote or network exception occurs

addColumnAuditor

public void addColumnAuditor(TableName tableName,
                             byte[] colFamily,
                             ColumnAuditor colAuditor)
                      throws IOException,
                             TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnAuditor to the submitted Table and Column Family.

Parameters:

tableName - name of Table to which ColumnAuditor is to be added/modified

colFamily - Column Family to which ColumnAuditor is to be added/modified

colAuditor - ColumnAuditor to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnAuditor

public void addColumnAuditor(HTableDescriptor htd,
                             HColumnDescriptor hcd,
                             ColumnAuditor colAuditor)
                      throws IOException,
                             TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnAuditor to the submitted Table and Column Family.

Parameters:

htd - Table to which ColumnAuditor is to be added/modified

hcd - Column Descriptor (Column Family) to which ColumnAuditor is to be added/modified

colAuditor - ColumnAuditor to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnAuditors

public void addColumnAuditors(TableName tableName,
                              byte[] colFamily,
                              List<ColumnAuditor> colAuditors)
                       throws IOException,
                              TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnAuditors to the submitted Table and Column Family.

Parameters:

tableName - name of Table to which ColumnAuditors are to be added/modified

colFamily - Column Family to which ColumnAuditors are to be added/modified

colAuditors - List of ColumnAuditors to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnAuditors

public void addColumnAuditors(HTableDescriptor htd,
                              HColumnDescriptor hcd,
                              List<ColumnAuditor> colAuditors)
                       throws IOException,
                              TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnAuditors to the submitted Table and Column Family.

Parameters:

htd - Table to which ColumnAuditors are to be added/modified

hcd - ColumnAuditor [Family] Descriptor to which ColumnAuditors are to be added/modified

colAuditors - List of ColumnAuditors to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getColumnAuditors

public Set<ColumnAuditor> getColumnAuditors(HTableDescriptor htd,
                                            HColumnDescriptor hcd)
                                     throws IOException,
                                            TableNotIncludedForProcessingException

Get ColumnAuditor objects from the Repository for a specified Table and Column Family.

Parameters:

htd - Table Descriptor

hcd - Column [Family] Descriptor

Returns:

set of ColumnAuditors, or null if Table or Column Family not found

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getColumnAuditors

public Set<ColumnAuditor> getColumnAuditors(TableName tableName,
                                            byte[] colFamily)
                                     throws IOException,
                                            TableNotIncludedForProcessingException

Get ColumnAuditor objects from the Repository for a specified Table and Column Family.

Parameters:

tableName - Table name

colFamily - Column Family

Returns:

set of ColumnAuditors, or null if tableName or colFamily not found

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getColumnQualifiers

public Set<byte[]> getColumnQualifiers(HTableDescriptor htd,
                                       HColumnDescriptor hcd)
                                throws IOException,
                                       TableNotIncludedForProcessingException

Get Column Qualifiers from the ColumnAuditor metadata in the Repository for a specified Table and Column Family.

Parameters:

htd - Table Descriptor

hcd - Column [Family] Descriptor

Returns:

set of Column Qualifiers, or null if Table or Column Family not found

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getColumnQualifiers

public Set<byte[]> getColumnQualifiers(TableName tableName,
                                       byte[] colFamily)
                                throws IOException,
                                       TableNotIncludedForProcessingException

Get Column Qualifiers from the ColumnAuditor metadata in the Repository for a specified Table and Column Family.

Parameters:

tableName - Table name

colFamily - Column Family

Returns:

set of Column Qualifiers, or null if tableName or colFamily not found

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnDefinition

public void addColumnDefinition(TableName tableName,
                                byte[] colFamily,
                                ColumnDefinition colDefinition)
                         throws IOException,
                                TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnDefinition to the submitted Table and Column Family.

Parameters:

tableName - name of Table to which ColumnDefinition is to be added

colFamily - Column Family to which ColumnDefinition is to be added

colDefinition - ColumnDefinition to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnDefinition

public void addColumnDefinition(HTableDescriptor htd,
                                HColumnDescriptor hcd,
                                ColumnDefinition colDefinition)
                         throws IOException,
                                TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnDefinition to the submitted Table and Column Family.

Parameters:

htd - Table to which ColumnDefinition is to be added

hcd - ColumnAuditor [Family] Descriptor to which ColumnDefinition is to be added

colDefinition - ColumnDefinition to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnDefinitions

public void addColumnDefinitions(TableName tableName,
                                 byte[] colFamily,
                                 List<ColumnDefinition> colDefinitions)
                          throws IOException,
                                 TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnDefinitions to the submitted Table and Column Family.

Parameters:

tableName - name of Table to which ColumnDefinitions are to be added

colFamily - Column Family to which ColumnDefinitions are to be added

colDefinitions - List of ColumnDefinitions to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

addColumnDefinitions

public void addColumnDefinitions(HTableDescriptor htd,
                                 HColumnDescriptor hcd,
                                 List<ColumnDefinition> colDefinitions)
                          throws IOException,
                                 TableNotIncludedForProcessingException

Add (or modify, if already existing) the submitted ColumnDefinitions to the submitted Table and Column Family.

Parameters:

htd - Table to which ColumnDefinitions are to be added

hcd - ColumnAuditor [Family] Descriptor to which ColumnDefinitions are to be added

colDefinitions - List of ColumnDefinitions to be added or modified

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getColumnDefinitions

public Collection<ColumnDefinition> getColumnDefinitions(HTableDescriptor htd,
                                                         HColumnDescriptor hcd)
                                                  throws IOException,
                                                         TableNotIncludedForProcessingException

Get ColumnDefinitions belonging to the submitted Table and Column Family.

Parameters:

htd - Table to which ColumnDefinitions belong

hcd - ColumnAuditor [Family] Descriptor to which ColumnDefinitions belong

Returns:

collection of ColumnDefinitions

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getColumnDefinitions

public Collection<ColumnDefinition> getColumnDefinitions(TableName tableName,
                                                         byte[] colFamily)
                                                  throws IOException,
                                                         TableNotIncludedForProcessingException

Get ColumnDefinitions belonging to the submitted Table and Column Family.

Parameters:

tableName - name of Table to which ColumnDefinitions belong

colFamily - Column Family to which ColumnDefinitions belong

Returns:

collection of ColumnDefinitions

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

deleteColumnDefinition

public void deleteColumnDefinition(TableName tableName,
                                   byte[] colFamily,
                                   byte[] colQualifier)
                            throws IOException,
                                   TableNotIncludedForProcessingException

Delete the ColumnDefinition (pertaining to the submitted Column Qualifier) from the submitted Table and Column Family.

Parameters:

tableName - name of Table from which ColumnDefinition is to be deleted

colFamily - Column Family from which ColumnDefinition is to be deleted

colQualifier - qualifier which uniquely identifies the ColumnDefinition to be deleted

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

deleteColumnDefinition

public void deleteColumnDefinition(HTableDescriptor htd,
                                   HColumnDescriptor hcd,
                                   byte[] colQualifier)
                            throws IOException,
                                   TableNotIncludedForProcessingException

Delete the ColumnDefinition (pertaining to the submitted Column Qualifier) from the submitted Table and Column Family.

Parameters:

htd - Table from which ColumnDefinition is to be deleted

hcd - ColumnAuditor [Family] Descriptor from which ColumnDefinition is to be deleted

colQualifier - qualifier which uniquely identifies ColumnDefinition to be deleted

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

columnDefinitionsEnforced

public boolean columnDefinitionsEnforced(TableName tableName,
                                         byte[] colFamily)
                                  throws IOException,
                                         TableNotIncludedForProcessingException

Ascertains whether or not column definition enforcement is enabled for a specified Column Family.

Parameters:

tableName - Name of Table to which Column Family belongs.

colFamily - Name of Column Family for which column definition enforcement is to be ascertained

Returns:

true if column definition enforcement is enabled for the specified Column Family; false if column definition enforcement is not enabled

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

enableColumnDefinitionEnforcement

public void enableColumnDefinitionEnforcement(boolean enabled,
                                              TableName tableName,
                                              byte[] colFamily)
                                       throws IOException,
                                              TableNotIncludedForProcessingException

Enable/disable column definition enforcement for the specified Column Family. When ColumnManager is activated and column definition enforcement is enabled for a Column Family of a Table that is included in ColumnManager processing, then any Column qualifier submitted in a Mutation to the Table and Column Family (via the HBase API) must correspond to an existing ColumnDefinition, and the corresponding Column value submitted must pass all validations (if any) stipulated by the ColumnDefinition.

Parameters:

enabled - if true, column definition enforcement is enabled; if false, it is disabled

tableName - Name of Table to which Column Family belongs

colFamily - Name of Column Family for which column definition enforcement is to be enabled or disabled

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

enableColumnAliases

public void enableColumnAliases(boolean enabled,
                                TableName tableName,
                                byte[] colFamily)
                         throws IOException,
                                TableNotIncludedForProcessingException

Enable/disable column aliasing for the specified Column Family.
Column-alias processing involves a 4-byte (positive integer) column-alias being stored in each cell in place of the full-length Column Qualifier, potentially conserving considerable data storage space. This works invisibly to the application developer, who continues working only with the standard hbase-client API interfaces, reading and writing full-length column-qualifiers.
Aliasing should only be activated for a newly-defined, completely empty (or freshly truncated) Column Family, and it should not be deactivated after data has been stored in the Column Family.

Parameters:

enabled - if true, column aliasing will be enabled; if false, it will be disabled

tableName - Name of Table to which Column Family belongs

colFamily - Name of Column Family for which column aliasing is to be enabled or disabled

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

getChangeEventMonitor

public ChangeEventMonitor getChangeEventMonitor()
                                         throws IOException

Get a ChangeEventMonitor object

Returns:

ChangeEventMonitor object

Throws:

IOException - if a remote or network exception occurs

createHTableMultiplexer

public HTableMultiplexer createHTableMultiplexer(int perRegionServerBufferQueueSize)
                                          throws IOException

NOTE: THIS METHOD IS NOT YET SUPPORTED!

Create an HTableMultiplexer object.

SPECIAL NOTE: An HTableMultiplexer returned by this method will (1) validate submitted Column qualifiers and values (if ColumnDefinitionsEnforced is set to true for the related Column Family), (2) process "put" requests in a standard manner (queuing them for subsequent asynchronous processing by HBase) and then (3) perform synchronous ColumnManager Repository processing upon the metadata of each successfully queued "put". Be advised that the third step will not take into account any potentially failed "put" transactions among those queued in the second step; instead it assumes that all "put" transactions succeeded, updating the ColumnManager Repository accordingly.

Parameters:

perRegionServerBufferQueueSize - determines the max number of the buffered Put ops for each region server before dropping a request.

Returns:

HTableMultiplexer object

Throws:

IOException - if a remote or network exception occurs

discoverColumnMetadata

public void discoverColumnMetadata(boolean includeAllCells,
                                   boolean useMapreduce)
                            throws Exception

Performs discovery of Column metadata for all ColumnManager-included user Tables, storing the results for each unique Column Qualifier as a ColumnAuditor object in the ColumnManager Repository; all such metadata is then retrievable via the getColumnAuditors and getColumnQualifiers methods. The discovery process entails a KeyOnlyFilter scan of the Tables, either via direct scanning or via mapreduce. Note that when the mapreduce option is utilized, the default row-cache setting is 500, which may be overridden by setting the Configuration parameter TableInputFormat.SCAN_CACHEDROWS.

Parameters:

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, discovery is done via mapreduce; otherwise, discovery is done via direct-scan

Throws:

IOException - if a remote or network exception occurs

Exception

discoverColumnMetadata

public void discoverColumnMetadata(String namespace,
                                   boolean includeAllCells,
                                   boolean useMapreduce)
                            throws Exception,
                                   TableNotIncludedForProcessingException

Performs discovery of Column metadata for all ColumnManager-included user Tables in the submitted namespace, storing the results for each unique Column Qualifier as a ColumnAuditor object in the ColumnManager Repository; all such metadata is then retrievable via the getColumnAuditors and getColumnQualifiers methods. The discovery process entails a KeyOnlyFilter scan of the Tables, either via direct scanning or via mapreduce. Note that when the mapreduce option is utilized, the default row-cache setting is 500, which may be overridden by setting the Configuration parameter TableInputFormat.SCAN_CACHEDROWS.

Parameters:

namespace - Namespace for which schema metadata is to be discovered; submitted namespace must have at least one Table that is included in ColumnManager processing

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, discovery is done via mapreduce; otherwise, discovery is done via direct-scan

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if no Tables from the Namespace are included in ColumnManager processing

Exception

discoverColumnMetadata

public void discoverColumnMetadata(TableName tableName,
                                   boolean includeAllCells,
                                   boolean useMapreduce)
                            throws Exception,
                                   TableNotIncludedForProcessingException

Performs discovery of Column metadata for the specified Table, storing the results for each unique Column Qualifier as a ColumnAuditor object in the ColumnManager Repository; all such metadata is then retrievable via the getColumnAuditors and getColumnQualifiers methods. The discovery process entails a KeyOnlyFilter scan of the Table, either via direct scanning or via mapreduce. Note that when the mapreduce option is utilized, the default row-cache setting is 500, which may be overridden by setting the Configuration parameter TableInputFormat.SCAN_CACHEDROWS.

Parameters:

tableName - Table for which schema metadata is to be discovered; submitted Table must be included in ColumnManager processing

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, discovery is done via mapreduce; otherwise, discovery is done via direct-scan

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

exportSchema

public void exportSchema(File targetFile)
                  throws IOException,
                         JAXBException,
                         XMLStreamException

Creates an external HBaseSchemaArchive (HSA) file in XML format* containing the complete metadata contents (i.e., all Namespace, Table, Column Family, ColumnAuditor, and ColumnDefinition metadata) of the ColumnManager metadata Repository. This constitutes an XML-formatted serialization of objects of the following classes: NamespaceDescriptor, HTableDescriptor, HColumnDescriptor, ColumnAuditor, and ColumnDefinition.

*An HSA file adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

targetFile - target file

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

XMLStreamException - if an exception occurs in the context of JAXB processing

exportSchema

public void exportSchema(File targetFile,
                         String sourceNamespaceName)
                  throws IOException,
                         JAXBException,
                         XMLStreamException,
                         TableNotIncludedForProcessingException

Creates an external HBaseSchemaArchive (HSA) file in XML format* containing the complete schema contents of the specified HBase Namespace. This constitutes an XML-formatted serialization of objects of the following classes: NamespaceDescriptor, HTableDescriptor, HColumnDescriptor, ColumnAuditor, and ColumnDefinition.

*An HSA file adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

targetFile - target file

sourceNamespaceName - namespace from which to export schema entities

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

XMLStreamException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if no Tables from the Namespace are included in ColumnManager processing

exportSchema

public void exportSchema(File targetFile,
                         TableName sourceTableName)
                  throws IOException,
                         JAXBException,
                         XMLStreamException,
                         TableNotIncludedForProcessingException

Creates an external HBaseSchemaArchive (HSA) file in XML format* containing the complete schema contents of the specified HBase Table. This constitutes an XML-formatted serialization of objects of the following classes: HTableDescriptor, HColumnDescriptor, ColumnAuditor, and ColumnDefinition.

*An HSA file adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

targetFile - target File

sourceTableName - table to export (along with its component schema-entities)

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

XMLStreamException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

importSchema

public void importSchema(File sourceHsaFile,
                         boolean includeColumnAuditors)
                  throws IOException,
                         JAXBException

Import into HBase the complete contents of an external HBaseSchemaArchive (HSA) XML file*; this process will NOT overlay any existing Namespace and Table structures in HBase. Only Tables which are included in ColumnManager processing will be imported.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

sourceHsaFile - source file

includeColumnAuditors - if true, import ColumnAuditor metadata from the HBaseSchemaArchive file into the ColumnManager Repository.

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

importSchema

public void importSchema(File sourceHsaFile,
                         String namespaceName,
                         boolean includeColumnAuditors)
                  throws IOException,
                         JAXBException,
                         TableNotIncludedForProcessingException

Import a Namespace into HBase with all its component schema-objects as serialized in an external HBaseSchemaArchive (HSA) XML file*; this process will NOT overlay any existing Namespace and Table structures in HBase. Only Tables which are included in ColumnManager processing will be imported.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

sourceHsaFile - source file

namespaceName - namespace to import.

includeColumnAuditors - if true, import ColumnAuditor metadata from the HBaseSchemaArchive file into the ColumnManager Repository.

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if no Tables from the Namespace are included in ColumnManager processing

importSchema

public void importSchema(File sourceHsaFile,
                         TableName tableName,
                         boolean includeColumnAuditors)
                  throws IOException,
                         JAXBException,
                         TableNotIncludedForProcessingException

Import a Table into HBase with all its component schema-objects as serialized in an external HBaseSchemaArchive (HSA) XML file*; this process will NOT overlay an existing Table (and its component structures) in HBase. Only a Table which is included in ColumnManager processing will be imported.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

includeColumnAuditors - if true, import ColumnAuditor metadata from the HBaseSchemaArchive file into the ColumnManager Repository.

tableName - Name of table to be imported.

sourceHsaFile - source file

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

importColumnDefinitions

public void importColumnDefinitions(File sourceHsaFile)
                             throws IOException,
                                    JAXBException

Import into the ColumnManager Repository all ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

sourceHsaFile - source file

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

importColumnDefinitions

public void importColumnDefinitions(File sourceHsaFile,
                                    String namespace)
                             throws IOException,
                                    JAXBException,
                                    TableNotIncludedForProcessingException

Import into the ColumnManager Repository all of a specified Namespace's ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

namespace - namespace for which ColumnDefinitions are to be imported

sourceHsaFile - source file

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if no Tables from the Namespace are included in ColumnManager processing

importColumnDefinitions

public void importColumnDefinitions(File sourceHsaFile,
                                    TableName tableName)
                             throws IOException,
                                    JAXBException,
                                    TableNotIncludedForProcessingException

Import into the ColumnManager Repository all of a specified Table's ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

tableName - table for which ColumnDefinitions are to be imported

sourceHsaFile - source file

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

importColumnDefinitions

public void importColumnDefinitions(File sourceHsaFile,
                                    TableName tableName,
                                    byte[] colFamily)
                             throws IOException,
                                    JAXBException,
                                    TableNotIncludedForProcessingException

Import into the ColumnManager Repository all of a specified ColumnFamily's ColumnDefinitions that are found in the submitted HBaseSchemaArchive (HSA) XML file*; for a ColumnDefinition to be imported, it must belong to an existing Table/ColumnFamily which is included in ColumnManager processing.

*An HSA file is created with the one of the #exportSchema methods and adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

tableName - table of ColumnFamily for which ColumnDefinitions are to be imported

colFamily - ColumnFamily for which ColumnDefinitions are to be imported

sourceHsaFile - source file

Throws:

IOException - if a remote or network exception occurs

JAXBException - if an exception occurs in the context of JAXB processing

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

generateHsaFileSummary

public static String generateHsaFileSummary(File sourceHsaFile)
                                     throws JAXBException

Generates a hierarchically-indented, text-based summary report of the contents of an external HBaseSchemaArchive (HSA) XML file*.

*An HSA file adheres to the XML Schema layout in HBaseSchemaArchive.xsd.xml.

Parameters:

sourceHsaFile - source HBaseSchemaArchive file

Returns:

A String containing a summary report suitable for printing/viewing.

Throws:

JAXBException - if an exception occurs in the context of JAXB processing

outputReportOnColumnQualifiers

public boolean outputReportOnColumnQualifiers(File targetFile,
                                              String namespace)
                                       throws IOException,
                                              TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report on all ColumnAuditors that have been captured or discovered pertaining to all ColumnManager-included user Tables within the submitted Namespace.

Parameters:

targetFile - file to which the CSV file is to be outputted

namespace - namespace for which ColumnAuditor report is to be generated/outputted

Returns:

true if ColumnAuditors found and reported on; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if no Tables from the Namespace are included in ColumnManager processing

outputReportOnColumnQualifiers

public boolean outputReportOnColumnQualifiers(File targetFile,
                                              TableName tableName)
                                       throws IOException,
                                              TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report on all ColumnAuditors that have been captured or discovered pertaining to the submitted user Table.

Parameters:

targetFile - file to which the CSV file is to be outputted

tableName - name of the Table for which ColumnAuditor report is to be generated/outputted

Returns:

true if ColumnAuditors found and reported on; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

outputReportOnColumnQualifiers

public boolean outputReportOnColumnQualifiers(File targetFile,
                                              TableName tableName,
                                              byte[] colFamily)
                                       throws IOException,
                                              TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report on all ColumnAuditors that have been captured or discovered pertaining to the submitted Column Family within the submitted user Table.

Parameters:

targetFile - file to which the CSV file is to be outputted

tableName - name of the Table for which ColumnAuditor report is to be generated/outputted

colFamily - name of the Column Family within the Table for which ColumnAuditor report is to be generated/outputted

Returns:

true if ColumnAuditors found and reported on; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

outputReportOnInvalidColumnQualifiers

public boolean outputReportOnInvalidColumnQualifiers(File targetFile,
                                                     TableName tableName,
                                                     boolean verbose,
                                                     boolean useMapreduce)
                                              throws Exception,
                                                     TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report of all invalid column qualifiers stored in a Table, as stipulated by the Table's ColumnDefinitions. If no ColumnDefinitions exist for any of the Table's Column Families, a ColumnDefinitionNotFoundException will be thrown.

Parameters:

tableName - name of the Table to be reported on

targetFile - file to which the CSV file is to be outputted

verbose - if true the outputted CSV file will include an entry (identified by the fully-qualified column name and rowId) for each explicit invalid column qualifier that is found; otherwise the report will contain a summary, with one line for each invalid column qualifier found, along with a count of the number of rows which contain that same invalid column qualifier.

useMapreduce - if true, analysis will be done on servers via mapreduce jobs; otherwise, analysis is done via direct-scan

Returns:

true if invalid column qualifiers found; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

outputReportOnInvalidColumnQualifiers

public boolean outputReportOnInvalidColumnQualifiers(File targetFile,
                                                     TableName tableName,
                                                     byte[] colFamily,
                                                     boolean verbose,
                                                     boolean useMapreduce)
                                              throws Exception,
                                                     TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report of all invalid column qualifiers stored in a Column Family, as stipulated by the Column Family's ColumnDefinitions. If no ColumnDefinitions exist for the Column Family, a ColumnDefinitionNotFoundException will be thrown.

Parameters:

targetFile - file to which the CSV file is to be outputted

tableName - name of the Table containing the Column Family to be reported on

colFamily - name of the Column Family to be reported on

verbose - if true the outputted CSV file will include an entry (identified by the fully-qualified column name and rowId) for each explicit invalid column qualifier that is found; otherwise the report will contain a summary, with one line for each invalid column qualifier found, along with a count of the number of rows which contain that same invalid column qualifier.

useMapreduce - if true, analysis will be done on servers via mapreduce jobs; otherwise, analysis is done via direct-scan

Returns:

true if invalid column qualifiers found; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

outputReportOnInvalidColumnLengths

public boolean outputReportOnInvalidColumnLengths(File targetFile,
                                                  TableName tableName,
                                                  boolean verbose,
                                                  boolean includeAllCells,
                                                  boolean useMapreduce)
                                           throws Exception,
                                                  TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report of all invalid lengths of column values stored in a Table, as stipulated by the ColumnLength settings in the Table's ColumnDefinitions. If no ColumnDefinitions exist for any of the Table's Column Families, a ColumnDefinitionNotFoundException will be thrown.

Parameters:

tableName - name of the Table to be reported on

targetFile - file to which the CSV file is to be outputted

verbose - if true the outputted CSV file will include an entry (identified by the fully-qualified column name and rowId) for each explicit invalid column length that is found; otherwise the report will contain a summary, with one line for each column found to contain at least a single instance of an invalid column length, along with a count of the number of rows in which that column contains an invalid column length.

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, analysis will be done on servers via mapreduce jobs; otherwise, analysis is done via direct-scan

Returns:

true if invalid column qualifiers found; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

outputReportOnInvalidColumnLengths

public boolean outputReportOnInvalidColumnLengths(File targetFile,
                                                  TableName tableName,
                                                  byte[] colFamily,
                                                  boolean verbose,
                                                  boolean includeAllCells,
                                                  boolean useMapreduce)
                                           throws Exception,
                                                  TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report of all invalid lengths of column values stored in a Column Family, as stipulated by the ColumnLength settings in the Column Family's ColumnDefinitions. If no ColumnDefinitions exist for the Column Family, a ColumnDefinitionNotFoundException will be thrown.

Parameters:

targetFile - file to which the CSV file is to be outputted

tableName - name of the Table containing the Column Family to be reported on

colFamily - name of the Column Family to be reported on

verbose - if true the outputted CSV file will include an entry (identified by the fully-qualified column name and rowId) for each explicit invalid column length that is found; otherwise the report will contain a summary, with one line for each column found to contain at least a single instance of an invalid column length, along with a count of the number of rows in which that column contains an invalid column length.

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, analysis will be done on servers via mapreduce jobs; otherwise, analysis is done via direct-scan

Returns:

true if invalid column qualifiers found; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

outputReportOnInvalidColumnValues

public boolean outputReportOnInvalidColumnValues(File targetFile,
                                                 TableName tableName,
                                                 boolean verbose,
                                                 boolean includeAllCells,
                                                 boolean useMapreduce)
                                          throws Exception,
                                                 TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report of all invalid column values stored in a Table, as stipulated by the ValidationRegex settings in the Table's ColumnDefinitions. If no ColumnDefinitions exist for any of the Table's Column Families, a ColumnDefinitionNotFoundException will be thrown.

Parameters:

tableName - name of the Table to be reported on

targetFile - file to which the CSV file is to be outputted

verbose - if true the outputted CSV file will include an entry (identified by the fully-qualified column name and rowId) for each explicit invalid column value that is found; otherwise the report will contain a summary, with one line for each column found to contain at least a single instance of an invalid column value, along with a count of the number of rows in which that column contains an invalid column value.

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, analysis will be done on servers via mapreduce jobs; otherwise, analysis is done via direct-scan

Returns:

true if invalid column qualifiers found; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

outputReportOnInvalidColumnValues

public boolean outputReportOnInvalidColumnValues(File targetFile,
                                                 TableName tableName,
                                                 byte[] colFamily,
                                                 boolean verbose,
                                                 boolean includeAllCells,
                                                 boolean useMapreduce)
                                          throws Exception,
                                                 TableNotIncludedForProcessingException

Generates and outputs a CSV-formatted report of all invalid column values stored in a Column Family, as stipulated by the ValidationRegex settings in the Column Family's ColumnDefinitions. If no ColumnDefinitions exist for the Column Family, a ColumnDefinitionNotFoundException will be thrown.

Parameters:

targetFile - file to which the CSV file is to be outputted

tableName - name of the Table containing the Column Family to be reported on

colFamily - name of the Column Family to be reported on

verbose - if true the outputted CSV file will include an entry (identified by the fully-qualified column name and rowId) for each explicit invalid column value that is found; otherwise the report will contain a summary, with one line for each column found to contain at least a single instance of an invalid column value, along with a count of the number of rows in which that column contains an invalid column value.

includeAllCells - if true, analysis will include ALL cells for each column; otherwise, analysis will only include the most recent cell.

useMapreduce - if true, analysis will be done on servers via mapreduce jobs; otherwise, analysis is done via direct-scan

Returns:

true if invalid column qualifiers found; otherwise, false

Throws:

IOException - if a remote or network exception occurs

TableNotIncludedForProcessingException - if Table not included in ColumnManager processing

Exception

namespaceExists

public boolean namespaceExists(NamespaceDescriptor nd)
                        throws IOException

Namespace existence verification.

Parameters:

nd - NamespaceDescriptor

Returns:

true if namespace exists

Throws:

IOException - if a remote or network exception occurs

namespaceExists

public boolean namespaceExists(String namespaceName)
                        throws IOException

Namespace existence verification.

Parameters:

namespaceName - name of namespace

Returns:

true if namespace exists

Throws:

IOException - if a remote or network exception occurs