Skip site navigation (1) Skip section navigation (2)

Re: Confusing link in streaming replication section

From: Thom Brown <thombrown(at)gmail(dot)com>
To: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Confusing link in streaming replication section
Date: 2010-02-12 16:15:03
Message-ID: bddc86151002120815m5b9e6922p90aba868b5dae9d7@mail.gmail.com (view raw or flat)
Thread:
Lists: pgsql-docs
On 12 February 2010 01:57, Fujii Masao <masao(dot)fujii(at)gmail(dot)com> wrote:
> On Thu, Feb 11, 2010 at 7:43 AM, Thom Brown <thombrown(at)gmail(dot)com> wrote:
>> I'm looking at the latest docs for PostgreSQL 9.0
>> (http://developer.postgresql.org/pgdocs/postgres/streaming-replication.html)
>> and under the description of primary_conninfo, there's a link to
>> section 30.1 (http://developer.postgresql.org/pgdocs/postgres/libpq-connect.html)
>> which is supposed to describe the string format.  Having looked at
>> that page, however, it's not crystal clear what is meant by this
>> string format.  One can only assume it's referring to the
>> PQconnectdbParams section and the keywords that can be used for it,
>> which would also apply to a connection string, but there's no mention
>> of a "format" on that page.
>
> Thanks for the report!
>
> Though at first PQconnectdb() had been linked by the SR doc, instead
> PQconnectdbParams() seems to have been linked wrongly when it was committed.
> How about changing the link so as to point to PQconnectdb() again? Or
> copy-pasting the following description from PQconnectdb() to the SR doc?
>
> -----------
> The passed string can be empty to use all default parameters, or it can
> contain one or more parameter settings separated by whitespace. Each
> parameter setting is in the form keyword = value. Spaces around the equal
> sign are optional. To write an empty value, or a value containing spaces,
> surround it with single quotes, e.g., keyword = 'a value'. Single quotes
> and backslashes within the value must be escaped with a backslash,
> i.e., \' and \\.
>
> The currently recognized parameter key words are the same as above.
> -----------

Hmmm... well that last sentence refers to parameter key words which
won't appear on the SR page unless you copy and paste all that
information too.

I think the problem I have with there being a link to the libpq
control functions page is that the context of the settings isn't the
same, meaning the text on that page is specifically targetting people
looking for libpq info, rather than providing more generic information
which may be better placed in an appendix or something similar.

May I suggest a page on connection paramaters/connection strings which
can be referenced by multiple locations?  Otherwise I can imagine the
same information being presented a number of times throughout the
documentation.

Thanks

Thom

In response to

Responses

pgsql-docs by date

Next:From: Dimitri FontaineDate: 2010-02-12 17:25:02
Subject: Re: Re: [COMMITTERS] pgsql: Make standby server continuously retry restoring the next WAL
Previous:From: Heikki LinnakangasDate: 2010-02-12 16:10:05
Subject: Re: Re: [COMMITTERS] pgsql: Make standby server continuously retry restoring the next WAL

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group