pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  

help / color / mirror / Atom feed

From: Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
To: pgsql-docs@postgresql.org
Subject: Re: Minor addition to index documentation
Date: Tue, 17 Nov 2015 12:40:50 +0300
Message-ID: <564AF622.2090200@postgrespro.ru> (raw)
In-Reply-To: <20151116185919.GA614468@alvherre.pgsql>
References: <5649F73E.7090505@postgrespro.ru>
	<20151116185919.GA614468@alvherre.pgsql>
List-Unsubscribe: <mailto:majordomo@postgresql.org?body=unsub%20pgsql-docs>



16.11.2015 21:59, Alvaro Herrera:
> Anastasia Lubennikova wrote:
>> Fix incomplete gist interface description.
> Hi, thanks for the patch.
>
> I think this sentence is a bit confusing:
>
>>     <para>
>> -   GiST indexes require seven support functions, with an optional eighth, as
>> +   GiST indexes require seven support functions, with two optional, as
>>      shown in <xref linkend="xindex-gist-support-table">.
> The new text seems to say that one of the seven support funcs is
> optional, which is wrong if I correctly understand that the "fetch"
> optional function was added.
>
> Maybe "GiST indexes require nine support functions, two of which are
> optional, as shown in XYZ".
Yes, thank you for advice. I think it'll be more clear.

> This is to be backpatched as far back as commit d04c8ed9044ec, right?
Yes.

-- 
Anastasia Lubennikova
Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company

-- 
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

Attachments:

gist_fetch_docs_update_1.0.patch (text/x-patch, 861B) download
diff --git a/doc/src/sgml/xindex.sgml b/doc/src/sgml/xindex.sgml
index 4fac018..4a8eb1b 100644
--- a/doc/src/sgml/xindex.sgml
+++ b/doc/src/sgml/xindex.sgml
@@ -416,7 +416,7 @@
    </table>
 
   <para>
-   GiST indexes require seven support functions, with an optional eighth, as
+   GiST indexes require nine support functions, two of which are optional, as
    shown in <xref linkend="xindex-gist-support-table">.
    (For more information see <xref linkend="GiST">.)
   </para>
@@ -477,6 +477,11 @@
        <entry>determine distance from key to query value (optional)</entry>
        <entry>8</entry>
       </row>
+      <row>
+       <entry><function>fetch</></entry>
+       <entry>compute original representation of a compressed key for index-only scans (optional)</entry>
+       <entry>9</entry>
+      </row>
      </tbody>
     </tgroup>
    </table>

view thread (4+ messages)  latest in thread

Message-ID: <564AF622.2090200@postgrespro.ru>
Permalink:  ../564AF622.2090200@postgrespro.ru/
Also on:    postgresql.org/message-id/564AF622.2090200@postgrespro.ru

copy link · copy postgr.es · copy git am

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: a.lubennikova@postgrespro.ru
  Subject: Re: Minor addition to index documentation
  In-Reply-To: <564AF622.2090200@postgrespro.ru>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox