Document POSTGRES_EXTRA_ANNOTATE_SQL

SectorLabs · Jul 18, 2022 · 4adc787 · 4adc787
1 parent 77dad7e
commit 4adc787
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/source/settings.rst b/docs/source/settings.rst
@@ -28,3 +28,13 @@ Settings
    .. note::
 
       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.
+
+.. _POSTGRES_EXTRA_ANNOTATE_SQL_:
+
+* ``POSTGRES_EXTRA_ANNOTATE_SQL``
+
+   If set to ``True``, will append a comment to all SQL queries with the path and line number that the query was made from.
+
+   Format: ``/* <pid> <function name> <filename> <line number> */``
+
+   This can be useful when debugging queries found in PostgreSQL's ``pg_stat_activity`` or in its query log.