summaryrefslogtreecommitdiff
path: root/doc/src/sgml/xindex.sgml
diff options
context:
space:
mode:
authorTom Lane2010-12-04 04:49:06 +0000
committerTom Lane2010-12-04 04:49:06 +0000
commitb576757d7ee064ada5351c2e6a36c2f7234aa1d4 (patch)
tree5ca6b09b224f7e5a970bed4a9a58f59a47824521 /doc/src/sgml/xindex.sgml
parent04910a3ad5cd2901558da2a4fad9a2e2819348aa (diff)
Add external documentation for KNNGIST.
Diffstat (limited to 'doc/src/sgml/xindex.sgml')
-rw-r--r--doc/src/sgml/xindex.sgml35
1 files changed, 25 insertions, 10 deletions
diff --git a/doc/src/sgml/xindex.sgml b/doc/src/sgml/xindex.sgml
index 6d059bda706..a90b4e2a725 100644
--- a/doc/src/sgml/xindex.sgml
+++ b/doc/src/sgml/xindex.sgml
@@ -361,59 +361,74 @@
</table>
<para>
- GiST indexes require seven support functions,
+ GiST indexes require seven support functions, with an optional eighth, as
shown in <xref linkend="xindex-gist-support-table">.
</para>
<table tocentry="1" id="xindex-gist-support-table">
<title>GiST Support Functions</title>
- <tgroup cols="2">
+ <tgroup cols="3">
<thead>
<row>
<entry>Function</entry>
+ <entry>Description</entry>
<entry>Support Number</entry>
</row>
</thead>
<tbody>
<row>
- <entry>consistent - determine whether key satisfies the
+ <entry><function>consistent</></entry>
+ <entry>determine whether key satisfies the
query qualifier</entry>
<entry>1</entry>
</row>
<row>
- <entry>union - compute union of a set of keys</entry>
+ <entry><function>union</></entry>
+ <entry>compute union of a set of keys</entry>
<entry>2</entry>
</row>
<row>
- <entry>compress - compute a compressed representation of a key or value
+ <entry><function>compress</></entry>
+ <entry>compute a compressed representation of a key or value
to be indexed</entry>
<entry>3</entry>
</row>
<row>
- <entry>decompress - compute a decompressed representation of a
+ <entry><function>decompress</></entry>
+ <entry>compute a decompressed representation of a
compressed key</entry>
<entry>4</entry>
</row>
<row>
- <entry>penalty - compute penalty for inserting new key into subtree
+ <entry><function>penalty</></entry>
+ <entry>compute penalty for inserting new key into subtree
with given subtree's key</entry>
<entry>5</entry>
</row>
<row>
- <entry>picksplit - determine which entries of a page are to be moved
+ <entry><function>picksplit</></entry>
+ <entry>determine which entries of a page are to be moved
to the new page and compute the union keys for resulting pages</entry>
<entry>6</entry>
</row>
<row>
- <entry>equal - compare two keys and return true if they are equal</entry>
+ <entry><function>equal</></entry>
+ <entry>compare two keys and return true if they are equal</entry>
<entry>7</entry>
</row>
+ <row>
+ <entry><function>distance</></entry>
+ <entry>
+ (optional method) determine distance from key to query value
+ </entry>
+ <entry>8</entry>
+ </row>
</tbody>
</tgroup>
</table>
<para>
- GIN indexes require four support functions,
+ GIN indexes require four support functions, with an optional fifth, as
shown in <xref linkend="xindex-gin-support-table">.
</para>