diff options
Diffstat (limited to 'doc/src/sgml/spgist.sgml')
| -rw-r--r-- | doc/src/sgml/spgist.sgml | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml index a043ffb06c4..56827e520dd 100644 --- a/doc/src/sgml/spgist.sgml +++ b/doc/src/sgml/spgist.sgml @@ -53,6 +53,93 @@ </sect1> +<sect1 id="spgist-builtin-opclasses"> + <title>Built-in Operator Classes</title> + + <para> + The core <productname>PostgreSQL</> distribution + includes the <acronym>SP-GiST</acronym> operator classes shown in + <xref linkend="spgist-builtin-opclasses-table">. + </para> + + <table id="spgist-builtin-opclasses-table"> + <title>Built-in <acronym>SP-GiST</acronym> Operator Classes</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Name</entry> + <entry>Indexed Data Type</entry> + <entry>Indexable Operators</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>kd_point_ops</></entry> + <entry><type>point</></entry> + <entry> + <literal><<</> + <literal><@</> + <literal><^</> + <literal>>></> + <literal>>^</> + <literal>~=</> + </entry> + </row> + <row> + <entry><literal>quad_point_ops</></entry> + <entry><type>point</></entry> + <entry> + <literal><<</> + <literal><@</> + <literal><^</> + <literal>>></> + <literal>>^</> + <literal>~=</> + </entry> + </row> + <row> + <entry><literal>range_ops</></entry> + <entry>any range type</entry> + <entry> + <literal>&&</> + <literal>&<</> + <literal>&></> + <literal>-|-</> + <literal><<</> + <literal><@</> + <literal>=</> + <literal>>></> + <literal>@></> + </entry> + </row> + <row> + <entry><literal>text_ops</></entry> + <entry><type>text</></entry> + <entry> + <literal><</> + <literal><=</> + <literal>=</> + <literal>></> + <literal>>=</> + <literal>~<=~</> + <literal>~<~</> + <literal>~>=~</> + <literal>~>~</> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Of the two operator classes for type <type>point</>, + <literal>quad_point_ops</> is the default. <literal>kd_point_ops</> + supports the same operators but uses a different index data structure which + may offer better performance in some applications. + </para> + +</sect1> + <sect1 id="spgist-extensibility"> <title>Extensibility</title> |