pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedCOPY statement: no list of the allowed values for "format_name"
4+ messages / 3 participants
[nested] [flat]
* COPY statement: no list of the allowed values for "format_name"
@ 2020-10-29 17:59 PG Doc comments form <noreply@postgresql.org>
2020-10-29 22:29 ` Re: COPY statement: no list of the allowed values for "format_name" David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: PG Doc comments form @ 2020-10-29 17:59 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: bryn@yugabyte.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/11/sql-copy.html
Description:
Look at the account of the COPY statement, here:
https://www.postgresql.org/docs/11/sql-copy.html
and see this:
«
[ [ WITH ] ( option [, ...] ) ]
»
It goes on to say this:
«
where option can be one of:
FORMAT format_name
»
But there's no list of the allowed values for "format_name". The same holds
for other options like, for example, "encoding_name".
I tried to provoke the list by using "with (format 'dog')". I got the 22023
error:
«
COPY format "dog" not recognized
»
But there was no list of the allowed values.
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: COPY statement: no list of the allowed values for "format_name"
2020-10-29 17:59 COPY statement: no list of the allowed values for "format_name" PG Doc comments form <noreply@postgresql.org>
@ 2020-10-29 22:29 ` David G. Johnston <david.g.johnston@gmail.com>
2020-10-30 00:13 ` Re: COPY statement: no list of the allowed values for "format_name" Bryn Llewellyn <bryn@yugabyte.com>
0 siblings, 1 reply; 4+ messages in thread
From: David G. Johnston @ 2020-10-29 22:29 UTC (permalink / raw)
To: Bryn Llewellyn <bryn@yugabyte.com>; Pg Docs <pgsql-docs@lists.postgresql.org>
On Thu, Oct 29, 2020 at 3:24 PM PG Doc comments form <noreply@postgresql.org>
wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/11/sql-copy.html
> Description:
>
> Look at the account of the COPY statement, here:
>
> https://www.postgresql.org/docs/11/sql-copy.html
>
>
> But there was no list of the allowed values.
>
Keep reading...
"""
FORMAT
Selects the data format to be read or written: text, csv (Comma Separated
Values), or binary. The default is text.
"""
I suppose including the syntax term "format_type" might help, but the
all-caps FORMAT is definitive.
David J.
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: COPY statement: no list of the allowed values for "format_name"
2020-10-29 17:59 COPY statement: no list of the allowed values for "format_name" PG Doc comments form <noreply@postgresql.org>
2020-10-29 22:29 ` Re: COPY statement: no list of the allowed values for "format_name" David G. Johnston <david.g.johnston@gmail.com>
@ 2020-10-30 00:13 ` Bryn Llewellyn <bryn@yugabyte.com>
2020-10-30 00:22 ` Re: COPY statement: no list of the allowed values for "format_name" David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: Bryn Llewellyn @ 2020-10-30 00:13 UTC (permalink / raw)
To: David G. Johnston <david.g.johnston@gmail.com>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
PG Doc comments form wrote:
Look at the account of the COPY statement, here:
https://www.postgresql.org/docs/11/sql-copy.html <https://www.postgresql.org/docs/11/sql-copy.html;
and see this:
«
[ [ WITH ] ( option [, ...] ) ]
»
It goes on to say this:
«
where option can be one of:
FORMAT format_name
»
But there's no list of the allowed values for "format_name". The same holds for other options like, for example, "encoding_name”.
David G. Johnston <david.g.johnston@gmail.com> wrote:
Keep reading…
"""
FORMAT
Selects the data format to be read or written: text, csv (Comma Separated Values), or binary. The default is text.
"""
I suppose including the syntax term "format_type" might help, but the all-caps FORMAT is definitive.
____________________________________________________________
Thanks for the quick reply, David. I do think that it’s reasonable to expect to search in the page rather than to have to read every word from top to bottom in the class of use cases that my example indicates. FORMAT is the syntax keyword; and format_name denotes the value. I think that this present sentence:
«
Selects the data format to be read or written: text, csv (Comma Separated Values), or binary. The default is text.
»
would be improved if it were spelled more explicitly:
«
Selects the data format to be read or written. The allowed values for format_name are text, csv (Comma Separated Values), or binary. The default is text.
»
Please consider making this change (and the convention that it implies for comparable cases).=
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: COPY statement: no list of the allowed values for "format_name"
2020-10-29 17:59 COPY statement: no list of the allowed values for "format_name" PG Doc comments form <noreply@postgresql.org>
2020-10-29 22:29 ` Re: COPY statement: no list of the allowed values for "format_name" David G. Johnston <david.g.johnston@gmail.com>
2020-10-30 00:13 ` Re: COPY statement: no list of the allowed values for "format_name" Bryn Llewellyn <bryn@yugabyte.com>
@ 2020-10-30 00:22 ` David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 0 replies; 4+ messages in thread
From: David G. Johnston @ 2020-10-30 00:22 UTC (permalink / raw)
To: Bryn Llewellyn <bryn@yugabyte.com>; +Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
On Thu, Oct 29, 2020 at 5:13 PM Bryn Llewellyn <bryn@yugabyte.com> wrote:
> «
> Selects the data format to be read or written: text, csv (Comma Separated
> Values), or binary. The default is text.
> »
>
> would be improved if it were spelled more explicitly:
>
> «
> Selects the data format to be read or written. The allowed values
> for format_name are text, csv (Comma Separated Values), or binary. The
> default is text.
> »
>
> Please consider making this change (and the convention that it implies for
> comparable cases).
>
While I agree it isn't something I'm going to lead the charge on. As you
are expressing strong feelings maybe you'd like to write up a patch.
Fixing only COPY would suffice even though I suspect that there are other
areas that need consideration.
David J.
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2020-10-30 00:22 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-10-29 17:59 COPY statement: no list of the allowed values for "format_name" PG Doc comments form <noreply@postgresql.org>
2020-10-29 22:29 ` David G. Johnston <david.g.johnston@gmail.com>
2020-10-30 00:13 ` Bryn Llewellyn <bryn@yugabyte.com>
2020-10-30 00:22 ` David G. Johnston <david.g.johnston@gmail.com>
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