document connection pooling, fixes #211

Browse Source
This commit is contained in:
Friedrich Lindenberg 2017-09-02 08:36:09 +02:00
parent 348fdf3f94
commit f9d4113742
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api.rst
View File

@ -2,8 +2,18 @@
API documentation
=================
Connecting
----------
.. autofunction:: dataset.connect
Notes
-----
* **dataset** uses SQLAlchemy connection pooling when connecting to the
database. There is no way of explicitly clearing or shutting down the
connections, other than having the dataset instance garbage collected.
Database
--------