Postgres Pro
Downloads
Home   >   mailing lists

Thread: Re: Clarification on the docs

Re: Clarification on the docs

From
"David G. Johnston"
Date:
On Fri, Apr 11, 2025 at 6:49 PM Igor Korot <ikorot01@gmail.com> wrote:
Hi, ALL,
On the https://www.postgresql.org/docs/17/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS
its said:

[quote]
The optional WITH clause specifies storage parameters for the index.
Each index method has its own set of allowed storage parameters. The
B-tree, hash, GiST and SP-GiST index methods all accept this
parameter:
[/quote]


These are the index methods and the valid lists for each.  The docs are correct in how they remove duplication.  I'm undecided on whether that is the best presentation choice.  I would at minimum place a new paragraph after "own set of allowed storage parameters." so that "The B-tree, hash..." begins its own line.

B-tree:
fillfactor
deduplicate_items

Hash:
fillfactor

Gist:
fillfactor
buffering

SP-Gist:
fillfactor

GIN:
fastupdate
gin_pending_list_limit

BRIN:
pages_per_range
autosummarize

David J.

Re: Clarification on the docs

From
Igor Korot
Date:
Hi, David,

On Fri, Apr 11, 2025 at 9:04 PM David G. Johnston <david.g.johnston@gmail.com> wrote:
On Fri, Apr 11, 2025 at 6:49 PM Igor Korot <ikorot01@gmail.com> wrote:
Hi, ALL,
On the https://www.postgresql.org/docs/17/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS
its said:

[quote]
The optional WITH clause specifies storage parameters for the index.
Each index method has its own set of allowed storage parameters. The
B-tree, hash, GiST and SP-GiST index methods all accept this
parameter:
[/quote]


These are the index methods and the valid lists for each.  The docs are correct in how they remove duplication.  I'm undecided on whether that is the best presentation choice.  I would at minimum place a new paragraph after "own set of allowed storage parameters." so that "The B-tree, hash..." begins its own line.

B-tree:
fillfactor
deduplicate_items

Hash:
fillfactor

Gist:
fillfactor
buffering

SP-Gist:
fillfactor

GIN:
fastupdate
gin_pending_list_limit

BRIN:
pages_per_range
autosummarize

This above looks much better. What stops you from pushing it?

There is no double meaning and everything is split nicely.

Thank you.


David J.

Re: Clarification on the docs

From
"David G. Johnston"
Date:
On Friday, April 11, 2025, Igor Korot <ikorot01@gmail.com> wrote:
Hi, David,

On Fri, Apr 11, 2025 at 9:04 PM David G. Johnston <david.g.johnston@gmail.com> wrote:
On Fri, Apr 11, 2025 at 6:49 PM Igor Korot <ikorot01@gmail.com> wrote:
Hi, ALL,
On the https://www.postgresql.org/docs/17/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS
its said:

[quote]
The optional WITH clause specifies storage parameters for the index.
Each index method has its own set of allowed storage parameters. The
B-tree, hash, GiST and SP-GiST index methods all accept this
parameter:
[/quote]


These are the index methods and the valid lists for each.  The docs are correct in how they remove duplication.  I'm undecided on whether that is the best presentation choice.  I would at minimum place a new paragraph after "own set of allowed storage parameters." so that "The B-tree, hash..." begins its own line.
 
This above looks much better. What stops you from pushing it?

There is no double meaning and everything is split nicely.

Because I’m undecided on what exactly would be an improvement and don’t care enough on the basis of this single question to put effort into figuring that out.  Committers read these and if one of them wants to act on my new paragraph suggestion great.  If not, it isn’t that big a deal.  For me, this doesn’t warrant a CF entry.

David J.

Clarification on the docs

From
Igor Korot
Date:
Hi, ALL,
On the https://www.postgresql.org/docs/17/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS
its said:

[quote]
The optional WITH clause specifies storage parameters for the index.
Each index method has its own set of allowed storage parameters. The
B-tree, hash, GiST and SP-GiST index methods all accept this
parameter:
[/quote]

It states that each index method has its own set.

However only 3 out of predefined are given.

Moore over after that quote there is a list of parameters. But the
last phrase indicates a single parameter.

So how should I read that?

Is it a typo and it has to be plural, oor the list needs to be
ybindented and only one parameter should be there?

Thank you.

Re: Clarification on the docs

From
Tom Lane
Date:
"David G. Johnston" <david.g.johnston@gmail.com> writes:
> Because I’m undecided on what exactly would be an improvement and don’t
> care enough on the basis of this single question to put effort into
> figuring that out.  Committers read these and if one of them wants to act
> on my new paragraph suggestion great.  If not, it isn’t that big a deal.
> For me, this doesn’t warrant a CF entry.

I agree this list has gotten a little messy over time, and also that
it's not a big enough deal to warrant a formal patch process.
I tried to improve matters at

https://git.postgresql.org/gitweb/?p=postgresql.git;a=commitdiff;h=78637a8be

            regards, tom lane