Commit 3be015c9 authored by Alexander Korotkov's avatar Alexander Korotkov

Minor corrections to docs related to opclass options

Reported-by: Peter Geoghegan
Discussion: https://postgr.es/m/CAH2-WzmwhYbxuoL0WjTLaiCxW3gj6qadeNpBhWAo_KZsE5-FGw%40mail.gmail.com
parent a44dd932
......@@ -207,7 +207,7 @@
<para>
As shown in <xref linkend="xindex-btree-support-table"/>, btree defines
one required and three optional support functions. The four
one required and four optional support functions. The five
user-defined methods are:
</para>
<variablelist>
......
......@@ -284,7 +284,7 @@
<para>
There are five user-defined methods that an index operator class for
<acronym>SP-GiST</acronym> must provide, and one is optional. All five
<acronym>SP-GiST</acronym> must provide, and two are optional. All five
mandatory methods follow the convention of accepting two <type>internal</type>
arguments, the first of which is a pointer to a C struct containing input
values for the support method, while the second argument is a pointer to a
......@@ -295,7 +295,9 @@
cases, the output struct is initialized to zeroes before calling the
user-defined method. The optional sixth method <function>compress</function>
accepts datum to be indexed as the only argument and returns a value suitable
for physical storage in a leaf tuple.
for physical storage in a leaf tuple. The optional seventh method
<function>options</function> accepts internal pointer to a C struct, where
opclass-specific parameters should be placed, and returns <type>void</type>.
</para>
<para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment