org.apache.nifi.hbase

Interface HBaseClientService

All Superinterfaces:

ConfigurableComponent, ControllerService

@Tags(value={"hbase","client"})
 @CapabilityDescription(value="A controller service for accessing an HBase client.")
public interface HBaseClientService
extends ControllerService

Method Summary

Modifier and Type	Method and Description
boolean	checkAndPut(String tableName, byte[] rowId, byte[] family, byte[] qualifier, byte[] value, PutColumn column) Atomically checks if a row/family/qualifier value matches the expected value.
void	delete(String tableName, byte[] rowId) Deletes the given row on HBase.
void	delete(String tableName, byte[] rowId, String visibilityLabel) Deletes the given row on HBase.
void	delete(String tableName, List<byte[]> rowIds) Deletes a list of rows in HBase.
void	delete(String tableName, List<byte[]> rowIds, String visibilityLabel) Deletes a list of rows in HBase.
void	deleteCells(String tableName, List<DeleteRequest> deletes) Deletes a list of cells from HBase.
void	put(String tableName, byte[] rowId, Collection<PutColumn> columns) Puts the given row to HBase with the provided columns.
void	put(String tableName, Collection<PutFlowFile> puts) Puts a batch of mutations to the given table.
void	scan(String tableName, byte[] startRow, byte[] endRow, Collection<Column> columns, List<String> authorizations, ResultHandler handler) Scans the given table for the given rowId and passes the result to the handler.
void	scan(String tableName, Collection<Column> columns, String filterExpression, long minTime, List<String> authorizations, ResultHandler handler) Scans the given table using the optional filter criteria and passing each result to the provided handler.
void	scan(String tableName, Collection<Column> columns, String filterExpression, long minTime, ResultHandler handler) Scans the given table using the optional filter criteria and passing each result to the provided handler.
void	scan(String tableName, String startRow, String endRow, String filterExpression, Long timerangeMin, Long timerangeMax, Integer limitRows, Boolean isReversed, Boolean blockCache, Collection<Column> columns, List<String> authorizations, ResultHandler handler) Scans the given table for the given range of row keys or time rage and passes the result to a handler.
byte[]	toBytes(boolean b) Converts the given boolean to it's byte representation.
byte[]	toBytes(double d) Converts the given double to it's byte representation.
byte[]	toBytes(float f) Converts the given float to its byte representation.
byte[]	toBytes(int i) Converts the given float to its byte representation.
byte[]	toBytes(long l) Converts the given long to it's byte representation.
byte[]	toBytes(String s) Converts the given string to it's byte representation.
byte[]	toBytesBinary(String s) Converts the given binary formatted string to a byte representation
default String	toTransitUri(String tableName, String rowKey) Create a transit URI from the current configuration and the specified table name.

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

put

void put(String tableName,
         Collection<PutFlowFile> puts)
  throws IOException

Puts a batch of mutations to the given table.

Parameters:

tableName - the name of an HBase table

puts - a list of put mutations for the given table

Throws:

IOException - thrown when there are communication errors with HBase

put

void put(String tableName,
         byte[] rowId,
         Collection<PutColumn> columns)
  throws IOException

Puts the given row to HBase with the provided columns.

Parameters:

tableName - the name of an HBase table

rowId - the id of the row to put

columns - the columns of the row to put

Throws:

IOException - thrown when there are communication errors with HBase

checkAndPut

boolean checkAndPut(String tableName,
                    byte[] rowId,
                    byte[] family,
                    byte[] qualifier,
                    byte[] value,
                    PutColumn column)
             throws IOException

Atomically checks if a row/family/qualifier value matches the expected value. If it does, then the Put is added to HBase.

Parameters:

tableName - the name of an HBase table

rowId - the id of the row to check

family - the family of the row to check

qualifier - the qualifier of the row to check

value - the value of the row to check. If null, the check is for the lack of column (ie: non-existence)

Returns:

True if the Put was executed, false otherwise

Throws:

IOException - thrown when there are communication errors with HBase$

delete

void delete(String tableName,
            byte[] rowId)
     throws IOException

Deletes the given row on HBase. All cells are deleted.

Parameters:

tableName - the name of an HBase table

rowId - the id of the row to delete

Throws:

IOException - thrown when there are communication errors with HBase

delete

void delete(String tableName,
            byte[] rowId,
            String visibilityLabel)
     throws IOException

Deletes the given row on HBase. Uses the supplied visibility label for all cells in the delete. It will fail if HBase cannot delete a cell because the visibility label on the cell does not match the specified label.

Parameters:

tableName - the name of an HBase table

rowId - the id of the row to delete

visibilityLabel - a visibility label to apply to the delete

Throws:

IOException - thrown when there are communication errors with HBase

delete

void delete(String tableName,
            List<byte[]> rowIds)
     throws IOException

Deletes a list of rows in HBase. All cells are deleted.

Parameters:

tableName - the name of an HBase table

rowIds - a list of rowIds to send in a batch delete

Throws:

IOException

deleteCells

void deleteCells(String tableName,
                 List<DeleteRequest> deletes)
          throws IOException

Deletes a list of cells from HBase. This is intended to be used with granular delete operations.

Parameters:

tableName - the name of an HBase table.

deletes - a list of DeleteRequest objects.

Throws:

IOException - thrown when there are communication errors with HBase

delete

void delete(String tableName,
            List<byte[]> rowIds,
            String visibilityLabel)
     throws IOException

Deletes a list of rows in HBase. All cells that match the visibility label are deleted.

Parameters:

tableName - the name of an HBase table

rowIds - a list of rowIds to send in a batch delete

visibilityLabel - a visibility label expression

Throws:

IOException

scan

void scan(String tableName,
          Collection<Column> columns,
          String filterExpression,
          long minTime,
          ResultHandler handler)
   throws IOException

Scans the given table using the optional filter criteria and passing each result to the provided handler.

Parameters:

tableName - the name of an HBase table to scan

columns - optional columns to return, if not specified all columns are returned

filterExpression - optional filter expression, if not specified no filtering is performed

minTime - the minimum timestamp of cells to return, passed to the HBase scanner timeRange

handler - a handler to process rows of the result set

Throws:

IOException - thrown when there are communication errors with HBase

scan

void scan(String tableName,
          Collection<Column> columns,
          String filterExpression,
          long minTime,
          List<String> authorizations,
          ResultHandler handler)
   throws IOException

Scans the given table using the optional filter criteria and passing each result to the provided handler.

Parameters:

tableName - the name of an HBase table to scan

columns - optional columns to return, if not specified all columns are returned

filterExpression - optional filter expression, if not specified no filtering is performed

minTime - the minimum timestamp of cells to return, passed to the HBase scanner timeRange

authorizations - the visibility labels to apply to the scanner.

handler - a handler to process rows of the result set

Throws:

IOException - thrown when there are communication errors with HBase

scan

void scan(String tableName,
          byte[] startRow,
          byte[] endRow,
          Collection<Column> columns,
          List<String> authorizations,
          ResultHandler handler)
   throws IOException

Scans the given table for the given rowId and passes the result to the handler.

Parameters:

tableName - the name of an HBase table to scan

startRow - the row identifier to start scanning at

endRow - the row identifier to end scanning at

columns - optional columns to return, if not specified all columns are returned

handler - a handler to process rows of the result

Throws:

IOException - thrown when there are communication errors with HBase

scan

void scan(String tableName,
          String startRow,
          String endRow,
          String filterExpression,
          Long timerangeMin,
          Long timerangeMax,
          Integer limitRows,
          Boolean isReversed,
          Boolean blockCache,
          Collection<Column> columns,
          List<String> authorizations,
          ResultHandler handler)
   throws IOException

Scans the given table for the given range of row keys or time rage and passes the result to a handler.

Parameters:

tableName - the name of an HBase table to scan

startRow - the row identifier to start scanning at

endRow - the row identifier to end scanning at

filterExpression - optional filter expression, if not specified no filtering is performed

timerangeMin - the minimum timestamp of cells to return, passed to the HBase scanner timeRange

timerangeMax - the maximum timestamp of cells to return, passed to the HBase scanner timeRange

limitRows - the maximum number of rows to be returned by scanner

isReversed - whether this scan is a reversed one.

blockCache - set to use the block cache option of hbase scan.

columns - optional columns to return, if not specified all columns are returned

authorizations - optional list of visibility labels that the user should be able to see when communicating with HBase

handler - a handler to process rows of the result

Throws:

IOException

toBytes

byte[] toBytes(boolean b)

Converts the given boolean to it's byte representation.

Parameters:

b - a boolean

Returns:

the boolean represented as bytes

toBytes

byte[] toBytes(float f)

Converts the given float to its byte representation.

Parameters:

f - a float

Returns:

the float represented as bytes

toBytes

byte[] toBytes(int i)

Converts the given float to its byte representation.

Parameters:

i - an int

Returns:

the int represented as bytes

toBytes

byte[] toBytes(long l)

Converts the given long to it's byte representation.

Parameters:

l - a long

Returns:

the long represented as bytes

toBytes

byte[] toBytes(double d)

Converts the given double to it's byte representation.

Parameters:

d - a double

Returns:

the double represented as bytes

toBytes

byte[] toBytes(String s)

Converts the given string to it's byte representation.

Parameters:

s - a string

Returns:

the string represented as bytes

toBytesBinary

byte[] toBytesBinary(String s)

Converts the given binary formatted string to a byte representation

Parameters:

s - a binary encoded string

Returns:

the string represented as bytes

toTransitUri

default String toTransitUri(String tableName,
                            String rowKey)

Create a transit URI from the current configuration and the specified table name. The default implementation just prepend "hbase://" to the table name and row key, i.e. "hbase://tableName/rowKey".

Parameters:

tableName - The name of a HBase table

rowKey - The target HBase row key, this can be null or empty string if the operation is not targeted to a specific row

Returns:

a qualified transit URI which can identify a HBase table row in a HBase cluster