#35016: Missing documentation for setting libpq options with the PostgreSQL
backend
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: Yashas
Type: | Donthi
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Yashas Donthi):
* has_patch: 0 => 1
Old description:
> As far as I can see, when a database uses the
> `django.db.backends.postgresql` engine, any options from the `OPTIONS`
> key that are not recognized by the engine itself are passed directly to
> the underlying libpq library. This way you can set options like
> [https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-
> CONNECT-SSLMODE `sslmode`].
>
> But this doesn't seem to actually be documented anywhere, so it's unclear
> whether this is actually a supported feature or just an implementation
> artifact.
>
> If this really is supported, then it should be documented - presumably in
> [https://docs.djangoproject.com/en/5.0/ref/databases/#postgresql-notes
> PostgreSQL notes].
New description:
As far as I can see, when a database uses the
`django.db.backends.postgresql` engine, any options from the `OPTIONS` key
that are not recognized by the engine itself are passed directly to the
underlying libpq library. This way you can set options like
[https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-
SSLMODE `sslmode`].
But this doesn't seem to actually be documented anywhere, so it's unclear
whether this is actually a supported feature or just an implementation
artifact.
If this really is supported, then it should be documented - presumably in
[https://docs.djangoproject.com/en/5.0/ref/databases/#postgresql-notes
PostgreSQL notes].
PR #17586 to fix this: https://github.com/django/django/pull/17586
--
--
Ticket URL: <https://code.djangoproject.com/ticket/35016#comment:4>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107018c44189792-a9d00852-599a-4b4a-8690-7c0b627e4400-000000%40eu-central-1.amazonses.com.
