Opened 9 months ago

Closed 9 months ago

Last modified 9 months ago

#35249 closed Bug (invalid)

DISABLE_SERVER_SIDE_CURSORS is not documented as a connection setting

Reported by: Johannes Maron Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Johannes Maron Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

DISABLE_SERVER_SIDE_CURSORS is documented as a Django setting when it is in fact a connection setting.

See also:

​https://docs.djangoproject.com/en/5.0/ref/settings/#disable-server-side-cursors
​https://github.com/django/django/blob/6e1ece7ed522c904a674966fa985159b7bbf1545/django/db/models/query.py#L540-L542

The correct usage is:

# settings.py

DATABASES = {
    "default": {
        # …
        "DISABLE_SERVER_SIDE_CURSORS": True,
    },
}

Change History (2)

comment:1 by Mariusz Felisiak, 9 months ago

Resolution: → invalid
Status: new → closed

DISABLE_SERVER_SIDE_CURSORS is documented in the DATABASES setting, just like ENGINE, `NAME, etc. As far as I'm aware, it's in the right place.

comment:2 by Johannes Maron, 9 months ago

Oh, how awkward… 😳 I missed that. Eventually, the DB settings might deserve their own page. Until then I will read better 🤓

Note: See TracTickets for help on using tickets.
Back to Top