Re: Add A Glossary

Jürgen Purtz <juergen@purtz.de>

From: Jürgen Purtz <juergen@purtz.de>
To: Alvaro Herrera <alvherre@2ndquadrant.com>
Cc: Erik Rijkers <er@xs4all.nl>, Laurenz Albe <laurenz.albe@cybertec.at>, Fabien COELHO <coelho@cri.ensmp.fr>, Peter Eisentraut <peter.eisentraut@2ndquadrant.com>, Corey Huinker <corey.huinker@gmail.com>, Justin Pryzby <pryzby@telsasoft.com>, Roger Harkavy <rogerharkavy@gmail.com>, pgsql-hackers@postgresql.org, Michael Paquier <michael@paquier.xyz>, Pg Docs <pgsql-docs@lists.postgresql.org>
Date: 2020-06-17T12:52:19Z
Lists: pgsql-hackers, pgsql-docs

Attachments

On 17.06.20 02:09, Alvaro Herrera wrote:
> On 2020-Jun-09, Jürgen Purtz wrote:
>
>> Can you agree to the following definitions? If no, we can alternatively
>> formulate for each of them: "Under discussion - currently not defined". My
>> proposals are inspired by chapter 2.2 Concepts: "Tables are grouped into
>> databases, and a collection of databases managed by a single PostgreSQL
>> server instance constitutes a database cluster."
> After sleeping on it a few more times, I don't oppose the idea of making
> "instance" be the running state and "database cluster" the on-disk stuff
> that supports the instance.  Here's a patch that does things pretty much
> along the lines you suggested.
>
> I made small adjustments to "SQL objects":
>
> * SQL objects in schemas were said to have their names unique in the
> schema, but we failed to say anything about names of objects not in
> schemas and global objects.  Added that.
>
> * Had example object types for global objects and objects not in
> schemas, but no examples for objects in schemas.  Added that.
>
>
> Some programs whose output we could tweak per this:
> pg_ctl
>> pg_ctl is a utility to initialize, start, stop, or control a PostgreSQL server.
>>   -D, --pgdata=DATADIR   location of the database storage area
> to:
>> pg_ctl is a utility to initialize or control a PostgreSQL database cluster.
>>   -D, --pgdata=DATADIR   location of the database directory
> pg_basebackup:
>> pg_basebackup takes a base backup of a running PostgreSQL server.
> to:
>> pg_basebackup takes a base backup of a PostgreSQL instance.

+1, with two formal changes:

-  Rearrangement of term "Data page" to meet alphabetical order.

-  Add </glossdef> in one case to meet xml-well-formedness.


One last question: The definition of "Data directory" reads "... A 
cluster's storage space comprises the data directory plus ..." and 
'cluster' links to '"glossary-instance". Shouldn't it link to 
"glossary-db-cluster"?

--

Jürgen Purtz


Commits

  1. Glossary: Add term "base backup"

  2. Minor glossary tweaks

  3. Adjust some glossary terms

  4. Fix more typos and grammar problems in the glossary

  5. Review of the glossary

  6. Add a glossary to the documentation