blob: 2b1e3b73507ba7139cc7dc75eedd484b6b496c24 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
=============
API reference
=============
.. py:currentmodule:: happybase
This chapter contains detailed API documentation for HappyBase. It is suggested
to read the :doc:`user guide <user>` first to get a general idea about how
HappyBase works.
The HappyBase API is organised as follows:
:py:class:`~happybase.Connection`:
The :py:class:`~happybase.Connection` class is the main entry point for
application developers. It connects to the HBase Thrift server and provides
methods for table management.
:py:class:`~happybase.Table`:
The :py:class:`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
:py:meth:`Connection.table()` method.
:py:class:`~happybase.Batch`:
The :py:class:`Batch` class implements the batch API for data manipulation,
and is available through the :py:meth:`Table.batch()` method.
:py:class:`~happybase.ConnectionPool`:
The :py:class:`ConnectionPool` class implements a thread-safe connection
pool that allows an application to (re)use multiple connections.
Connection
==========
.. autoclass:: happybase.Connection
Table
=====
.. autoclass:: happybase.Table
Batch
=====
.. autoclass:: happybase.Batch
Connection pool
===============
.. autoclass:: happybase.ConnectionPool
.. autoclass:: happybase.NoConnectionsAvailable
.. vim: set spell spelllang=en:
|
