API reference

This chapter contains detailed API documentation for HappyBase. It is suggested to read the user guide first to get a general idea about how HappyBase works.

The HappyBase API is organised as follows:

Connection:

The Connection class is the main entry point for application developers. It connects to the HBase Thrift server and provides methods for table management.

Table:

The Table class is the main class for interacting with data in tables. This class offers methods for data retrieval and data manipulation. Instances of this class can be obtained using the Connection.table() method.

Batch:

The Batch class implements the batch API for data manipulation, and is available through the Table.batch() method.

ConnectionPool:

The ConnectionPool class implements a thread-safe connection pool that allows an application to (re)use multiple connections.

Connection

Table

Batch

Connection pool