- Index

< Previous |  | Next >

# Using the HBase Put Operator

## Introduction

The TIBCO StreamBase® Adapter for Apache HBase is implemented as a suite of five global Java operators, including the HBase Admin, Delete, Get, Put, and Scan operators.

This page describes the HBase Put operator, which allows a StreamBase application to insert data into a connected HBase database table. The operator uses property values in the project's server configuration file to set up the connection to the HBase database, as described in Configuration File Settings. Multiple HBase operators can share a single instance of an HBase connection by selecting the same HBase configuration setting ID.

## Configuration File Settings

This section describes the configuration for an HBase database connection instance that you specify in your project's sbconf file. This configuration is the same for all HBase operator types.

### HBase Operator Configuration

The `<adapter-configurations>` element of a project's sbconf file, despite its name, is used to specify configuration value groups for either operators or adapters.

The HBase configuration section of the sbconf file starts with an `<adapter-configurations>` element that contains one `<adapter-configuration 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 name="id" val="`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`.

Example 1. Example <adapter-configuration> Section for HBase

      <adapter-configurations>
        <adapter-configuration name="hbase">
          <section name="hbase">
            <setting name="id" val="HBase Sample"/>
            <setting name="connectAtStartup" val="true" />

            <!-- All values below are passed directly to the
                 HBaseConfiguration class unmodified --/>
            <setting name="hbase.master" val="127.0.0.1:60000" />
            <setting name="hbase.zookeeper.quorum" val="127.0.0.1" />
            <setting name="hbase.zookeeper.property.clientPort" val="2181" />
            <setting name="hbase.client.retries.number" val="5" />
            <setting name="zookeeper.session.timeout" val="5000" />
            <setting name="zookeeper.recovery.retry" val="5" />
          </section>
        </adapter-configuration>
      </adapter-configurations>

### Configuration Settings

Setting | Type | Description
--- | --- | ---
id | string | The value of the `id` setting displays in the drop-down list in the adapter's Properties view, and is used to uniquely identify this section of the configuration file.
connectAtStartup | true or false | If true, this operator instance connects to HBase on startup of this operator's containing module.
*** | string | All other values are directly sent to the HBaseConfiguration class, which is responsible for setting up a connection to the HBase server. See the Apache HBase documentation for the available client configuration options and for further information on setting up a connection to HBase.

## Properties View Settings

This section describes the properties you can set for an HBase Put operator, using the various tabs of the Properties view in StreamBase Studio.

### General Tab

Name: Use this required field to specify or change the component's name, which must be unique in the current module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.

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

Class: 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 with application: If this field is set to Yes (default) or to a module parameter that evaluates to `true`, this instance of this operator starts as part of the JVM engine that runs this EventFlow fragment. If this field is set to No or to a module parameter that evaluates to `false`, the operator instance is loaded with the engine, but does not start until you send an epadmin container resume command (or its sbadmin equivalent), or until you start the component with StreamBase Manager.

Enable Error Output Port: Select this check box 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 component's purpose and function. In the EventFlow canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

### Operator Properties Tab

Property | Type | Description
--- | --- | ---
HBase Config | drop-down list | The name of the HBase configuration to use with this operator. The value selected by this drop-down list determines the database connection this operator works against. The values that populate this list are stored in the project's sbconf file, as described in the Configuration File Settings section.
Table Name | string | The HBase table that this operation is to be performed against.
Enable Status Port | check box | If enabled, a status port is made available for this operator instance, which will emit status tuples for various events from this operator.
Log Level | drop-down list | Controls the level of verbosity the adapter uses to issue informational traces to the console. This setting is independent of the containing application's overall log level. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE.

### Field Map Tab

Property | Type | Description
--- | --- | ---
Data Field Name | string | The field in the incoming schema that contains the tuple or list of tuples to use for the Put operation. If this field is blank, the full incoming tuple is used.
Row Id Field Name | string | The field in the incoming schema that contains the field to be used as the row ID.
Field Map | field grid | The field map used to determine which fields of the incoming schema map to the family:columns of the HBase table. If this contains no rows, auto-matching is used. Auto-matching requires the input schema have only tuples for the upper level fields that represent the family names. The sub fields of the tuples represent the columns. The input schema may also be a list of tuples containing family, column, and value fields.

### Concurrency 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.

### Caution

Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.

## Input Schema

This section describes the input schema for the HBase Put operator, which allows for two different kinds of schema inputs. One method is a list of family and column value pairs, while the other is a well-defined set of family tuples with sub-data.

### Family and Column Tuple Input Schema

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
      >

### Family and Column Value List Input Schema

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,
        >
      >

## Related Topics

- Using the HBase Admin Operator

- Using the HBase Delete Operator

- Using the HBase Get Operator

- Using the HBase Scan Operator