pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Fix the example in the document of file-fdw
8+ messages / 3 participants
[nested] [flat]

* Fix the example in the document of file-fdw
@ 2020-09-14 02:19  btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>
  0 siblings, 1 reply; 8+ messages in thread

From: btkatsuragiyu @ 2020-09-14 02:19 UTC (permalink / raw)
  To: pgsql-docs

Although csvlog has the leader_pid field, the document of file-fdw
that uses csvlog as an example does not reflect this fact.
Concretely, the DDL for table definition does not have the leader_pid 
field.
This patch fixes the DDL in the document of file-fdw.

Regards,
Yuta Katsuragi

Attachments:

file_fdw_doc.patch (text/x-diff, 439B) download diff --git a/doc/src/sgml/file-fdw.sgml b/doc/src/sgml/file-fdw.sgml index eefc6e7e5b..8831f5911f 100644 --- a/doc/src/sgml/file-fdw.sgml +++ b/doc/src/sgml/file-fdw.sgml @@ -265,7 +265,8 @@ CREATE FOREIGN TABLE pglog ( query_pos integer, location text, application_name text, - backend_type text + backend_type text, + leader_pid integer ) SERVER pglog OPTIONS ( filename 'log/pglog.csv', format 'csv' ); </programlisting>
^ permalink raw reply [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-14 02:33  Fujii Masao <masao.fujii@oss.nttdata.com>
  parent: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>
  0 siblings, 1 reply; 8+ messages in thread

From: Fujii Masao @ 2020-09-14 02:33 UTC (permalink / raw)
  To: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>; pgsql-docs



On 2020/09/14 11:19, btkatsuragiyu wrote:
> Although csvlog has the leader_pid field, the document of file-fdw
> that uses csvlog as an example does not reflect this fact.
> Concretely, the DDL for table definition does not have the leader_pid field.

This seems an oversight of commit b8fdee7d0c.

> This patch fixes the DDL in the document of file-fdw.

Thanks for the patch! LGTM. I will commit it.

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION





^ permalink  raw  reply  [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-14 05:07  Michael Paquier <michael@paquier.xyz>
  parent: Fujii Masao <masao.fujii@oss.nttdata.com>
  0 siblings, 1 reply; 8+ messages in thread

From: Michael Paquier @ 2020-09-14 05:07 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>; pgsql-docs

On Mon, Sep 14, 2020 at 11:33:23AM +0900, Fujii Masao wrote:
> On 2020/09/14 11:19, btkatsuragiyu wrote:
>> Although csvlog has the leader_pid field, the document of file-fdw
>> that uses csvlog as an example does not reflect this fact.
>> Concretely, the DDL for table definition does not have the leader_pid field.
> 
> This seems an oversight of commit b8fdee7d0c.

Dammit, I thought that I had all the places for that stuff done.  The
patch looks fine to me.

>> This patch fixes the DDL in the document of file-fdw.
> 
> Thanks for the patch! LGTM. I will commit it.

Hmm.  Instead of keeping a copy-paste of the same table in both
config.sgml and file-fdw.sgml, why not having only one?  It seems to 
me that we could just have the file_fdw doc refer to the main
configuration, and it is not difficult to guess how the CREATE TABLE
query needs to be changed to map with foreign table.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-14 07:10  btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>
  parent: Michael Paquier <michael@paquier.xyz>
  0 siblings, 1 reply; 8+ messages in thread

From: btkatsuragiyu @ 2020-09-14 07:10 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; +Cc: Fujii Masao <masao.fujii@oss.nttdata.com>; pgsql-docs

On 2020-09-14 14:07, Michael Paquier wrote:
> On Mon, Sep 14, 2020 at 11:33:23AM +0900, Fujii Masao wrote:
>> On 2020/09/14 11:19, btkatsuragiyu wrote:
>>> This patch fixes the DDL in the document of file-fdw.
>> 
>> Thanks for the patch! LGTM. I will commit it.
> 
> Hmm.  Instead of keeping a copy-paste of the same table in both
> config.sgml and file-fdw.sgml, why not having only one?

I agree with this comment.

> It seems to me that we could just have the file_fdw doc refer to the 
> main
> configuration, and it is not difficult to guess how the CREATE TABLE
> query needs to be changed to map with foreign table.

However, I think showing complete DDL including SERVER pglog and OPTIONS 
would be helpful
to users who are not familiar with this feature.

Regards,
Yuta Katsuragi





^ permalink  raw  reply  [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-14 07:56  Michael Paquier <michael@paquier.xyz>
  parent: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>
  0 siblings, 1 reply; 8+ messages in thread

From: Michael Paquier @ 2020-09-14 07:56 UTC (permalink / raw)
  To: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>; +Cc: Fujii Masao <masao.fujii@oss.nttdata.com>; pgsql-docs

On Mon, Sep 14, 2020 at 04:10:03PM +0900, btkatsuragiyu wrote:
> However, I think showing complete DDL including SERVER pglog and OPTIONS
> would be helpful
> to users who are not familiar with this feature.

Yeah, this could be mentioned on the doc page for file_fdw with an
extra sentence, but I agree that it is more complex to understand that
than a simple copy-paste from the doc itself.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-15 07:43  Fujii Masao <masao.fujii@oss.nttdata.com>
  parent: Michael Paquier <michael@paquier.xyz>
  0 siblings, 1 reply; 8+ messages in thread

From: Fujii Masao @ 2020-09-15 07:43 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>; +Cc: pgsql-docs



On 2020/09/14 16:56, Michael Paquier wrote:
> On Mon, Sep 14, 2020 at 04:10:03PM +0900, btkatsuragiyu wrote:
>> However, I think showing complete DDL including SERVER pglog and OPTIONS
>> would be helpful
>> to users who are not familiar with this feature.

Agreed.


> Yeah, this could be mentioned on the doc page for file_fdw with an
> extra sentence, but I agree that it is more complex to understand that
> than a simple copy-paste from the doc itself.

So ISTM our consensus is to apply the proposed patch.
Barring any objection, I will do that.

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION





^ permalink  raw  reply  [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-15 07:59  Michael Paquier <michael@paquier.xyz>
  parent: Fujii Masao <masao.fujii@oss.nttdata.com>
  0 siblings, 1 reply; 8+ messages in thread

From: Michael Paquier @ 2020-09-15 07:59 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@oss.nttdata.com>; +Cc: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>; pgsql-docs

On Tue, Sep 15, 2020 at 04:43:39PM +0900, Fujii Masao wrote:
> So ISTM our consensus is to apply the proposed patch.
> Barring any objection, I will do that.

No objections from here at the end.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 8+ messages in thread

* Re: Fix the example in the document of file-fdw
@ 2020-09-16 09:49  Fujii Masao <masao.fujii@oss.nttdata.com>
  parent: Michael Paquier <michael@paquier.xyz>
  0 siblings, 0 replies; 8+ messages in thread

From: Fujii Masao @ 2020-09-16 09:49 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; +Cc: btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>; pgsql-docs



On 2020/09/15 16:59, Michael Paquier wrote:
> On Tue, Sep 15, 2020 at 04:43:39PM +0900, Fujii Masao wrote:
>> So ISTM our consensus is to apply the proposed patch.
>> Barring any objection, I will do that.
> 
> No objections from here at the end.

Pushed. Thanks!

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION





^ permalink  raw  reply  [nested|flat] 8+ messages in thread


end of thread, other threads:[~2020-09-16 09:49 UTC | newest]

Thread overview: 8+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-09-14 02:19 Fix the example in the document of file-fdw btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>
2020-09-14 02:33 ` Fujii Masao <masao.fujii@oss.nttdata.com>
2020-09-14 05:07   ` Michael Paquier <michael@paquier.xyz>
2020-09-14 07:10     ` btkatsuragiyu <btkatsuragiyu@oss.nttdata.com>
2020-09-14 07:56       ` Michael Paquier <michael@paquier.xyz>
2020-09-15 07:43         ` Fujii Masao <masao.fujii@oss.nttdata.com>
2020-09-15 07:59           ` Michael Paquier <michael@paquier.xyz>
2020-09-16 09:49             ` Fujii Masao <masao.fujii@oss.nttdata.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