summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorAlexander Korotkov2018-10-14 21:40:17 +0000
committerAlexander Korotkov2018-10-14 22:07:08 +0000
commita05f7053e842d1463c35713ae79e6795b8751dc2 (patch)
tree6dfadc7243e1c5868ae0163be1f4c2c5bcf2f757 /doc/src
parent010041ddcc39323ed786fc0e0b94789abdf430e9 (diff)
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
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/bloom.sgml18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/src/sgml/bloom.sgml b/doc/src/sgml/bloom.sgml
index 396348c5237..2eb7a4fd40d 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>