- Index

< Previous |  | Next >

# HBase Operator Samples

## About These Samples

This topic describes how to run the HBase Operator sample applications, which illustrates how to use the HBase operators when connecting a StreamBase application to an HBase server. For more information on these operators, see Using Global Java Operators.

There are two samples included with the HBase sample package. The first sample, `Demo.sbapp`, demonstrates a complete process of creating a table, inserting data, updating data, getting data, and deleting rows all in a single flow. The second sample, `DemoSteps.sbapp`, breaks this process down to demonstrate how each HBase operator works, one at a time.

## Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

- From the top-level menu, select File → Load StreamBase Sample.

- Enter `hb` to narrow the list of options.

- Select Apache HBase operators from the Large Data Storage and Analysis category.

- Click OK.

StreamBase Studio creates a single project for the HBase operator samples in your current Studio workspace.

## Automated Sample

The `Demo.sbapp` sample includes a number of HBase adapters, which by default connect to the HBase server identified in the project's `adapter-configurations.xml` file. Before running this demo, you must edit this file with the configuration details to connect to your currently running HBase server. Once connected, the sample automatically creates a table and starts to send and receive data. When the sample finishes running, the table it created is deleted.

### Running Demo.sbapp in StreamBase Studio

1. In the Project Explorer view, open the sample you just loaded.

   If you see red marks on a project folder, wait a moment for the project to load its features.

   If the red marks do not resolve themselves in a moment, select the project and right-click Maven → Update Project from the context menu.

2. Open the `src/main/eventflow/`packageName`` folder.

3. Before running, you must configure the sample project with the your site's HBase server information. In the Project Explorer, locate the `adapter-configurations.xml` file in the `src/main/resources` directory and open it. Be sure to edit the following settings:

   1. `hbase.master` — Change the val attribute to point to the HBase server and port you want to use.

   2. `hbase.zookeeper.quorum` — Change the val attribute to point to the ZooKeeper server you want to use.

   3. `hbase.zookeeper.property.clientPort` — Change the val attribute to point to the ZooKeeper server's client port.

4. Open the `Demo.sbapp` file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

5. Observe the results in the output views.

6. When done, press F9 or click the Terminate EventFlow Fragment button.

## Step-by-Step Sample

The second sample, `DemoSteps.sbapp`, shows how each HBase operator is used individually.

The `DemoSteps.sbapp` sample includes a number of HBase operators, which by default connect to the HBase server defined in the project's `adapter-configurations.xml` file when the application starts. Before running this demo, you must edit this file to provide the communication details to connect to your currently running HBase server.

### Running DemoSteps.sbapp in StreamBase Studio

1. Continuing with the same sample project folder, open the `DemoSteps.sbapp` file.

2. Click the Run button. This opens the SB Test/Debug perspective and starts the module.

3. In the Manual Input view, select the `InAdminCreateTable` input stream.

   Click Send Data. This causes a tuple to be sent to an HBase Admin operator that in turn causes a table to be created in the database. Now, observe that the `AdminCreateTableStatus` output stream receives a tuple with status information indicating the table was created.

4. In the Manual Input view, select the `InGenerateRows` input stream.

   Click Send Data. This causes a list of generated tuples to be sent to an HBase Put operator, which causes data to the inserted into the HBase table. Observe that the `PutOut` output stream shows the values inserted.

5. In the Manual Input view, select the `InUpdateRow` input stream.

   Click Send Data. This sends a tuple to an HBase Put operator, which causes the previously sent data's first row to be updated with new values. Observe that the `UpdateOut` output stream shows the values updated.

6. In the Manual Input view, select the `InGet` input stream.

   Enter a rowId value of either 1, 2, 3, 4, or 5 into the rowId field.

   Click Send Data. This triggers trigger the HBase Get operator to fetch the row updated in the previous step from HBase. Observe that the `GetOut` output stream shows the values received.

7. In the Manual Input view, select the `InScan` input stream.

   Click Send Data. This causes an HBase Scan operator to fetch all rows from HBase. Observe in the `ScanOut` output stream that these row values are received.

8. In the Manual Input view, select the `InScanWithFilter` input stream.

   Enter the following values:

   1. In the family field enter: `Family1`

   2. In the column field, enter: `Column4`

   3. In the matchSubString field, enter: `1`

   Click Send Data. This triggers the HBase Scan operator to fetch a filtered set of rows from HBase. Observe that the `ScanWithFilterOut` output stream shows a single row received.

9. In the Manual Input view, select the `InDelete` input stream.

   Click Send Data. This causes the HBase Scan operator to fetch all rows, then feed the rowIds of those rows into the HBase Delete operator to delete those rows from HBase. Observe that the `DeleteOut` output stream shows the rows deleted.

10. When done, press F9 or click the Terminate EventFlow Fragment button.

## Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

### Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

    studio-workspace/sample_adapter_embedded_hbase

See Default Installation Directories for the default location of `studio-workspace` on your system.