api.rst

API reference

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

The AIOHappyBase API is organised as follows:

:py~aiohappybase.Connection:

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

:py~aiohappybase.Table:

The :pyTable 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 :pyConnection.table() method.

:py~aiohappybase.Batch:

The :pyBatch class implements the batch API for data manipulation, and is available through the :pyTable.batch() method.

:py~aiohappybase.ConnectionPool:

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

Connection

aiohappybase.Connection

Table

aiohappybase.Table

Batch

aiohappybase.Batch

Connection pool

aiohappybase.ConnectionPool

aiohappybase.NoConnectionsAvailable