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 --------