diff options
Diffstat (limited to 'doc/src/sgml/gin.sgml')
| -rw-r--r-- | doc/src/sgml/gin.sgml | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml index 0182b445855..d85e7c8796b 100644 --- a/doc/src/sgml/gin.sgml +++ b/doc/src/sgml/gin.sgml @@ -380,7 +380,7 @@ <para> Optionally, an operator class for <acronym>GIN</acronym> can supply the - following method: + following methods: <variablelist> <varlistentry> @@ -402,6 +402,30 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><function>void options(local_relopts *relopts)</function></term> + <listitem> + <para> + Defines set of user-visible parameters that control operator class + behavior. + </para> + + <para> + The <function>options</function> function has given pointer to + <replaceable>local_relopts</replaceable> struct, which needs to be + filled with s set of operator class specific options. The options + can be accessed from other support functions using + <literal>PG_HAS_OPCLASS_OPTIONS()</literal> and + <literal>PG_GET_OPCLASS_OPTIONS()</literal> macros. + </para> + + <para> + Since both key extraction for indexed value and representation of the + key in <acronym>GIN</acronym> are flexible, it may depends on + user-specified parameters. + </para> + </listitem> + </varlistentry> </variablelist> </para> |