pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedInclude PostgresNIO Swift client in the Documentation
9+ messages / 3 participants
[nested] [flat]
* Include PostgresNIO Swift client in the Documentation
@ 2023-08-10 07:55 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 9+ messages in thread
From: PG Doc comments form @ 2023-08-10 07:55 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: fabianfett@mac.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/15/external-interfaces.html
Description:
Hi,
I'm reaching out to ask if the Swift Postgres could be included in the
listing here:
https://www.postgresql.org/docs/current/external-interfaces.html
Name: PostgresNIO
Language: Swift
Comments: Non-blocking, event-driven client built with SwiftNIO
Website: https://github.com/vapor/postgres-nio
Thanks for your time and consideration,
Fabian Fett
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-11 00:23 Jonathan S. Katz <jkatz@postgresql.org>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 9+ messages in thread
From: Jonathan S. Katz @ 2023-08-11 00:23 UTC (permalink / raw)
To: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
Hi Fabian,
On 8/10/23 3:55 AM, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/15/external-interfaces.html
> Description:
>
> Hi,
>
> I'm reaching out to ask if the Swift Postgres could be included in the
> listing here:
>
> https://www.postgresql.org/docs/current/external-interfaces.html
>
> Name: PostgresNIO
> Language: Swift
> Comments: Non-blocking, event-driven client built with SwiftNIO
> Website: https://github.com/vapor/postgres-nio
As of late, we've been keeping the canonical list on the wiki page here,
which already includes PostgresNIO:
https://wiki.postgresql.org/wiki/List_of_drivers
The last time this came up, I think we discussed linking to the wiki
page from the docs, vs. trying to keep the docs up-to-date with all of
the drivers available. Perhaps it's worth seeing if we want to make any
changes to the docs page prior to the v16 GA?
Thanks,
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../182a8337-75e6-8da9-9736-5135f904c525@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-21 11:58 Daniel Gustafsson <daniel@yesql.se>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 1 reply; 9+ messages in thread
From: Daniel Gustafsson @ 2023-08-21 11:58 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
> On 11 Aug 2023, at 02:23, Jonathan S. Katz <jkatz@postgresql.org> wrote:
> The last time this came up, I think we discussed linking to the wiki page from the docs, vs. trying to keep the docs up-to-date with all of the drivers available. Perhaps it's worth seeing if we want to make any changes to the docs page prior to the v16 GA?
The docs page does mention that the list is likely to be incomplete, with the
following sentence, but there is no mention of the Wiki page at all:
"Table H.1 includes a list of some of these projects."
That being said, a lot of readers will likely skim over and immediately look at
the table, missing the small disclaimer. I wonder if we aren't serving our
users better by removing the table and only referring to the Wiki page? Having
two lists will prompt the discussion of what to include where over and over
again, which isn't helping anyone.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-21 14:55 Jonathan S. Katz <jkatz@postgresql.org>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 9+ messages in thread
From: Jonathan S. Katz @ 2023-08-21 14:55 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
On 8/21/23 7:58 AM, Daniel Gustafsson wrote:
>> On 11 Aug 2023, at 02:23, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>
>> The last time this came up, I think we discussed linking to the wiki page from the docs, vs. trying to keep the docs up-to-date with all of the drivers available. Perhaps it's worth seeing if we want to make any changes to the docs page prior to the v16 GA?
>
> The docs page does mention that the list is likely to be incomplete, with the
> following sentence, but there is no mention of the Wiki page at all:
>
> "Table H.1 includes a list of some of these projects."
>
> That being said, a lot of readers will likely skim over and immediately look at
> the table, missing the small disclaimer. I wonder if we aren't serving our
> users better by removing the table and only referring to the Wiki page? Having
> two lists will prompt the discussion of what to include where over and over
> again, which isn't helping anyone.
This is what I was saying. I was waiting on attempting a patch to see if
there was consensus. There's now a couple of threads now with similar
suggestions, I'll work on getting patches ready.
Thanks,
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../82c08afc-6d41-7766-b3ac-755ac4ac78f4@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-22 03:23 Jonathan S. Katz <jkatz@postgresql.org>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 1 reply; 9+ messages in thread
From: Jonathan S. Katz @ 2023-08-22 03:23 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
On 8/21/23 10:55 AM, Jonathan S. Katz wrote:
> On 8/21/23 7:58 AM, Daniel Gustafsson wrote:
>>> On 11 Aug 2023, at 02:23, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>>
>>> The last time this came up, I think we discussed linking to the wiki
>>> page from the docs, vs. trying to keep the docs up-to-date with all
>>> of the drivers available. Perhaps it's worth seeing if we want to
>>> make any changes to the docs page prior to the v16 GA?
>>
>> The docs page does mention that the list is likely to be incomplete,
>> with the
>> following sentence, but there is no mention of the Wiki page at all:
>>
>> "Table H.1 includes a list of some of these projects."
>>
>> That being said, a lot of readers will likely skim over and
>> immediately look at
>> the table, missing the small disclaimer. I wonder if we aren't
>> serving our
>> users better by removing the table and only referring to the Wiki
>> page? Having
>> two lists will prompt the discussion of what to include where over and
>> over
>> again, which isn't helping anyone.
>
> This is what I was saying. I was waiting on attempting a patch to see if
> there was consensus. There's now a couple of threads now with similar
> suggestions, I'll work on getting patches ready.
Suggested patch attached. Notes:
1. Replaced language to reference the wiki page
2. Replaced table with the URL
3. Changed the "licenses" comment to be more affirmative, i.e., there
are language interfaces that are released under licenses different than
the PostgreSQL Licence.
Jonathan
diff --git a/doc/src/sgml/external-projects.sgml b/doc/src/sgml/external-projects.sgml
index 2d0fd723b2..110692da7d 100644
--- a/doc/src/sgml/external-projects.sgml
+++ b/doc/src/sgml/external-projects.sgml
@@ -40,99 +40,17 @@
</itemizedlist>
All other language interfaces are external projects and are distributed
- separately. <xref linkend="language-interface-table"/> includes a list of
- some of these projects. Note that some of these packages might not be
- released under the same license as <productname>PostgreSQL</productname>. For more
- information on each language interface, including licensing terms, refer to
- its website and documentation.
+ separately. A
+ <ulink url="https://wiki.postgresql.org/wiki/List_of_drivers">list of language interfaces</ulink>
+ is maintained on the PostgreSQL wiki. Note that some of these packages are
+ not released under the same license as <productname>PostgreSQL</productname>.
+ For more information on each language interface, including licensing terms,
+ refer to its website and documentation.
</para>
- <table id="language-interface-table">
- <title>Externally Maintained Client Interfaces</title>
-
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Language</entry>
- <entry>Comments</entry>
- <entry>Website</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>DBD::Pg</entry>
- <entry>Perl</entry>
- <entry>Perl DBI driver</entry>
- <entry><ulink url="https://metacpan.org/dist/DBD-Pg"></ulink></entry;
- </row>
-
- <row>
- <entry>JDBC</entry>
- <entry>Java</entry>
- <entry>Type 4 JDBC driver</entry>
- <entry><ulink url="https://jdbc.postgresql.org/"></ulink></entry;
- </row>
-
- <row>
- <entry>libpqxx</entry>
- <entry>C++</entry>
- <entry>C++ interface</entry>
- <entry><ulink url="https://pqxx.org/"></ulink></entry;
- </row>
-
- <row>
- <entry>node-postgres</entry>
- <entry>JavaScript</entry>
- <entry>Node.js driver</entry>
- <entry><ulink url="https://node-postgres.com/"></ulink></entry;
- </row>
-
- <row>
- <entry>Npgsql</entry>
- <entry>.NET</entry>
- <entry>.NET data provider</entry>
- <entry><ulink url="https://www.npgsql.org/"></ulink></entry;
- </row>
-
- <row>
- <entry>pgtcl</entry>
- <entry>Tcl</entry>
- <entry></entry>
- <entry><ulink url="https://github.com/flightaware/Pgtcl"></ulink></entry;
- </row>
-
- <row>
- <entry>pgtclng</entry>
- <entry>Tcl</entry>
- <entry></entry>
- <entry><ulink url="https://sourceforge.net/projects/pgtclng/"></ulink></entry;
- </row>
-
- <row>
- <entry>pq</entry>
- <entry>Go</entry>
- <entry>Pure Go driver for Go's database/sql</entry>
- <entry><ulink url="https://github.com/lib/pq"></ulink></entry;
- </row>
-
- <row>
- <entry>psqlODBC</entry>
- <entry>ODBC</entry>
- <entry>ODBC driver</entry>
- <entry><ulink url="https://odbc.postgresql.org/"></ulink></entry;
- </row>
-
- <row>
- <entry>psycopg</entry>
- <entry>Python</entry>
- <entry>DB API 2.0-compliant</entry>
- <entry><ulink url="https://www.psycopg.org/"></ulink></entry;
- </row>
- </tbody>
- </tgroup>
- </table>
+ <para>
+ <ulink url="https://wiki.postgresql.org/wiki/List_of_drivers"></ulink;
+ </para>
</sect1>
<sect1 id="external-admin-tools">
Attachments:
[text/plain] docs-drivers-wiki.patch (3.5K, ../../4b62ba2c-0bfb-700c-6a37-93a21ae167ab@postgresql.org/2-docs-drivers-wiki.patch)
download | inline diff:
diff --git a/doc/src/sgml/external-projects.sgml b/doc/src/sgml/external-projects.sgml
index 2d0fd723b2..110692da7d 100644
--- a/doc/src/sgml/external-projects.sgml
+++ b/doc/src/sgml/external-projects.sgml
@@ -40,99 +40,17 @@
</itemizedlist>
All other language interfaces are external projects and are distributed
- separately. <xref linkend="language-interface-table"/> includes a list of
- some of these projects. Note that some of these packages might not be
- released under the same license as <productname>PostgreSQL</productname>. For more
- information on each language interface, including licensing terms, refer to
- its website and documentation.
+ separately. A
+ <ulink url="https://wiki.postgresql.org/wiki/List_of_drivers">list of language interfaces</ulink>
+ is maintained on the PostgreSQL wiki. Note that some of these packages are
+ not released under the same license as <productname>PostgreSQL</productname>.
+ For more information on each language interface, including licensing terms,
+ refer to its website and documentation.
</para>
- <table id="language-interface-table">
- <title>Externally Maintained Client Interfaces</title>
-
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Language</entry>
- <entry>Comments</entry>
- <entry>Website</entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>DBD::Pg</entry>
- <entry>Perl</entry>
- <entry>Perl DBI driver</entry>
- <entry><ulink url="https://metacpan.org/dist/DBD-Pg"></ulink></entry>
- </row>
-
- <row>
- <entry>JDBC</entry>
- <entry>Java</entry>
- <entry>Type 4 JDBC driver</entry>
- <entry><ulink url="https://jdbc.postgresql.org/"></ulink></entry>
- </row>
-
- <row>
- <entry>libpqxx</entry>
- <entry>C++</entry>
- <entry>C++ interface</entry>
- <entry><ulink url="https://pqxx.org/"></ulink></entry>
- </row>
-
- <row>
- <entry>node-postgres</entry>
- <entry>JavaScript</entry>
- <entry>Node.js driver</entry>
- <entry><ulink url="https://node-postgres.com/"></ulink></entry>
- </row>
-
- <row>
- <entry>Npgsql</entry>
- <entry>.NET</entry>
- <entry>.NET data provider</entry>
- <entry><ulink url="https://www.npgsql.org/"></ulink></entry>
- </row>
-
- <row>
- <entry>pgtcl</entry>
- <entry>Tcl</entry>
- <entry></entry>
- <entry><ulink url="https://github.com/flightaware/Pgtcl"></ulink></entry>
- </row>
-
- <row>
- <entry>pgtclng</entry>
- <entry>Tcl</entry>
- <entry></entry>
- <entry><ulink url="https://sourceforge.net/projects/pgtclng/"></ulink></entry>
- </row>
-
- <row>
- <entry>pq</entry>
- <entry>Go</entry>
- <entry>Pure Go driver for Go's database/sql</entry>
- <entry><ulink url="https://github.com/lib/pq"></ulink></entry>
- </row>
-
- <row>
- <entry>psqlODBC</entry>
- <entry>ODBC</entry>
- <entry>ODBC driver</entry>
- <entry><ulink url="https://odbc.postgresql.org/"></ulink></entry>
- </row>
-
- <row>
- <entry>psycopg</entry>
- <entry>Python</entry>
- <entry>DB API 2.0-compliant</entry>
- <entry><ulink url="https://www.psycopg.org/"></ulink></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
+ <para>
+ <ulink url="https://wiki.postgresql.org/wiki/List_of_drivers"></ulink>
+ </para>
</sect1>
<sect1 id="external-admin-tools">
[application/pgp-signature] OpenPGP_signature (839B, ../../4b62ba2c-0bfb-700c-6a37-93a21ae167ab@postgresql.org/3-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-22 07:10 Daniel Gustafsson <daniel@yesql.se>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 1 reply; 9+ messages in thread
From: Daniel Gustafsson @ 2023-08-22 07:10 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
> On 22 Aug 2023, at 05:23, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>
> On 8/21/23 10:55 AM, Jonathan S. Katz wrote:
>> On 8/21/23 7:58 AM, Daniel Gustafsson wrote:
>>>> On 11 Aug 2023, at 02:23, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>>>
>>>> The last time this came up, I think we discussed linking to the wiki page from the docs, vs. trying to keep the docs up-to-date with all of the drivers available. Perhaps it's worth seeing if we want to make any changes to the docs page prior to the v16 GA?
>>>
>>> The docs page does mention that the list is likely to be incomplete, with the
>>> following sentence, but there is no mention of the Wiki page at all:
>>>
>>> "Table H.1 includes a list of some of these projects."
>>>
>>> That being said, a lot of readers will likely skim over and immediately look at
>>> the table, missing the small disclaimer. I wonder if we aren't serving our
>>> users better by removing the table and only referring to the Wiki page? Having
>>> two lists will prompt the discussion of what to include where over and over
>>> again, which isn't helping anyone.
>> This is what I was saying. I was waiting on attempting a patch to see if there was consensus. There's now a couple of threads now with similar suggestions, I'll work on getting patches ready.
>
> Suggested patch attached. Notes:
>
> 1. Replaced language to reference the wiki page
> 2. Replaced table with the URL
> 3. Changed the "licenses" comment to be more affirmative, i.e., there are language interfaces that are released under licenses different than the PostgreSQL Licence.
This is in line with what I imagined as well, so unless anyone thinks otherwise
I will apply this and backpatch it to all branches.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-22 14:25 Jonathan S. Katz <jkatz@postgresql.org>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 9+ messages in thread
From: Jonathan S. Katz @ 2023-08-22 14:25 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
On 8/22/23 3:10 AM, Daniel Gustafsson wrote:
> This is in line with what I imagined as well, so unless anyone thinks otherwise
> I will apply this and backpatch it to all branches.
I could argue it both ways on whether or not to backpatch. However,
given the list of drivers should work with all supported PG releases,
and it expands on the current known list, I'd +1 backpatching.
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../1b6d7cab-83a9-1781-ce82-1b97b3eb6b8a@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-23 12:41 Daniel Gustafsson <daniel@yesql.se>
parent: Jonathan S. Katz <jkatz@postgresql.org>
0 siblings, 1 reply; 9+ messages in thread
From: Daniel Gustafsson @ 2023-08-23 12:41 UTC (permalink / raw)
To: Jonathan S. Katz <jkatz@postgresql.org>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
> On 22 Aug 2023, at 16:25, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>
> On 8/22/23 3:10 AM, Daniel Gustafsson wrote:
>
>> This is in line with what I imagined as well, so unless anyone thinks otherwise
>> I will apply this and backpatch it to all branches.
>
> I could argue it both ways on whether or not to backpatch. However, given the list of drivers should work with all supported PG releases, and it expands on the current known list, I'd +1 backpatching.
I opted for backpatching as the table is equally incomplete for all branches,
and the wiki equally applicable.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 9+ messages in thread
* Re: Include PostgresNIO Swift client in the Documentation
@ 2023-08-23 13:57 Jonathan S. Katz <jkatz@postgresql.org>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 0 replies; 9+ messages in thread
From: Jonathan S. Katz @ 2023-08-23 13:57 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: fabianfett@mac.com; pgsql-docs@lists.postgresql.org
On 8/23/23 8:41 AM, Daniel Gustafsson wrote:
>> On 22 Aug 2023, at 16:25, Jonathan S. Katz <jkatz@postgresql.org> wrote:
>>
>> On 8/22/23 3:10 AM, Daniel Gustafsson wrote:
>>
>>> This is in line with what I imagined as well, so unless anyone thinks otherwise
>>> I will apply this and backpatch it to all branches.
>>
>> I could argue it both ways on whether or not to backpatch. However, given the list of drivers should work with all supported PG releases, and it expands on the current known list, I'd +1 backpatching.
>
> I opted for backpatching as the table is equally incomplete for all branches,
> and the wiki equally applicable.
Agreed; thanks!
Jonathan
Attachments:
[application/pgp-signature] OpenPGP_signature (839B, ../../6aa3a120-c0f5-42d3-5b63-bfcf5fa8f77b@postgresql.org/2-OpenPGP_signature)
download
^ permalink raw reply [nested|flat] 9+ messages in thread
end of thread, other threads:[~2023-08-23 13:57 UTC | newest]
Thread overview: 9+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-08-10 07:55 Include PostgresNIO Swift client in the Documentation PG Doc comments form <noreply@postgresql.org>
2023-08-11 00:23 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-08-21 11:58 ` Daniel Gustafsson <daniel@yesql.se>
2023-08-21 14:55 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-08-22 03:23 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-08-22 07:10 ` Daniel Gustafsson <daniel@yesql.se>
2023-08-22 14:25 ` Jonathan S. Katz <jkatz@postgresql.org>
2023-08-23 12:41 ` Daniel Gustafsson <daniel@yesql.se>
2023-08-23 13:57 ` Jonathan S. Katz <jkatz@postgresql.org>
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