Using the HBase Put Operator

The <HBase.conf> element of a project's HOCON file, despite its name, is used to specify configuration value groups for either operators or adapters.

The HBase configuration section of the HOCON file starts with an <HBase.conf> element that contains one <HBase.conf name="hbase"> element. This element, in turn, contains one or more <setting> elements.

Each <section name="hbase"> element must contain one element in the form <setting id="HBaseConfigName"/>, where HBaseConfigName is the name you assign to a group of settings that uniquely define an individual HBase database connection. All other <setting> elements are optional.

The example configuration below shows a basic configuration to connect to an HBase server. You can have as many configurations as your application requires, but each configuration must have a unique id.

name = "HBase.conf"
type = "com.tibco.ep.streambase.configuration.adapter"
version = "1.0.0"
configuration = {
          
// An adapter group type defines a collection of EventFlow adapter configurations,
// indexed by adapter type.
  AdapterGroup = {
          
// A collection of EventFlow adapter configurations, indexed by adapter type. 
// This object is required and must contain at least one configuration.
    adapters = {
          
// The root section for an EventFlow adapter configuration.
      hbase = {
          
// Section list. This array is optional and has no default value.
        sections = [
          
// A configuration for an EventFlow adapter named section.
            {
          
// Section name. The value does not have to be unique; that is, you can have multiple sections
// with the same name in the same array of sections. This property is required.
              name = "hbase"
          
// Section for setting adapter properties. All values must be strings. This object
// is optional and has no default value.
                settings = {
                  connectAtStartup = "true"
                  "hbase.client.retries.number" = "5"
                  "hbase.master" = "127.0.0.1:60000"
                  "hbase.zookeeper.property.clientPort" = "2181"
                  "hbase.zookeeper.quorum" = "127.0.0.1"
                  id = "HBase Demo"
                  "zookeeper.recovery.retry" = "5"
                  "zookeeper.session.timeout" = "5000"
            }
          }
        ]
      }
    }
  }
}

Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.

Operator: A read-only field that shows the formal name of the operator.

Class name: Shows the fully qualified class name that implements the functionality of this operator. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this operator starts.

Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.

Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.

Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.

This form of input schema must contain only Tuples on the top level, with the exception of a rowId field. The Tuples provided represent the family names in the table. The sub-fields of these tuples represent the column names and values to be created or updated.

Example Schema

  rowId (anyType),
  Family1 tuple<
    column1 string,
    column2 double,
    column3 int
  >,
  Family2 tuple<
    column1 timestamp,
    column2 long,
    column3 blob
  >

This form of input schema allows for a single list containing a predefined tuple schema with family, column, and value fields.

Example Schema

  rowId (anyType)
  familyColumnValues list<
    tuple<
      family string,
      column string,
      value anyType,
    >
  >