Fix the example in the document of file-fdw

Started by Katsuragi Yutaover 5 years ago8 messagesdocs
Jump to latest
#1Katsuragi Yuta
btkatsuragiyu@oss.nttdata.com

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.patchtext/x-diff; name=file_fdw_doc.patchDownload+2-1
#2Fujii Masao
masao.fujii@gmail.com
In reply to: Katsuragi Yuta (#1)
Re: Fix the example in the document of file-fdw

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

#3Michael Paquier
michael@paquier.xyz
In reply to: Fujii Masao (#2)
Re: Fix the example in the document of file-fdw

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

#4Katsuragi Yuta
btkatsuragiyu@oss.nttdata.com
In reply to: Michael Paquier (#3)
Re: Fix the example in the document of file-fdw

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

#5Michael Paquier
michael@paquier.xyz
In reply to: Katsuragi Yuta (#4)
Re: Fix the example in the document of file-fdw

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

#6Fujii Masao
masao.fujii@gmail.com
In reply to: Michael Paquier (#5)
Re: Fix the example in the document of file-fdw

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

#7Michael Paquier
michael@paquier.xyz
In reply to: Fujii Masao (#6)
Re: Fix the example in the document of file-fdw

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

#8Fujii Masao
masao.fujii@gmail.com
In reply to: Michael Paquier (#7)
Re: Fix the example in the document of file-fdw

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