Skip to content

🔧 Add envvar to disable server side cursors #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevenbal merged 2 commits into from
Jul 22, 2025
Merged

🔧 Add envvar to disable server side cursors #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
113f096
:wrench: Disable server side cursors
stevenbal Jul 21, 2025
0fe6116
:wrench: Add envvar to disable server side cursors
stevenbal Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/installation/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Database
* ``DB_POOL_MAX_IDLE``: Maximum time, in seconds, that a connection can stay unused in the pool before being closed, and the pool shrunk. This only happens to connections more than min_size, if max_size allowed the pool to grow. Defaults to: ``600``.
* ``DB_POOL_RECONNECT_TIMEOUT``: Maximum time, in seconds, the pool will try to create a connection. If a connection attempt fails, the pool will try to reconnect a few times, using an exponential backoff and some random factor to avoid mass attempts. If repeated attempts fail, after reconnect_timeout second the connection attempt is aborted and the reconnect_failed() callback invoked. Defaults to: ``300``.
* ``DB_POOL_NUM_WORKERS``: Number of background worker threads used to maintain the pool state. Background workers are used for example to create new connections and to clean up connections when they are returned to the pool. Defaults to: ``3``.
* ``DB_DISABLE_SERVER_SIDE_CURSORS``: Whether or not server side cursors should be disabled for Postgres connections. Setting this to true is required when using a connection pooler in transaction mode (like PgBouncer). **WARNING:** the effect of disabling server side cursors on performance has not been thoroughly tested yet. Defaults to: ``False``.


Logging
Expand Down
13 changes: 13 additions & 0 deletions src/objects/conf/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@

from .api import * # noqa

DATABASES["default"]["DISABLE_SERVER_SIDE_CURSORS"] = config(
"DB_DISABLE_SERVER_SIDE_CURSORS",
False,
help_text=(
"Whether or not server side cursors should be disabled for Postgres connections. "
"Setting this to true is required when using a connection pooler in "
"transaction mode (like PgBouncer). "
"**WARNING:** the effect of disabling server side cursors on performance has not "
"been thoroughly tested yet."
),
group="Database",
)

DATABASES["default"]["ENGINE"] = "django.contrib.gis.db.backends.postgis"

# Application definition
Expand Down