diff options
Diffstat (limited to 'doc/src/sgml/gin.sgml')
| -rw-r--r-- | doc/src/sgml/gin.sgml | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml index 46e87e01324..82410b1fbdf 100644 --- a/doc/src/sgml/gin.sgml +++ b/doc/src/sgml/gin.sgml @@ -394,7 +394,11 @@ Pointer extra_data)</function></term> <listitem> <para> - Compare a partial-match query key to an index key. Returns an integer + Compare a partial-match query key to an index key. + <literal>partial_key</literal> is a query key that was returned + by <function>extractQuery</function> with an indication that it + requires partial match, and <literal>key</literal> is an index entry. + Returns an integer whose sign indicates the result: less than zero means the index key does not match the query, but the index scan should continue; zero means that the index key does match the query; greater than zero |