From: Alvaro Herrera <alvherre@alvh.no-ip.org>
Date: Fri, 14 Nov 2014 20:36:10 +0000 (-0300)
Subject: Document BRIN's pages_per_range in CREATE INDEX
X-Git-Tag: REL9_5_ALPHA1~1210
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=79172a58ea3e858750c93c61d55411a209c5ac69;p=thirdparty%2Fpostgresql.git

Document BRIN's pages_per_range in CREATE INDEX

Author: Michael Paquier
---

diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml
index 1a23e273056..6b2ee281811 100644
--- a/doc/src/sgml/ref/create_index.sgml
+++ b/doc/src/sgml/ref/create_index.sgml
@@ -380,6 +380,23 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
     </listitem>
    </varlistentry>
    </variablelist>
+
+   <para>
+    <acronym>BRIN</> indexes accept a different parameter:
+   </para>
+
+   <variablelist>
+   <varlistentry>
+    <term><literal>pages_per_range</></term>
+    <listitem>
+    <para>
+     Defines the number of table blocks that make up one block range for
+     each entry of a <acronym>BRIN</> index (see <xref linkend="brin-intro">
+     for more details).  The default is <literal>128</>.
+    </para>
+    </listitem>
+   </varlistentry>
+   </variablelist>
   </refsect2>
 
   <refsect2 id="SQL-CREATEINDEX-CONCURRENTLY">