doc/src/sgml/btree-gist.sgml

   1 <!-- $PostgreSQL$ -->
   2
   3 <sect1 id="btree-gist">
   4  <title>btree_gist</title>
   5
   6  <indexterm zone="btree-gist">
   7   <primary>btree_gist</primary>
   8  </indexterm>
   9
  10  <para>
  11   <filename>btree_gist</> provides sample GiST operator classes that
  12   implement B-Tree equivalent behavior for the data types
  13   <type>int2</>, <type>int4</>, <type>int8</>, <type>float4</>,
  14   <type>float8</>, <type>numeric</>, <type>timestamp with time zone</>,
  15   <type>timestamp without time zone</>, <type>time with time zone</>,
  16   <type>time without time zone</>, <type>date</>, <type>interval</>,
  17   <type>oid</>, <type>money</>, <type>char</>,
  18   <type>varchar</>, <type>text</>, <type>bytea</>, <type>bit</>,
  19   <type>varbit</>, <type>macaddr</>, <type>inet</>, and <type>cidr</>.
  20  </para>
  21
  22  <para>
  23   In general, these operator classes will not outperform the equivalent
  24   standard btree index methods, and they lack one major feature of the
  25   standard btree code: the ability to enforce uniqueness.  However,
  26   they are useful for GiST testing and as a base for developing other
  27   GiST operator classes.
  28  </para>
  29
  30  <sect2>
  31   <title>Example usage</title>
  32
  33 <programlisting>
  34 CREATE TABLE test (a int4);
  35 -- create index
  36 CREATE INDEX testidx ON test USING gist (a);
  37 -- query
  38 SELECT * FROM test WHERE a &lt; 10;
  39 </programlisting>
  40
  41  </sect2>
  42
  43  <sect2>
  44   <title>Authors</title>
  45
  46   <para>
  47    Teodor Sigaev (<email>teodor@stack.net</email>) ,
  48    Oleg Bartunov (<email>oleg@sai.msu.su</email>), and
  49    Janko Richter (<email>jankorichter@yahoo.de</email>).  See
  50    <ulink url="http://www.sai.msu.su/~megera/postgres/gist"></ulink>
  51    for additional information.
  52   </para>
  53
  54  </sect2>
  55
  56 </sect1>