From: Alexander Korotkov <akorotkov@postgresql.org>
Date: Sun, 14 Oct 2018 21:40:17 +0000 (+0300)
Subject: contrib/bloom documentation improvement
X-Git-Tag: REL9_6_11~33
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a05f7053e842d1463c35713ae79e6795b8751dc2;p=postgresql

contrib/bloom documentation improvement

This commit documents rounding of "length" parameter and absence of support
for unique indexes and NULLs searching.  Backpatch to 9.6 where contrib/bloom
was introduced.

Discussion: https://postgr.es/m/CAF4Au4wPQQ7EHVSnzcLjsbY3oLSzVk6UemZLD1Sbmwysy3R61g%40mail.gmail.com
Author: Oleg Bartunov with minor editorialization by me
Backpatch-through: 9.6
---

diff --git a/doc/src/sgml/bloom.sgml b/doc/src/sgml/bloom.sgml
index 396348c523..2eb7a4fd40 100644
--- a/doc/src/sgml/bloom.sgml
+++ b/doc/src/sgml/bloom.sgml
@@ -51,8 +51,8 @@
     <term><literal>length</></term>
     <listitem>
      <para>
-      Length of each signature (index entry) in bits. The default
-      is <literal>80</> bits and maximum is <literal>4096</>.
+      Length of each signature (index entry) in bits, it is rounded up to the nearest
+      multiple of <literal>16</>. The default is <literal>80</> bits and maximum is <literal>4096</literal>.
      </para>
     </listitem>
    </varlistentry>
@@ -242,6 +242,20 @@ DEFAULT FOR TYPE text USING bloom AS
       operations in the future.
      </para>
     </listitem>
+
+    <listitem>
+     <para>
+       <literal>bloom</literal> access method doesn't support
+       <literal>UNIQUE</literal> indexes.
+     </para>
+    </listitem>
+
+    <listitem>
+     <para>
+       <literal>bloom</literal> access method doesn't support searching for
+       <literal>NULL</literal> values.
+     </para>
+    </listitem>
    </itemizedlist>
   </para>
  </sect2>