aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/xindex.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/xindex.sgml')
-rw-r--r--doc/src/sgml/xindex.sgml53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/src/sgml/xindex.sgml b/doc/src/sgml/xindex.sgml
index 14c1701c9b5..0e4587a81b9 100644
--- a/doc/src/sgml/xindex.sgml
+++ b/doc/src/sgml/xindex.sgml
@@ -409,6 +409,13 @@
<xref linkend="btree-support-funcs"/>.
</para>
+ <para>
+ Additionally, some opclasses allow user to set specific parameters, which
+ controls its behavior. Each builtin index access method have optional
+ <function>options</function> support function, which defines set of
+ opclass-specific parameters.
+ </para>
+
<table tocentry="1" id="xindex-btree-support-table">
<title>B-Tree Support Functions</title>
<tgroup cols="2">
@@ -450,6 +457,13 @@
</entry>
<entry>4</entry>
</row>
+ <row>
+ <entry>
+ Defines set of options that are specific for this operator class
+ (optional)
+ </entry>
+ <entry>5</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -485,6 +499,13 @@
</entry>
<entry>2</entry>
</row>
+ <row>
+ <entry>
+ Defines set of options that are specific for this operator class
+ (optional)
+ </entry>
+ <entry>3</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -560,6 +581,14 @@
index-only scans (optional)</entry>
<entry>9</entry>
</row>
+ <row>
+ <entry><function>options</function></entry>
+ <entry>
+ Defines set of options that are specific for this operator class
+ (optional)
+ </entry>
+ <entry>10</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -611,6 +640,14 @@
query qualifier</entry>
<entry>5</entry>
</row>
+ <row>
+ <entry><function>options</function></entry>
+ <entry>
+ Defines set of options that are specific for this operator class
+ (optional)
+ </entry>
+ <entry>6</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -680,6 +717,14 @@
</entry>
<entry>6</entry>
</row>
+ <row>
+ <entry><function>options</function></entry>
+ <entry>
+ Defines set of options that are specific for this operator class
+ (optional)
+ </entry>
+ <entry>7</entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -730,6 +775,14 @@
</entry>
<entry>4</entry>
</row>
+ <row>
+ <entry><function>options</function></entry>
+ <entry>
+ Defines set of options that are specific for this operator class
+ (optional)
+ </entry>
+ <entry>5</entry>
+ </row>
</tbody>
</tgroup>
</table>