public inbox for [email protected]
help / color / mirror / Atom feedadd argument type to postgres_fdw docs
4+ messages / 2 participants
[nested] [flat]
* add argument type to postgres_fdw docs
@ 2021-06-16 03:39 [email protected]
2021-06-16 04:24 ` Re: add argument type to postgres_fdw docs Fujii Masao <[email protected]>
0 siblings, 1 reply; 4+ messages in thread
From: [email protected] @ 2021-06-16 03:39 UTC (permalink / raw)
To: [email protected]
Hi,
I add argument type to postgres-fdw parameters in postgres-fdw.sgml.
I think this change is kind. Do you think?
Regards,
Shinya Kato
Attachments:
[application/octet-stream] add_argument_type_to_postgres-fdw_docs.patch (5.5K, 2-add_argument_type_to_postgres-fdw_docs.patch)
download | inline diff:
diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index d96c3d0f0c..a6c053daa7 100644
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -195,7 +195,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>schema_name</literal></term>
+ <term><literal>schema_name</literal> (<type>string</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign table, gives the
@@ -206,7 +206,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>table_name</literal></term>
+ <term><literal>table_name</literal> (<type>string</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign table, gives the
@@ -217,7 +217,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>column_name</literal></term>
+ <term><literal>column_name</literal> (<type>string</type>)</term>
<listitem>
<para>
This option, which can be specified for a column of a foreign table,
@@ -249,7 +249,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>use_remote_estimate</literal></term>
+ <term><literal>use_remote_estimate</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign table or a foreign
@@ -263,7 +263,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>fdw_startup_cost</literal></term>
+ <term><literal>fdw_startup_cost</literal> (<type>double precision</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign server, is a numeric
@@ -277,7 +277,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>fdw_tuple_cost</literal></term>
+ <term><literal>fdw_tuple_cost</literal> (<type>double precision</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign server, is a numeric
@@ -329,7 +329,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>extensions</literal></term>
+ <term><literal>extensions</literal> (<type>enum</type>)</term>
<listitem>
<para>
This option is a comma-separated list of names
@@ -350,7 +350,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>fetch_size</literal></term>
+ <term><literal>fetch_size</literal> (<type>integer</type>)</term>
<listitem>
<para>
This option specifies the number of rows <filename>postgres_fdw</filename>
@@ -363,7 +363,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>batch_size</literal></term>
+ <term><literal>batch_size</literal> (<type>integer</type>)</term>
<listitem>
<para>
This option specifies the number of rows <filename>postgres_fdw</filename>
@@ -403,7 +403,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>async_capable</literal></term>
+ <term><literal>async_capable</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> allows
@@ -452,7 +452,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>updatable</literal></term>
+ <term><literal>updatable</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> allows foreign
@@ -489,7 +489,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>truncatable</literal></term>
+ <term><literal>truncatable</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> allows
@@ -528,7 +528,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>import_collate</literal></term>
+ <term><literal>import_collate</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether column <literal>COLLATE</literal> options
@@ -541,7 +541,7 @@ OPTIONS (ADD password_required 'false');
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>import_default</literal></term>
+ <term><literal>import_default</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether column <literal>DEFAULT</literal> expressions
@@ -556,7 +556,7 @@ OPTIONS (ADD password_required 'false');
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>import_not_null</literal></term>
+ <term><literal>import_not_null</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether column <literal>NOT NULL</literal>
@@ -606,7 +606,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>keep_connections</literal></term>
+ <term><literal>keep_connections</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> keeps
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: add argument type to postgres_fdw docs
2021-06-16 03:39 add argument type to postgres_fdw docs [email protected]
@ 2021-06-16 04:24 ` Fujii Masao <[email protected]>
2021-06-16 05:13 ` RE: add argument type to postgres_fdw docs [email protected]
0 siblings, 1 reply; 4+ messages in thread
From: Fujii Masao @ 2021-06-16 04:24 UTC (permalink / raw)
To: [email protected]; [email protected]
On 2021/06/16 12:39, [email protected] wrote:
> Hi,
>
> I add argument type to postgres-fdw parameters in postgres-fdw.sgml.
> I think this change is kind. Do you think?
I think this change would improve the postgres_fdw docs.
- <term><literal>extensions</literal></term>
+ <term><literal>extensions</literal> (<type>enum</type>)</term>
Since each value in "extensions" parameter is not limitted like
shared_preload_libraries, its type should be "string"?
- <term><literal>fdw_startup_cost</literal></term>
+ <term><literal>fdw_startup_cost</literal> (<type>double precision</type>)</term>
- <term><literal>fdw_tuple_cost</literal></term>
+ <term><literal>fdw_tuple_cost</literal> (<type>double precision</type>)</term>
Since "floating point" is used for GUC docs, "floating point" should be
used for the sake of consistenty, instead?
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
^ permalink raw reply [nested|flat] 4+ messages in thread
* RE: add argument type to postgres_fdw docs
2021-06-16 03:39 add argument type to postgres_fdw docs [email protected]
2021-06-16 04:24 ` Re: add argument type to postgres_fdw docs Fujii Masao <[email protected]>
@ 2021-06-16 05:13 ` [email protected]
2021-06-30 10:37 ` Re: add argument type to postgres_fdw docs Fujii Masao <[email protected]>
0 siblings, 1 reply; 4+ messages in thread
From: [email protected] @ 2021-06-16 05:13 UTC (permalink / raw)
To: [email protected]; [email protected]; [email protected]
>- <term><literal>extensions</literal></term>
>+ <term><literal>extensions</literal> (<type>enum</type>)</term>
>
>Since each value in "extensions" parameter is not limitted like
>shared_preload_libraries, its type should be "string"?
Yes, I fixed it.
>
>- <term><literal>fdw_startup_cost</literal></term>
>+ <term><literal>fdw_startup_cost</literal> (<type>double
>+ precision</type>)</term>
>- <term><literal>fdw_tuple_cost</literal></term>
>+ <term><literal>fdw_tuple_cost</literal> (<type>double
>+ precision</type>)</term>
>
>Since "floating point" is used for GUC docs, "floating point" should be used for
>the sake of consistenty, instead?
Sure, I changed "double precision" to "floating point".
Best regards,
Shinya Kato
Attachments:
[application/octet-stream] add_argument_type_to_postgres-fdw_docs_v2.patch (5.5K, 2-add_argument_type_to_postgres-fdw_docs_v2.patch)
download | inline diff:
diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml
index d96c3d0f0c..d7d2baafc9 100644
--- a/doc/src/sgml/postgres-fdw.sgml
+++ b/doc/src/sgml/postgres-fdw.sgml
@@ -195,7 +195,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>schema_name</literal></term>
+ <term><literal>schema_name</literal> (<type>string</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign table, gives the
@@ -206,7 +206,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>table_name</literal></term>
+ <term><literal>table_name</literal> (<type>string</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign table, gives the
@@ -217,7 +217,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>column_name</literal></term>
+ <term><literal>column_name</literal> (<type>string</type>)</term>
<listitem>
<para>
This option, which can be specified for a column of a foreign table,
@@ -249,7 +249,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>use_remote_estimate</literal></term>
+ <term><literal>use_remote_estimate</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign table or a foreign
@@ -263,7 +263,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>fdw_startup_cost</literal></term>
+ <term><literal>fdw_startup_cost</literal> (<type>floating point</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign server, is a numeric
@@ -277,7 +277,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>fdw_tuple_cost</literal></term>
+ <term><literal>fdw_tuple_cost</literal> (<type>floating point</type>)</term>
<listitem>
<para>
This option, which can be specified for a foreign server, is a numeric
@@ -329,7 +329,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>extensions</literal></term>
+ <term><literal>extensions</literal> (<type>string</type>)</term>
<listitem>
<para>
This option is a comma-separated list of names
@@ -350,7 +350,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>fetch_size</literal></term>
+ <term><literal>fetch_size</literal> (<type>integer</type>)</term>
<listitem>
<para>
This option specifies the number of rows <filename>postgres_fdw</filename>
@@ -363,7 +363,7 @@ OPTIONS (ADD password_required 'false');
</varlistentry>
<varlistentry>
- <term><literal>batch_size</literal></term>
+ <term><literal>batch_size</literal> (<type>integer</type>)</term>
<listitem>
<para>
This option specifies the number of rows <filename>postgres_fdw</filename>
@@ -403,7 +403,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>async_capable</literal></term>
+ <term><literal>async_capable</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> allows
@@ -452,7 +452,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>updatable</literal></term>
+ <term><literal>updatable</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> allows foreign
@@ -489,7 +489,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>truncatable</literal></term>
+ <term><literal>truncatable</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> allows
@@ -528,7 +528,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>import_collate</literal></term>
+ <term><literal>import_collate</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether column <literal>COLLATE</literal> options
@@ -541,7 +541,7 @@ OPTIONS (ADD password_required 'false');
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>import_default</literal></term>
+ <term><literal>import_default</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether column <literal>DEFAULT</literal> expressions
@@ -556,7 +556,7 @@ OPTIONS (ADD password_required 'false');
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>import_not_null</literal></term>
+ <term><literal>import_not_null</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether column <literal>NOT NULL</literal>
@@ -606,7 +606,7 @@ OPTIONS (ADD password_required 'false');
<variablelist>
<varlistentry>
- <term><literal>keep_connections</literal></term>
+ <term><literal>keep_connections</literal> (<type>boolean</type>)</term>
<listitem>
<para>
This option controls whether <filename>postgres_fdw</filename> keeps
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: add argument type to postgres_fdw docs
2021-06-16 03:39 add argument type to postgres_fdw docs [email protected]
2021-06-16 04:24 ` Re: add argument type to postgres_fdw docs Fujii Masao <[email protected]>
2021-06-16 05:13 ` RE: add argument type to postgres_fdw docs [email protected]
@ 2021-06-30 10:37 ` Fujii Masao <[email protected]>
0 siblings, 0 replies; 4+ messages in thread
From: Fujii Masao @ 2021-06-30 10:37 UTC (permalink / raw)
To: [email protected]; [email protected]
On 2021/06/16 14:13, [email protected] wrote:
>> - <term><literal>extensions</literal></term>
>> + <term><literal>extensions</literal> (<type>enum</type>)</term>
>>
>> Since each value in "extensions" parameter is not limitted like
>> shared_preload_libraries, its type should be "string"?
> Yes, I fixed it.
Thanks for updating the patch! Pushed.
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2021-06-30 10:37 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2021-06-16 03:39 add argument type to postgres_fdw docs [email protected]
2021-06-16 04:24 ` Fujii Masao <[email protected]>
2021-06-16 05:13 ` [email protected]
2021-06-30 10:37 ` Fujii Masao <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox