Skip to content

Commit 4adc787

Browse files
committed
Document POSTGRES_EXTRA_ANNOTATE_SQL
1 parent 77dad7e commit 4adc787

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/source/settings.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,13 @@ Settings
2828
.. note::
2929

3030
If set to ``False``, you must ensure that the ``hstore`` extension is enabled on your database manually. If not enabled, any ``hstore`` related functionality will not work.
31+
32+
.. _POSTGRES_EXTRA_ANNOTATE_SQL_:
33+
34+
* ``POSTGRES_EXTRA_ANNOTATE_SQL``
35+
36+
If set to ``True``, will append a comment to all SQL queries with the path and line number that the query was made from.
37+
38+
Format: ``/* <pid> <function name> <filename> <line number> */``
39+
40+
This can be useful when debugging queries found in PostgreSQL's ``pg_stat_activity`` or in its query log.

0 commit comments

Comments
 (0)