hbase connector

Description - Write row(s) to a table

Runtime Class - com.ibi.agents.XDHBaseWriteTable


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
* - denotes required
 ParameterTypeDescription
Column Data TableTable (as described below) Column Data Table
* - denotes required

Column Data Table
 ColumnTypeDescription
*Row KeystringRow key
*NamestringColumn family with qualifer(family:qualifer)
*ValuestringValue
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument returned by operation

Select from one of the following options:
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

Column Data Table
 ColumnTypeDescription
*Row KeystringRow key
*NamestringColumn family with qualifer(family:qualifer)
*ValuestringValue
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Write a cell to a table

Runtime Class - com.ibi.agents.XDHBaseWriteCellToTable


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Row Key:stringRow Key
* - denotes required
 ParameterTypeDescription
Column:stringColumn (family:qualifer)
Value:stringValue
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument returned by operation

Select from one of the following options:
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Update an existing table with the provided schema fragment

Runtime Class - com.ibi.agents.XDHBaseUpdateTablewithSchemaFragment


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Name:stringName of the table
IS_META:booleanIt is used to identify a meta table
IS_ROOT:booleanIt is used to identify a root table
* - denotes required
 ParameterTypeDescription
Column Schema TableTable (as described below) Column Schema Table
* - denotes required

Column Schema Table
 ColumnTypeDescription
*NAMEstringName of column
BLOOMFILTERstringIt can be enabled per-ColumnFamily
VERSIONSintegerThe maximum number of row versions to store is configured per column family
IN_MEMORYbooleanIt can be enabled per-ColumnFamily
KEEP_DELETED_CELLSbooleanThat means deleted cells can still be retrieved with Get or Scan operations, as long these operations have a time range specified that ends before the timestamp of any delete that would affect the cells.
DATA_BLOCK_ENCODINGstringIt attempts to limit duplication of information in keys, taking advantage of some of the fundamental designs and patterns of HBase, such as sorted row keys and the schema of a given table.
TTLintegerTime to live
COMPRESSIONstringProduction systems should use compression with their ColumnFamily definitions.
MIN_VERSIONSintegerThe minimum number of row versions to keep is configured per column family
BLOCKCACHEbooleanIt is enabled by default for all the user tables which means that any read operation will load the LRU cache.
BLOCKSIZEintegerThe blocksize can be configured for each ColumnFamily in a table, and this defaults to 64k. Larger cell values require larger blocksizes.
REPLICATION_SCOPEintegerIt is a column-family level attribute and its value can be either 0 or 1. A value of 0 means replication is disabled, and 1 means replication is enabled.
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument returned by operation

Select from one of the following options:
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

Column Schema Table
 ColumnTypeDescription
*NAMEstringName of column
BLOOMFILTERstringIt can be enabled per-ColumnFamily
VERSIONSintegerThe maximum number of row versions to store is configured per column family
IN_MEMORYbooleanIt can be enabled per-ColumnFamily
KEEP_DELETED_CELLSbooleanThat means deleted cells can still be retrieved with Get or Scan operations, as long these operations have a time range specified that ends before the timestamp of any delete that would affect the cells.
DATA_BLOCK_ENCODINGstringIt attempts to limit duplication of information in keys, taking advantage of some of the fundamental designs and patterns of HBase, such as sorted row keys and the schema of a given table.
TTLintegerTime to live
COMPRESSIONstringProduction systems should use compression with their ColumnFamily definitions.
MIN_VERSIONSintegerThe minimum number of row versions to keep is configured per column family
BLOCKCACHEbooleanIt is enabled by default for all the user tables which means that any read operation will load the LRU cache.
BLOCKSIZEintegerThe blocksize can be configured for each ColumnFamily in a table, and this defaults to 64k. Larger cell values require larger blocksizes.
REPLICATION_SCOPEintegerIt is a column-family level attribute and its value can be either 0 or 1. A value of 0 means replication is disabled, and 1 means replication is enabled.
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - It will check the value of the latest version of a cell and if there is a match puts new data into the same cell

Runtime Class - com.ibi.agents.XDHBaseUpdateCell


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Row Key:stringRow key
Column:stringColumn family with qualifer(family:qualifer)
New cell Value:stringNew Cell Value
Existing Cell Value:stringExisting Cell Value
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument returned by operation

Select from one of the following options:
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Multi-Get a specified number of versions of a given cell
 
Runtime Class - com.ibi.agents.XDHBaseMGNumberVervionofCell

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
  Table: string Name of the table
  Row Key: string Row key is used to identify a row in a table
  Column: string Column family with qualifer(family:qualifer)
  Version: integer Number of versions of a given cell
* - denotes required
  Parameter Type Description
* Type: string Format of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
  Parameter Type Description
* Output Document: string Document returned by operation

Select from one of the following options:
  • Result Document {result} - Return results of the operation
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

 

Output Events

 

Name Description
OnFailConnection Could not connect to the external system.
OnFailRedirection Redirection status code between 300 and 399.
OnFailClientError Client error status code between 400 and 499.
OnFailServerError Server error status code between 500 and 599.
OnFailedOperation Could not perform the operation requested.
OnParseError Could not parse a document.
OnFailLargeRequest Request entity size exceeds configured maximum.
OnFailLargeResponse Response entity size exceeds configured maximum.
OnHTTP-201 Created The request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad Request The data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 Unauthorized The supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not Found Resource not found.
OnHTTP-405 Method Not Allowed You can't POST or PUT to the resource.
OnHTTP-429 Too Many Requests Your application is sending too many simultaneous requests.
OnHTTP-500 Server Error We couldn't create or update the resource. Please try again.
Description - Get version of HBase running on this cluster
 
Runtime Class - com.ibi.agents.XDHBaseClusterVersion

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
* Type: string Format of the return result document.

Select from one of the following options:
  • XML {xml}
  • TEXT {text}
* - denotes required
  Parameter Type Description
* Output Document: string Document returned by operation

Select from one of the following options:
  • Result Document {result} - Return results of the operation
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

 

Output Events

 

Name Description
OnFailConnection Could not connect to the external system.
OnFailRedirection Redirection status code between 300 and 399.
OnFailClientError Client error status code between 400 and 499.
OnFailServerError Server error status code between 500 and 599.
OnFailedOperation Could not perform the operation requested.
OnParseError Could not parse a document.
OnFailLargeRequest Request entity size exceeds configured maximum.
OnFailLargeResponse Response entity size exceeds configured maximum.
OnHTTP-201 Created The request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad Request The data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 Unauthorized The supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not Found Resource not found.
OnHTTP-405 Method Not Allowed You can't POST or PUT to the resource.
OnHTTP-429 Too Many Requests Your application is sending too many simultaneous requests.
OnHTTP-500 Server Error We couldn't create or update the resource. Please try again.
Description - Get the value of a single column for a row
 
Runtime Class - com.ibi.agents.XDHBaseColumnValue

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
  Table: string Name of the table
  Row Key: string Row key is used to identify a row in a table
  Column: string Column family with qualifer(family:qualifer)
* - denotes required
  Parameter Type Description
* Type: string Format of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
  Parameter Type Description
* Output Document: string Document returned by operation

Select from one of the following options:
  • Result Document {result} - Return results of the operation
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

 

Output Events

 

Name Description
OnFailConnection Could not connect to the external system.
OnFailRedirection Redirection status code between 300 and 399.
OnFailClientError Client error status code between 400 and 499.
OnFailServerError Server error status code between 500 and 599.
OnFailedOperation Could not perform the operation requested.
OnParseError Could not parse a document.
OnFailLargeRequest Request entity size exceeds configured maximum.
OnFailLargeResponse Response entity size exceeds configured maximum.
OnHTTP-201 Created The request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad Request The data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 Unauthorized The supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not Found Resource not found.
OnHTTP-405 Method Not Allowed You can't POST or PUT to the resource.
OnHTTP-429 Too Many Requests Your application is sending too many simultaneous requests.
OnHTTP-500 Server Error We couldn't create or update the resource. Please try again.
Description - Get rows by timestamps

Runtime Class - com.ibi.agents.XDHBaseScanTableByTimestampsFilter


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Table:stringName of the table
Batch:integerThe max number of rows the scan should return in a batch
Table of Timestamp:Table (as described below) Filter that returns only cells whose timestamp (version) is in the specified list of timestamps
* - denotes required

Table of Timestamp:
 ColumnTypeDescription
TimestampintegerTimestamp
* - denotes required
 ParameterTypeDescription
*Type:stringFormat of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required

Table of Timestamp:
 ColumnTypeDescription
TimestampintegerTimestamp
* - denotes required
 ParameterTypeDescription
*Output Document:stringDocument returned by operation

Select from one of the following options:
  • Result Document {result} - Return results of the operation
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

Table of Timestamp:
 ColumnTypeDescription
TimestampintegerTimestamp
* - denotes required

Output Events

NameDescription
OnFailConnectionCould not connect to the external system.
OnFailRedirectionRedirection status code between 300 and 399.
OnFailClientErrorClient error status code between 400 and 499.
OnFailServerErrorServer error status code between 500 and 599.
OnFailedOperationCould not perform the operation requested.
OnParseErrorCould not parse a document.
OnFailLargeRequestRequest entity size exceeds configured maximum.
OnFailLargeResponseResponse entity size exceeds configured maximum.
OnHTTP-201 CreatedThe request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad RequestThe data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 UnauthorizedThe supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not FoundResource not found.
OnHTTP-405 Method Not AllowedYou can't POST or PUT to the resource.
OnHTTP-429 Too Many RequestsYour application is sending too many simultaneous requests.
OnHTTP-500 Server ErrorWe couldn't create or update the resource. Please try again.
Description - Get rows by start row and limit number of row
 
Runtime Class - com.ibi.agents.XDHBaseGetTableInfoByStartRowKeyandRowNum

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
  Table: string Name of the table
  Row Key: string Start Row Key
  Number: integer Limit number of row
* - denotes required
  Parameter Type Description
* Type: string Format of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
  Parameter Type Description
* Output Document: string Document returned by operation

Select from one of the following options:
  • Result Document {result} - Return results of the operation
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

 

Output Events

 

Name Description
OnFailConnection Could not connect to the external system.
OnFailRedirection Redirection status code between 300 and 399.
OnFailClientError Client error status code between 400 and 499.
OnFailServerError Server error status code between 500 and 599.
OnFailedOperation Could not perform the operation requested.
OnParseError Could not parse a document.
OnFailLargeRequest Request entity size exceeds configured maximum.
OnFailLargeResponse Response entity size exceeds configured maximum.
OnHTTP-201 Created The request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad Request The data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 Unauthorized The supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not Found Resource not found.
OnHTTP-405 Method Not Allowed You can't POST or PUT to the resource.
OnHTTP-429 Too Many Requests Your application is sending too many simultaneous requests.
OnHTTP-500 Server Error We couldn't create or update the resource. Please try again.
Description - Get rows by single column value
 
Runtime Class - com.ibi.agents.XDHBaseScanTableBySingleColumnValueFilter

 

Configuration

This action requires a Generics Configuration as well as the following required parameters.
 

Parameter Groups

  Parameter Type Description
  Table: string Name of the table
  Batch: integer The max number of rows the scan should return in a batch
  Column Family: string Column family
  Column Qualifier: string Column qualifier
  Latest Version: boolean It is used to check if only the latest version's value is tested and all previous versions are ignored
  Operator: string Compare Operator

Select from one of the following options:
  • greater than {GREATER}
  • less than {LESS}
  • equal to {EQUAL}
  Cell Value: string This filter is used to filter cells based on the value.
* - denotes required
  Parameter Type Description
* Type: string Format of the return result document.

Select from one of the following options:
  • XML {xml}
  • JSON {json}
* - denotes required
  Parameter Type Description
* Output Document: string Document returned by operation

Select from one of the following options:
  • Result Document {result} - Return results of the operation
  • Status Document {status} - Return status document
  • Input Document {input} - Return the document passed in
* - denotes required

 

Output Events

 

Name Description
OnFailConnection Could not connect to the external system.
OnFailRedirection Redirection status code between 300 and 399.
OnFailClientError Client error status code between 400 and 499.
OnFailServerError Server error status code between 500 and 599.
OnFailedOperation Could not perform the operation requested.
OnParseError Could not parse a document.
OnFailLargeRequest Request entity size exceeds configured maximum.
OnFailLargeResponse Response entity size exceeds configured maximum.
OnHTTP-201 Created The request was successful, we created a new resource and the response body contains the representation.
OnHTTP-400 Bad Request The data given in the POST or PUT failed validation. Inspect the response body for details.
OnHTTP-401 Unauthorized The supplied credentials, if any, are not sufficient to create or update the resource.
OnHTTP-404 Not Found Resource not found.
OnHTTP-405 Method Not Allowed You can't POST or PUT to the resource.
OnHTTP-429 Too Many Requests Your application is sending too many simultaneous requests.
OnHTTP-500 Server Error We couldn't create or update the resource. Please try again.