aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorHeikki Linnakangas <heikki.linnakangas@iki.fi>2012-12-05 09:58:03 +0200
committerHeikki Linnakangas <heikki.linnakangas@iki.fi>2012-12-05 09:58:03 +0200
commit357cbaaeae5bc1f385828be97345e7ea24235f92 (patch)
tree4eaea3119077cc3f7c484f9596f5cdae48641a60 /doc/src
parentcdf498c5d76915954cb5d5c6097eb67eb94560c8 (diff)
downloadpostgresql-357cbaaeae5bc1f385828be97345e7ea24235f92.tar.gz
postgresql-357cbaaeae5bc1f385828be97345e7ea24235f92.zip
Add pgstatginindex() function to get the size of the GIN pending list.
Fujii Masao, reviewed by Kyotaro Horiguchi.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/pgstattuple.sgml57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml
index a55b35cb3f1..9f98448d7bc 100644
--- a/doc/src/sgml/pgstattuple.sgml
+++ b/doc/src/sgml/pgstattuple.sgml
@@ -246,6 +246,63 @@ leaf_fragmentation | 0
<varlistentry>
<term>
+ <function>pgstatginindex(regclass) returns record</>
+ </term>
+
+ <listitem>
+ <para>
+ <function>pgstatginindex</function> returns a record showing information
+ about a GIN index. For example:
+<programlisting>
+test=> SELECT * FROM pgstatginindex('test_gin_index');
+-[ RECORD 1 ]--+--
+version | 1
+pending_pages | 0
+pending_tuples | 0
+</programlisting>
+ </para>
+
+ <para>
+ The output columns are:
+
+ <informaltable>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Column</entry>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><structfield>version</structfield></entry>
+ <entry><type>integer</type></entry>
+ <entry>GIN version number</entry>
+ </row>
+
+ <row>
+ <entry><structfield>pending_pages</structfield></entry>
+ <entry><type>integer</type></entry>
+ <entry>Number of pages in the pending list</entry>
+ </row>
+
+ <row>
+ <entry><structfield>pending_tuples</structfield></entry>
+ <entry><type>bigint</type></entry>
+ <entry>Number of tuples in the pending list</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
<function>pg_relpages(text) returns bigint</>
</term>