docs: Fix format of CREATE FOREIGN TABLE example in postgres_fdw

Started by Daniel Westermann (DWE)3 days ago4 messageshackers
Jump to latest
#1Daniel Westermann (DWE)
daniel.westermann@dbi-services.com

Hi,

while reading https://www.postgresql.org/docs/devel/postgres-fdw.html I've noticed that there is a single bracket on one line of the CREATE FOREIGN TABLE example.

Browsing through other docs (e,g. https://www.postgresql.org/docs/devel/sql-createtable.html ) there doesn't seem to be a rule for that but if there is a single bracket (e.g. CREATE TABLE distributors), the options that follow usually start at position one and are not indented (or they follow directly after the bracket).

The examples in file_fdw (https://www.postgresql.org/docs/devel/file-fdw.html) follow a mix of options which directly follow the bracket and on a new line.

Attached a small patch which makes it looking a bit better, at least in my opinion.

Regards
Daniel

Attachments:

fix-create-foreign-table-example-format.patchtext/x-patch; name=fix-create-foreign-table-example-format.patchDownload+3-3
#2Yuchen Li
liyuchen_xyz@163.com
In reply to: Daniel Westermann (DWE) (#1)
Re: docs: Fix format of CREATE FOREIGN TABLE example in postgres_fdw

On 4/15/2026 5:27 PM, Daniel Westermann (DWE) wrote:

Hi,

while reading https://www.postgresql.org/docs/devel/postgres-fdw.html
<https://www.postgresql.org/docs/devel/postgres-fdw.html&gt; I've noticed
that there is a single bracket on one line of the CREATE FOREIGN TABLE
example.

Browsing through other docs (e,g.
https://www.postgresql.org/docs/devel/sql-createtable.html
<https://www.postgresql.org/docs/devel/sql-createtable.html&gt; ) there
doesn't seem to be a rule for that but if there is a single bracket
(e.g. CREATE TABLE distributors), the options that follow usually
start at position one and are not indented (or they follow directly
after the bracket).

The examples in file_fdw
(https://www.postgresql.org/docs/devel/file-fdw.html) follow a mix of
options which directly follow the bracket and on a new line.

Attached a small patch which makes it looking a bit better, at least
in my opinion.

Regards
Daniel

While looking through the patch, I noticed a small formatting issue in
the following part:

+)
+SERVER foreign_server
+OPTIONS (schema_name 'some_schema', table_name 'some_table');

The added +) line appears to have a trailing space after the closing
parenthesis.

Regards,
Yuchen Li

#3Daniel Westermann (DWE)
daniel.westermann@dbi-services.com
In reply to: Yuchen Li (#2)
Re: docs: Fix format of CREATE FOREIGN TABLE example in postgres_fdw
+)
+SERVER foreign_server
+OPTIONS (schema_name 'some_schema', table_name 'some_table');

The added +) line appears to have a trailing space after the closing
parenthesis.

Fixed, thank you.

Regards
Daniel

Attachments:

fix-create-foreign-table-example-format_v2.patchtext/x-patch; name=fix-create-foreign-table-example-format_v2.patchDownload+2-2
#4Michael Paquier
michael@paquier.xyz
In reply to: Daniel Westermann (DWE) (#3)
Re: docs: Fix format of CREATE FOREIGN TABLE example in postgres_fdw

On Thu, Apr 16, 2026 at 10:20:02AM +0000, Daniel Westermann (DWE) wrote:

The added +) line appears to have a trailing space after the closing
parenthesis.

Fixed, thank you.

While the grammar of the query itself is correct, I agree that this is
a beautification worth it. Not correcting a problem, just easier for
the eye, so why not :)
--
Michael