From f9d411374272d4c6d4fac8c47402d650bf0a7fc9 Mon Sep 17 00:00:00 2001 From: Friedrich Lindenberg Date: Sat, 2 Sep 2017 08:36:09 +0200 Subject: [PATCH] document connection pooling, fixes #211 --- docs/api.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index 5770e59..aa80987 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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 --------