pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedMinor addition to index documentation
4+ messages / 3 participants
[nested] [flat]
* Minor addition to index documentation
@ 2015-11-16 15:33 Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
2015-11-16 18:59 ` Re: Minor addition to index documentation Alvaro Herrera <alvherre@2ndquadrant.com>
0 siblings, 1 reply; 4+ messages in thread
From: Anastasia Lubennikova @ 2015-11-16 15:33 UTC (permalink / raw)
To: pgsql-docs
Fix incomplete gist interface description.
Patch is attached.
--
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.patch (text/x-patch, 854B) download
diff --git a/doc/src/sgml/xindex.sgml b/doc/src/sgml/xindex.sgml
index 4fac018..d871cf7 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 seven support functions, with two 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>
* Re: Minor addition to index documentation
2015-11-16 15:33 Minor addition to index documentation Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
@ 2015-11-16 18:59 ` Alvaro Herrera <alvherre@2ndquadrant.com>
2015-11-17 09:40 ` Re: Minor addition to index documentation Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
2015-12-06 17:45 ` Re: Minor addition to index documentation Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 2 replies; 4+ messages in thread
From: Alvaro Herrera @ 2015-11-16 18:59 UTC (permalink / raw)
To: Anastasia Lubennikova <a.lubennikova@postgrespro.ru>; +Cc: pgsql-docs
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".
This is to be backpatched as far back as commit d04c8ed9044ec, right?
--
Álvaro Herrera http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Minor addition to index documentation
2015-11-16 15:33 Minor addition to index documentation Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
2015-11-16 18:59 ` Re: Minor addition to index documentation Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2015-11-17 09:40 ` Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
1 sibling, 0 replies; 4+ messages in thread
From: Anastasia Lubennikova @ 2015-11-17 09:40 UTC (permalink / raw)
To: pgsql-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>
* Re: Minor addition to index documentation
2015-11-16 15:33 Minor addition to index documentation Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
2015-11-16 18:59 ` Re: Minor addition to index documentation Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2015-12-06 17:45 ` Tom Lane <tgl@sss.pgh.pa.us>
1 sibling, 0 replies; 4+ messages in thread
From: Tom Lane @ 2015-12-06 17:45 UTC (permalink / raw)
To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: Anastasia Lubennikova <a.lubennikova@postgrespro.ru>; pgsql-docs
Alvaro Herrera <alvherre@2ndquadrant.com> writes:
> Maybe "GiST indexes require nine support functions, two of which are
> optional, as shown in XYZ".
That wording seems just as bizarre to me: a support function can hardly
be both "required" and "optional". After a bit of thought I changed it
to
GiST indexes have nine support functions, two of which are optional,
I noted that the corresponding wording for GIN indexes was a bit out
of date too :-(. Pushed with those corrections.
regards, tom lane
--
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2015-12-06 17:45 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2015-11-16 15:33 Minor addition to index documentation Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
2015-11-16 18:59 ` Alvaro Herrera <alvherre@2ndquadrant.com>
2015-11-17 09:40 ` Anastasia Lubennikova <a.lubennikova@postgrespro.ru>
2015-12-06 17:45 ` Tom Lane <tgl@sss.pgh.pa.us>
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