Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Creating an HBase data set record

Updated on May 17, 2024

Configure an instance of the HBase data set rule to read data from and save it to an external HBase storage.

Before you begin: Before you can connect to an Apache HBase or HDFS data store, upload the relevant client JAR files into the application container with Pega Platform. For more information, see HDFS and HBase client and server versions supported by Pega Platform.
  1. Create an instance of the HBase data set rule:
    1. In the header of Dev Studio, click CreateData ModelData Set.
    2. In the Label field, enter a short description for your data set.
    3. In the Type field, select HBase.
    4. In the Context section, select the application context, class, and ruleset for the data set.
      For more information about the fields on this form, see Creating a rule.
    5. Click Create and Open.
  2. On the Edit data set tab, connect to a Hadoop configuration instance:
    1. In the Hadoop configuration instance field, select the Hadoop configuration rule that contains HBase storage configuration.
      You can create a Hadoop configuration instance by clicking the Target icon on the right side of the field.
    2. Click Test connectivity.
  3. Configure the mapping between the fields that are stored in an HBase table and properties in the Pega Platform by performing the following actions:
    1. Optional: Click Refresh table names.
    2. In the HBase table name field, select a table that is available in the HBase storage to which you are connected.
    3. Click Preview table to see the first 100 row IDs and all column families defined in the table schema, and then select a row ID and a column family to view data in the selected table.
      When you preview the data, it helps you to define the property mappings.
    4. In the Row ID field, specify a property that contains a row ID.
      A row ID uniquely identifies a single row in an HBase table. The HBase data set rule instance that you are configuring will perform all operations on a row identified by the row ID.
    5. Click Add mapping.
    6. In the HBase column field, specify a name of the field that is stored in the HBase table.
      Use the following format: <column_family>:<column_name>, for example, total:expenses.
      Note: You can specify just a column family name and map it to the page list property of Embed-NameValuePair type or page group property of SingleValue-Text type. In this case, all the column values are put into a list, using the pyName or pxSubscript property for the column name, and pyValue for the value.
    7. In the Property Name field, specify a property in Pega Platform.
    8. Repeat steps 3.e through 3.g to map more properties.
  4. Click Save.
  • Previous topic Connecting to an external Cassandra database through a Database Table data set
  • Next topic Configuring Hadoop settings for an HBase connection

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us