Thread: docs are incomplete or wrong...

docs are incomplete or wrong...

From
PG Doc comments form
Date:
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/17/tutorial-createdb.html
Description:

Folowing the online docs @
https://www.postgresql.org/docs/17/tutorial-createdb.html
it says: "To create a new database, in this example named mydb, you use the
following command:

$ createdb mydb"
When performing it error comes:
"createdb: error: connection to server on socket
"/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  role "root" does not
exist"
No matter what explanation there is for it, this is supposed to be official
documentation. It MUST be right.

Re: docs are incomplete or wrong...

From
Ian Lawrence Barwick
Date:
2024年12月18日(水) 18:58 PG Doc comments form <noreply@postgresql.org>:
>
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/17/tutorial-createdb.html
> Description:
>
> Folowing the online docs @
> https://www.postgresql.org/docs/17/tutorial-createdb.html
> it says: "To create a new database, in this example named mydb, you use the
> following command:
>
> $ createdb mydb"
> When performing it error comes:
> "createdb: error: connection to server on socket
> "/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  role "root" does not
> exist"
> No matter what explanation there is for it, this is supposed to be official
> documentation. It MUST be right.

If you read a bit further down that page, it tells you how to deal
with that kind of error:

> Another response could be this:
>   createdb: error: connection to server on socket "/tmp/.s.PGSQL.5432" failed: FATAL:  role "joe" does not exist

Specifically it says:

> You will need to become the operating system user under which PostgreSQL
> was installed (usually postgres) to create the first user account.

Regards

Ian Barwick



Re: docs are incomplete or wrong...

From
"David G. Johnston"
Date:
On Thursday, December 12, 2024, PG Doc comments form <noreply@postgresql.org> wrote:
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/17/tutorial-createdb.html
Description:

Folowing the online docs @
https://www.postgresql.org/docs/17/tutorial-createdb.html
it says: "To create a new database, in this example named mydb, you use the
following command:

$ createdb mydb"
When performing it error comes:
"createdb: error: connection to server on socket
"/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  role "root" does not
exist"
No matter what explanation there is for it, this is supposed to be official
documentation. It MUST be right.

The documentation is required to make some assumptions/requirements regarding the operating context of the examples.  Namely, you are running commands as the OS user postgres, and that user can peer authenticate (or trust…) into the default location for where you initdb’d and the cluster (discussed earlier in the documentation).  You are running the command as root and thus violating those requirements.

IOW, it is correct but has pre-requisites that you haven’t followed.  There is no good way to make such an example entirely self-contained and pre-requisite free.  But if you’d like to suggest an improvement we are open to making tweaks.

David J.