From f23a5630ebc797219b62797f566dec9f65090e03 Mon Sep 17 00:00:00 2001
From: Tom Lane
Date: Tue, 8 Apr 2014 15:46:14 -0400
Subject: Add an in-core GiST index opclass for inet/cidr types.
This operator class can accelerate subnet/supernet tests as well as
btree-equivalent ordered comparisons. It also handles a new network
operator inet && inet (overlaps, a/k/a "is supernet or subnet of"),
which is expected to be useful in exclusion constraints.
Ideally this opclass would be the default for GiST with inet/cidr data,
but we can't mark it that way until we figure out how to do a more or
less graceful transition from the current situation, in which the
really-completely-bogus inet/cidr opclasses in contrib/btree_gist are
marked as default. Having the opclass in core and not default is better
than not having it at all, though.
While at it, add new documentation sections to allow us to officially
document GiST/GIN/SP-GiST opclasses, something there was never a clear
place to do before. I filled these in with some simple tables listing
the existing opclasses and the operators they support, but there's
certainly scope to put more information there.
Emre Hasegeli, reviewed by Andreas Karlsson, further hacking by me
---
doc/src/sgml/gist.sgml | 178 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 178 insertions(+)
(limited to 'doc/src/sgml/gist.sgml')
diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml
index ed0bc54f52d..0158b1759e8 100644
--- a/doc/src/sgml/gist.sgml
+++ b/doc/src/sgml/gist.sgml
@@ -40,6 +40,184 @@
+
+ Built-in Operator Classes
+
+
+ The core PostgreSQL distribution
+ includes the GiST operator classes shown in
+ .
+ (Some of the optional modules described in
+ provide additional GiST operator classes.)
+
+
+
+ Built-in <acronym>GiST</acronym> Operator Classes
+
+
+
+ Name
+ Indexed Data Type
+ Indexable Operators
+ Ordering Operators
+
+
+
+
+ box_ops
+ box
+
+ &&
+ &>
+ &<
+ &<|
+ >>
+ <<
+ <<|
+ <@
+ @>
+ @
+ |&>
+ |>>
+ ~
+ ~=
+
+
+
+
+
+ circle_ops
+ circle
+
+ &&
+ &>
+ &<
+ &<|
+ >>
+ <<
+ <<|
+ <@
+ @>
+ @
+ |&>
+ |>>
+ ~
+ ~=
+
+
+
+
+
+ inet_ops
+ inet, cidr
+
+ &&
+ >>
+ >>=
+ >
+ >=
+ <>
+ <<
+ <<=
+ <
+ <=
+ =
+
+
+
+
+
+ point_ops
+ point
+
+ >>
+ >^
+ <<
+ <@
+ <@
+ <@
+ <^
+ ~=
+
+
+ <->
+
+
+
+ poly_ops
+ polygon
+
+ &&
+ &>
+ &<
+ &<|
+ >>
+ <<
+ <<|
+ <@
+ @>
+ @
+ |&>
+ |>>
+ ~
+ ~=
+
+
+
+
+
+ range_ops
+ any range type
+
+ &&
+ &>
+ &<
+ >>
+ <<
+ <@
+ -|-
+ =
+ @>
+ @>
+
+
+
+
+
+ tsquery_ops
+ tsquery
+
+ <@
+ @>
+
+
+
+
+
+ tsvector_ops
+ tsvector
+
+ @@
+
+
+
+
+
+
+
+
+
+ For historical reasons, the inet_ops operator class is
+ not the default class for types inet and cidr.
+ To use it, mention the class name in CREATE INDEX,
+ for example
+
+CREATE INDEX ON my_table USING gist (my_inet_column inet_ops);
+
+
+
+
+
Extensibility
--
cgit v1.2.3