Subject: pg_stat_statements doc tweaks

From: Ian Barwick <[email-masked]>
Date: Wed, 06 May 2015 09:45:40 +0900

Hi

I noticed that the pg_stat_statement docs [*] seem to imply that if you load
pg_stat_statements via 'shared_preload_libraries', a "system view"
named 'pg_stat_statements' will be created, presumably in the pg_catalog
schema. However the requirement to install the extension to access the
(non-system) view isn't mentioned until after the (lengthy) view description.

[*] http://www.postgresql.org/docs/devel/static/pgstatstatements.html

I've refactored this slightly to put the installation details at the top, and
remove the term "system view".

Regards

Ian Barwick

-- 
 Ian Barwick                   http://www.2ndQuadrant.com/
 PostgreSQL Development, 24x7 Support, RemoteDBA, Training & Services

diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml
new file mode 100644
index 04b3f01..4d7a6e6
*** a/doc/src/sgml/pgstatstatements.sgml
--- b/doc/src/sgml/pgstatstatements.sgml
***************
*** 19,30 ****
    This means that a server restart is needed to add or remove the module.
   </para>
  
   <sect2>
    <title>The <structname>pg_stat_statements</structname> View</title>
  
    <para>
     The statistics gathered by the module are made available via a
!    system view named <structname>pg_stat_statements</>.  This view
     contains one row for each distinct database ID, user ID and query
     ID (up to the maximum number of distinct statements that the module
     can track).  The columns of the view are shown in
--- 19,40 ----
    This means that a server restart is needed to add or remove the module.
   </para>
  
+  <para>
+    When <filename>pg_stat_statements</filename> is loaded, it tracks
+    statistics across all databases of the server.  To access and manipulate
+    these statistics, the module provides a view, <structname>pg_stat_statements</>,
+    and the utility functions <function>pg_stat_statements_reset</> and
+    <function>pg_stat_statements</>.  These are not available globally but
+    can be enabled for a specific database with
+    <command>CREATE EXTENSION pg_stat_statements</>.
+  </para>
+ 
   <sect2>
    <title>The <structname>pg_stat_statements</structname> View</title>
  
    <para>
     The statistics gathered by the module are made available via a
!    view named <structname>pg_stat_statements</>.  This view
     contains one row for each distinct database ID, user ID and query
     ID (up to the maximum number of distinct statements that the module
     can track).  The columns of the view are shown in
***************
*** 216,234 ****
    </table>
  
    <para>
-    This view, and the functions <function>pg_stat_statements_reset</>
-    and <function>pg_stat_statements</>, are available only in
-    databases they have been specifically installed into by installing
-    the <literal>pg_stat_statements</> extension.
-    However, statistics are tracked across all databases of the server
-    whenever the <filename>pg_stat_statements</filename> module is loaded
-    into the server, regardless of presence of the view.
-   </para>
- 
-   <para>
     For security reasons, non-superusers are not allowed to see the SQL
!    text or <structfield>queryid</structfield> of queries executed by other users.  They can see
!    the statistics, however, if the view has been installed in their
     database.
    </para>
  
--- 226,234 ----
    </table>
  
    <para>
     For security reasons, non-superusers are not allowed to see the SQL
!    text or <structfield>queryid</structfield> of queries executed by other users.
!    They can see the statistics, however, if the view has been installed in their
     database.
    </para>

-- 
Sent via pgsql-docs mailing list ([email-masked])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs