Re: Add A Glossary
Justin Pryzby <pryzby@telsasoft.com>
From: Justin Pryzby <pryzby@telsasoft.com>
To: Jürgen Purtz <juergen@purtz.de>
Cc: Alvaro Herrera <alvherre@2ndquadrant.com>, Corey Huinker <corey.huinker@gmail.com>, Roger Harkavy <rogerharkavy@gmail.com>, pgsql-hackers@postgresql.org, Fabien COELHO <coelho@cri.ensmp.fr>, Michael Paquier <michael@paquier.xyz>
Date: 2020-03-20T23:03:18Z
Lists: pgsql-hackers, pgsql-docs
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
Commits
-
Glossary: Add term "base backup"
- 606c3845988d 14.0 landed
-
Minor glossary tweaks
- a0b2d583db9f 14.0 landed
- ac25e7b039d5 13.0 landed
-
Adjust some glossary terms
- 91a890bd7fef 13.0 landed
- 816cbb59e300 14.0 landed
-
Fix more typos and grammar problems in the glossary
- eeba6c7e4366 13.0 landed
-
Review of the glossary
- 756abe2bc760 13.0 landed
-
Add a glossary to the documentation
- 347d2b07fcc2 13.0 landed