← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-happybase/trusty

« back to all changes in this revision

Viewing changes to doc/api.rst

  • Committer: Package Import Robot
  • Author(s): Thomas Goirand
  • Date: 2013-05-30 13:56:42 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20130530135642-tveld2y1dbkhmuv3
Tags: 0.6-1
http://bugs.debian.org/712971
* New upstream release (Closes: #712971).
* Ran wrap-and-sort.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api.rst
1
 
*****************
2
 
API documentation
3
 
*****************
 
1
=============
 
2
API reference
 
3
=============
4
4
 
5
5
.. py:currentmodule:: happybase
6
6
 
7
7
This chapter contains detailed API documentation for HappyBase. It is suggested
8
 
to read the :doc:`tutorial <tutorial>` first to get a general idea about how
 
8
to read the :doc:`user guide <user>` first to get a general idea about how
9
9
HappyBase works.
10
10
 
11
11
The HappyBase API is organised as follows:
25
25
   The :py:class:`Batch` class implements the batch API for data manipulation,
26
26
   and is available through the :py:meth:`Table.batch()` method.
27
27
 
 
28
:py:class:`~happybase.ConnectionPool`:
 
29
   The :py:class:`ConnectionPool` class implements a thread-safe connection
 
30
   pool that allows an application to (re)use multiple connections.
 
31
 
28
32
 
29
33
Connection
30
34
==========
44
48
.. autoclass:: happybase.Batch
45
49
 
46
50
 
 
51
Connection pool
 
52
===============
 
53
 
 
54
.. autoclass:: happybase.ConnectionPool
 
55
 
 
56
.. autoclass:: happybase.NoConnectionsAvailable
 
57
 
 
58
 
47
59
.. vim: set spell spelllang=en: