Skip to content
This repository was archived by the owner on Aug 26, 2021. It is now read-only.

Commit c0f90ff

Browse files
committed
Added some light explanation of config options to readme.
1 parent 3efffe3 commit c0f90ff

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,18 @@ Optionally, you can provide additional options to pass to SQLAlchemy's pool crea
5555
'recycle': 300
5656
}
5757

58+
Here's a basic explanation of two of these options:
59+
60+
* **pool_size** – The *minimum* number of connections to maintain in the pool.
61+
* **max_overflow** – The maximum *overflow* size of the pool. This is not the maximum size of the pool.
62+
63+
The total number of "sleeping" connections the pool will allow is ``pool_size``.
64+
The total simultaneous connections the pool will allow is ``pool_size + max_overflow``.
65+
66+
As an example, databases in the `Heroku Postgres <https://postgres.heroku.com>`_ starter tier have a maximum connection limit of 20. In that case your ``pool_size`` and ``max_overflow``, when combined, should not exceed 20.
67+
68+
Check out the official `SQLAlchemy Connection Pooling <http://docs.sqlalchemy.org/en/latest/core/pooling.html#sqlalchemy.pool.QueuePool.__init__>`_ docs to learn more about the optoins that can be defined in ``DATABASE_POOL_ARGS``.
69+
5870
Django 1.3 Support
5971
------------------
6072

0 commit comments

Comments
 (0)