Re: Add A Glossary

From: Justin Pryzby <pryzby(at)telsasoft(dot)com>
To: Jürgen Purtz <juergen(at)purtz(dot)de>
Cc: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, Corey Huinker <corey(dot)huinker(at)gmail(dot)com>, Roger Harkavy <rogerharkavy(at)gmail(dot)com>, pgsql-hackers(at)postgresql(dot)org, Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>, Michael Paquier <michael(at)paquier(dot)xyz>
Subject: Re: Add A Glossary
Date: 2020-03-20 23:03:18
Message-ID: 20200320230318.GB13662@telsasoft.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On Fri, Mar 20, 2020 at 11:32:25PM +0100, Jürgen Purtz wrote:
> > > + <glossentry id="glossary-file-segment">
> > > + <glossterm>File Segment</glossterm>
> > > + <glossdef>
> > > + <para>
> > > + If a heap or index file grows in size over 1 GB, it will be split
> > 1GB is the default "segment size", which you should define.
>
> ???

"A <<Table>> or other >>Relation<<" is larger than a >Cluster's< segment size
is stored in multiple physical files. This avoids file size limitations which
vary across operating systems."

https://www.postgresql.org/docs/devel/runtime-config-preset.html

ts=# SELECT name, setting, unit, category, short_desc FROM pg_settings WHERE name~'block_size|segment_size';
name | setting | unit | category | short_desc
------------------+----------+------+----------------+----------------------------------------------
block_size | 8192 | | Preset Options | Shows the size of a disk block.
segment_size | 131072 | 8kB | Preset Options | Shows the number of pages per disk file.
wal_block_size | 8192 | | Preset Options | Shows the block size in the write ahead log.
wal_segment_size | 16777216 | B | Preset Options | Shows the size of write ahead log segments.

> > > + <glossentry id="glossary-heap">
> > > + <glossterm>Heap</glossterm>
> > > + <glossdef>
> > > + <para>
> > > + Contains the original values of <glossterm>Row</glossterm> attributes
> > I'm not sure what "original" means here ?
>
> Yes, this may be misleading. I want to express, that values are stored in
> the heap (the 'original') and possibly repeated as a key in an index.

Maybe "this is the content of rows/attributes in >>Tables<< or other >>Relations<<".
or "this is the data store for ..."

> > > + <glossentry id="glossary-host">
> > > + <glossterm>Host</glossterm>
> > > + <glossdef>
> > > + <para>
> > > + See <glossterm>Server</glossterm>.
> > Or client. Or proxy at some layer or other intermediate thing. Maybe just
> > remove this.
>
> Sometimes the term "host" is used in a different meaning. Therefor we shall
> have this glossary entry for clarification that it shall be used only in the
> sense of a "server".

I think that suggests just removing "host" and consistently saying "server".

--
Justin

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2020-03-21 00:19:56 Re: Possible typos in the #12.1.1 examples
Previous Message Jürgen Purtz 2020-03-20 22:32:25 Re: Add A Glossary

Browse pgsql-hackers by date

  From Date Subject
Next Message Tomas Vondra 2020-03-21 00:56:40 Re: [PATCH] Incremental sort (was: PoC: Partial sort)
Previous Message Jürgen Purtz 2020-03-20 22:32:25 Re: Add A Glossary