Add mention to related system catalog functions on Tablespaces documentation pages.

Started by PG Bug reporting formover 1 year ago4 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/manage-ag-tablespaces.html
Description:

The tablespaces documentation page seems to be missing a mention to the
following functions:
pg_tablespace_databases
pg_tablespace_location

These are documented in
https://www.postgresql.org/docs/current/functions-info.html#FUNCTIONS-INFO-CATALOG,
but I think it would be nice to add at least a brief mention (or link) to
them in the main tablespace docs. The following query is especially helpful
when troubleshooting issues with tablespaces:

postgres=# SELECT *, pg_tablespace_location(oid) FROM pg_tablespace;

It would be beneficial, in my opinion, to use it as an additional example to
the one that is currently shown.

Best,
Agustín.

#2Bruce Momjian
bruce@momjian.us
In reply to: PG Bug reporting form (#1)
Re: Add mention to related system catalog functions on Tablespaces documentation pages.

On Wed, Sep 11, 2024 at 11:26:50PM +0000, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/manage-ag-tablespaces.html
Description:

The tablespaces documentation page seems to be missing a mention to the
following functions:
pg_tablespace_databases
pg_tablespace_location

These are documented in
https://www.postgresql.org/docs/current/functions-info.html#FUNCTIONS-INFO-CATALOG,
but I think it would be nice to add at least a brief mention (or link) to
them in the main tablespace docs. The following query is especially helpful
when troubleshooting issues with tablespaces:

postgres=# SELECT *, pg_tablespace_location(oid) FROM pg_tablespace;

It would be beneficial, in my opinion, to use it as an additional example to
the one that is currently shown.

Yes, very good points. I have developed the attached patch which I
think achieves the goals you mentioned. I plan to apply the patch for
master/PG 18.

I also removed the unnecessary mention of PG 9.1.

Seems the reply email address is g***@gmail.com, which seems like some
kind of mistake.

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

When a patient asks the doctor, "Am I going to die?", he means
"Am I going to die soon?"

#3Bruce Momjian
bruce@momjian.us
In reply to: Bruce Momjian (#2)
Re: Add mention to related system catalog functions on Tablespaces documentation pages.

On Mon, Oct 14, 2024 at 07:15:50PM -0400, Bruce Momjian wrote:

On Wed, Sep 11, 2024 at 11:26:50PM +0000, PG Doc comments form wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/manage-ag-tablespaces.html
Description:

The tablespaces documentation page seems to be missing a mention to the
following functions:
pg_tablespace_databases
pg_tablespace_location

These are documented in
https://www.postgresql.org/docs/current/functions-info.html#FUNCTIONS-INFO-CATALOG,
but I think it would be nice to add at least a brief mention (or link) to
them in the main tablespace docs. The following query is especially helpful
when troubleshooting issues with tablespaces:

postgres=# SELECT *, pg_tablespace_location(oid) FROM pg_tablespace;

It would be beneficial, in my opinion, to use it as an additional example to
the one that is currently shown.

Yes, very good points. I have developed the attached patch which I
think achieves the goals you mentioned. I plan to apply the patch for
master/PG 18.

I also removed the unnecessary mention of PG 9.1.

Seems the reply email address is g***@gmail.com, which seems like some
kind of mistake.

Sorry, patch attached. Invalid email address removed.

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

When a patient asks the doctor, "Am I going to die?", he means
"Am I going to die soon?"

Attachments:

tablespace.difftext/x-diff; charset=us-asciiDownload+5-6
#4Bruce Momjian
bruce@momjian.us
In reply to: Bruce Momjian (#3)
Re: Add mention to related system catalog functions on Tablespaces documentation pages.

On Mon, Oct 14, 2024 at 07:21:32PM -0400, Bruce Momjian wrote:

On Mon, Oct 14, 2024 at 07:15:50PM -0400, Bruce Momjian wrote:

On Wed, Sep 11, 2024 at 11:26:50PM +0000, PG Doc comments form wrote:
Yes, very good points. I have developed the attached patch which I
think achieves the goals you mentioned. I plan to apply the patch for
master/PG 18.

I also removed the unnecessary mention of PG 9.1.

Seems the reply email address is g***@gmail.com, which seems like some
kind of mistake.

Sorry, patch attached. Invalid email address removed.

Patch applied to master.

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

When a patient asks the doctor, "Am I going to die?", he means
"Am I going to die soon?"