From 15cb2bd27009f73a84a35c2ba60fdd105b4bf263 Mon Sep 17 00:00:00 2001
From: Alexander Korotkov
Date: Sat, 20 Jun 2020 13:34:54 +0300
Subject: Add documentation for opclass options
911e7020770 added opclass options and adjusted documentation for each
particular affected opclass. However, documentation for extendability was
not adjusted. This commit adjusts documentation for interfaces of index AMs
and opclasses.
Discussion: https://postgr.es/m/CAH2-WzmQnW6%2Bz5F9AW%2BSz%2BzEcEvXofTwh_A9J3%3D_WA-FBP0wYg%40mail.gmail.com
Author: Alexander Korotkov
Reported-by: Peter Geoghegan
Reviewed-by: Peter Geoghegan
---
doc/src/sgml/spgist.sgml | 35 ++++++++++++++++++++++++++++++++++-
1 file changed, 34 insertions(+), 1 deletion(-)
(limited to 'doc/src/sgml/spgist.sgml')
diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml
index 0e04a086793..03f914735bd 100644
--- a/doc/src/sgml/spgist.sgml
+++ b/doc/src/sgml/spgist.sgml
@@ -858,7 +858,7 @@ typedef struct spgLeafConsistentOut
- The optional user-defined method is:
+ The optional user-defined method are:
@@ -875,6 +875,39 @@ typedef struct spgLeafConsistentOut
+
+ options
+
+
+ Defines set of user-visible parameters that control operator class
+ behavior.
+
+
+
+ The SQL declaration of the function must look like this:
+
+
+CREATE OR REPLACE FUNCTION my_options(internal)
+RETURNS void
+AS 'MODULE_PATHNAME'
+LANGUAGE C STRICT;
+
+
+
+
+ The function has given pointer to local_relopts
+ struct, which needs to be filled with a set of operator class
+ specific options. The options can be accessed from other support
+ functions using PG_HAS_OPCLASS_OPTIONS() and
+ PG_GET_OPCLASS_OPTIONS() macros.
+
+
+
+ Since the representation of the key in SP-GiST is
+ flexible, it may depends on user-specified parameters.
+
+
+
--
cgit v1.2.3