From c0f90ffc042e931e2bc319361eac7ee9dec74786 Mon Sep 17 00:00:00 2001 From: Michael Whalen Date: Mon, 15 Apr 2013 16:31:50 +0200 Subject: [PATCH] Added some light explanation of config options to readme. --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index c500e7c..88f8008 100644 --- a/README.rst +++ b/README.rst @@ -55,6 +55,18 @@ Optionally, you can provide additional options to pass to SQLAlchemy's pool crea 'recycle': 300 } +Here's a basic explanation of two of these options: + +* **pool_size** – The *minimum* number of connections to maintain in the pool. +* **max_overflow** – The maximum *overflow* size of the pool. This is not the maximum size of the pool. + +The total number of "sleeping" connections the pool will allow is ``pool_size``. +The total simultaneous connections the pool will allow is ``pool_size + max_overflow``. + +As an example, databases in the `Heroku Postgres `_ starter tier have a maximum connection limit of 20. In that case your ``pool_size`` and ``max_overflow``, when combined, should not exceed 20. + +Check out the official `SQLAlchemy Connection Pooling `_ docs to learn more about the optoins that can be defined in ``DATABASE_POOL_ARGS``. + Django 1.3 Support ------------------