An set of mixins and classes for interacting with PostgreSQL using asyncio in Tornado / sprockets.http applications using aiopg.
sprockets-postgres
is available on the Python package index and is installable via pip:
pip install sprockets-postgres
Documentation is available at sprockets-postgres.readthedocs.io.
Configuration of sprockets-postgres is done by using of environment variables or tornado.web.Application.settings dictionary. The sprockets_postgres.ApplicationMixin will use configuration as applied to the settings dictionary, falling back to the environment variable if the value is not set in the dictionary. Keys in the settings dictionary are lowercase, and if provided as environment variables, are uppercase.
The following table details the available configuration options:
Variable | Definition | Type | Default |
---|---|---|---|
postgres_url |
The PostgreSQL URL to connect to | str | |
postgres_max_pool_size |
Maximum connection count to Postgres per backend | int | 10 |
postgres_min_pool_size |
Minimum or starting pool size. | int | 1 |
postgres_connection_timeout |
The maximum time in seconds to spend attempting to create a new connection. | int | 10 |
postgres_connection_ttl |
Time-to-life in seconds for a pooled connection. | int | 300 |
postgres_query_timeout |
Maximum execution time for a query in seconds. | int | 60 |
postgres_hstore |
Enable HSTORE support in the client. | bool | FALSE |
postgres_json |
Enable JSON support in the client. | bool | FALSE |
postgres_uuid |
Enable UUID support in the client. | bool | TRUE |
If postgres_url
uses a scheme of postgresql+srv
, a SRV DNS lookup will be
performed and the lowest priority record with the highest weight will be selected
for connecting to Postgres.
AWS's ECS service discovery does not follow the SRV standard, but creates SRV
records. If postgres_url
uses a scheme of aws+srv
, a SRV DNS lookup will be
performed and the URL will be constructed containing all host and port combinations
in priority and weighted order, utilizing libpq's supoprt
for multiple hosts in a URL.
Available at https://sprockets-postgres.readthedocs.org/en/latest/history.html