Simple HBase ORM

When dealing with data stored in HBase, you are quick to come to a conclusion, that it is extremaly inconvenient to reach to it via HBase native API. It is very verbose and you always need to convert between bytes and simple types – a pain. While I wa…When dealing with data stored in HBase, you are quick to come to a conclusion, that it is extremaly inconvenient to reach to it via HBase native API. It is very verbose and you always need to convert between bytes and simple types – a pain. While I wa…

When dealing with data stored in HBase, you are quick to come to a
conclusion, that it is extremaly inconvenient to reach to it
via HBase native API. It is very verbose and you always need to convert
between bytes and simple types – a pain.

While I was working on a project of mine, I thought, why not to easy
those pains and fetch real objects from HBase.

And that’s how this simplistic, hackish ORM came to life. It is no match
for projects like Kundera
(a JPA compliant solution), or n-orm. Nevertheless, it just suits my needs :)

Project sources are hosted on GitHub: https://github.com/zygm0nt/hbase-annotations

To make use of this, you need to have an entity class with annotations:

  • @Column – with argument specifying column family and column name, ie.
    @Column(“cf:column-name”)
  • @Id – will store row key in this property,
  • and optionaly @Value – for Spring Expression Language, in case you
    need to perform some extraction on the value.

Annotations should be on setter methods.

Now you have your model annotated and ready to be fetched from HBase.

The actual work is done with a service class, that should extend class
BaseHadoopInteraction just as class
SimpleHBaseClient does.

Then it is possible to just call:

Note that there are more methods you can use on BaseHadoopInteraction.
You can also do:

  • scan
  • scan with key ranges
  • delete

What you won’t get from this simple ORM is:

  • automatic object updating,
  • nested objects,
  • saving to HBase – ’cause I didn’t have a need for that,

Hope you’ll find this piece of code useful. If you see room for
improvements while staying in project’s scope – please drop me a
message.

And if you are searching for a full-fledged ORM solution for interacting with HBase, just head
straight to Kundera project website :)

You May Also Like

Hibernate hbm2ddl won’t create schema before creating tables

Situation I have a local H2 in memory database for integration tests and an Oracle db for production. I do not control the Oracle DB model. The in memory H2 database is created automatically by adding <prop key="hibernate.hbm2ddl.auto">update&l...Situation I have a local H2 in memory database for integration tests and an Oracle db for production. I do not control the Oracle DB model. The in memory H2 database is created automatically by adding <prop key="hibernate.hbm2ddl.auto">update&l...

Mock Retrofit using Dagger and Mockito

Retrofit is one of the most popular REST client for Android, if you never use it, it is high time to start. There are a lot of articles and tutorial talking about Retrofit. I just would like to show how to mock a REST server during develop of app and i...Retrofit is one of the most popular REST client for Android, if you never use it, it is high time to start. There are a lot of articles and tutorial talking about Retrofit. I just would like to show how to mock a REST server during develop of app and i...