Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 86cc06d

Browse files
committed
table: docs: fix typos and grammar.
Author: Justin Pryzby Discussion: https://postgr.es/m/20190404055138.GA24864@telsasoft.com
1 parent 3e6b0c4 commit 86cc06d

File tree

4 files changed

+33
-32
lines changed

4 files changed

+33
-32
lines changed

doc/src/sgml/catalogs.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@
587587
The catalog <structname>pg_am</structname> stores information about
588588
relation access methods. There is one row for each access method supported
589589
by the system.
590-
Currently, only table and indexes have access methods. The requirements for table
590+
Currently, only tables and indexes have access methods. The requirements for table
591591
and index access methods are discussed in detail in <xref linkend="tableam"/> and
592592
<xref linkend="indexam"/> respectively.
593593
</para>

doc/src/sgml/ref/select_into.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,11 @@ SELECT [ ALL | DISTINCT [ ON ( <replaceable class="parameter">expression</replac
106106
</para>
107107

108108
<para>
109-
In contrast to <command>CREATE TABLE AS</command> <command>SELECT
109+
In contrast to <command>CREATE TABLE AS</command>, <command>SELECT
110110
INTO</command> does not allow to specify properties like a table's access
111111
method with <xref linkend="sql-createtable-method" /> or the table's
112112
tablespace with <xref linkend="sql-createtable-tablespace" />. Use <xref
113-
linkend="sql-createtableas"/> if necessary. Therefore the default table
113+
linkend="sql-createtableas"/> if necessary. Therefore, the default table
114114
access method is chosen for the new table. See <xref
115115
linkend="guc-default-table-access-method"/> for more information.
116116
</para>

doc/src/sgml/storage.sgml

+9-9
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,11 @@ there.
189189
</para>
190190

191191
<para>
192-
Note that the following sections describe the way the builtin
192+
Note that the following sections describe the behavior of the builtin
193193
<literal>heap</literal> <link linkend="tableam">table access method</link>,
194-
and the builtin <link linkend="indexam">index access methods</link> work. Due
195-
to the extensible nature of <productname>PostgreSQL</productname> other types
196-
of access method might work similar or not.
194+
and the builtin <link linkend="indexam">index access methods</link>. Due
195+
to the extensible nature of <productname>PostgreSQL</productname>, other
196+
access methods might work differently.
197197
</para>
198198

199199
<para>
@@ -703,11 +703,11 @@ erased (they will be recreated automatically as needed).
703703
This section provides an overview of the page format used within
704704
<productname>PostgreSQL</productname> tables and indexes.<footnote>
705705
<para>
706-
Actually, neither table nor index access methods need not use this page
707-
format. All the existing index methods do use this basic format, but the
708-
data kept on index metapages usually doesn't follow the item layout
709-
rules. The <literal>heap</literal> table access method also always uses
710-
this format.
706+
Actually, use of this page format is not required for either table or
707+
index access methods. The <literal>heap</literal> table access method
708+
always uses this format. All the existing index methods also use the
709+
basic format, but the data kept on index metapages usually doesn't follow
710+
the item layout rules.
711711
</para>
712712
</footnote>
713713
Sequences and <acronym>TOAST</acronym> tables are formatted just like a regular table.

doc/src/sgml/tableam.sgml

+21-20
Original file line numberDiff line numberDiff line change
@@ -48,33 +48,33 @@
4848
callbacks and their behavior is defined in the
4949
<structname>TableAmRoutine</structname> structure (with comments inside the
5050
struct defining the requirements for callbacks). Most callbacks have
51-
wrapper functions, which are documented for the point of view of a user,
52-
rather than an implementor, of the table access method. For details,
51+
wrapper functions, which are documented from the point of view of a user
52+
(rather than an implementor) of the table access method. For details,
5353
please refer to the <ulink url="https://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/include/access/tableam.h;hb=HEAD">
5454
<filename>src/include/access/tableam.h</filename></ulink> file.
5555
</para>
5656

5757
<para>
58-
To implement a access method, an implementor will typically need to
59-
implement a AM specific type of tuple table slot (see
58+
To implement an access method, an implementor will typically need to
59+
implement an AM-specific type of tuple table slot (see
6060
<ulink url="https://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/include/executor/tuptable.h;hb=HEAD">
61-
<filename>src/include/executor/tuptable.h</filename></ulink>) which allows
61+
<filename>src/include/executor/tuptable.h</filename></ulink>), which allows
6262
code outside the access method to hold references to tuples of the AM, and
6363
to access the columns of the tuple.
6464
</para>
6565

6666
<para>
67-
Currently the the way an AM actually stores data is fairly
68-
unconstrained. It is e.g. possible to use postgres' shared buffer cache,
69-
but not required. In case shared buffers are used, it likely makes to
70-
postgres' standard page layout described in <xref
71-
linkend="storage-page-layout"/>.
67+
Currently, the way an AM actually stores data is fairly unconstrained. For
68+
example, it's possible, but not required, to use postgres' shared buffer
69+
cache. In case it is used, it likely makes sense to use
70+
<productname>PostgreSQL</productname>'s standard page layout as described in
71+
<xref linkend="storage-page-layout"/>.
7272
</para>
7373

7474
<para>
7575
One fairly large constraint of the table access method API is that,
7676
currently, if the AM wants to support modifications and/or indexes, it is
77-
necessary that each tuple has a tuple identifier (<acronym>TID</acronym>)
77+
necessary for each tuple to have a tuple identifier (<acronym>TID</acronym>)
7878
consisting of a block number and an item number (see also <xref
7979
linkend="storage-page-layout"/>). It is not strictly necessary that the
8080
sub-parts of <acronym>TIDs</acronym> have the same meaning they e.g. have
@@ -83,13 +83,14 @@
8383
</para>
8484

8585
<para>
86-
For crash safety an AM can use postgres' <link
87-
linkend="wal"><acronym>WAL</acronym></link>, or a custom approach can be
88-
implemented. If <acronym>WAL</acronym> is chosen, either <link
89-
linkend="generic-wal">Generic WAL Records</link> can be used &mdash; which
90-
implies higher WAL volume but is easy, or a new type of
91-
<acronym>WAL</acronym> records can be implemented &mdash; but that
92-
currently requires modifications of core code (namely modifying
86+
For crash safety, an AM can use postgres' <link
87+
linkend="wal"><acronym>WAL</acronym></link>, or a custom implementation.
88+
If <acronym>WAL</acronym> is chosen, either <link
89+
linkend="generic-wal">Generic WAL Records</link> can be used,
90+
or a new type of <acronym>WAL</acronym> records can be implemented.
91+
Generic WAL Records are easy, but imply higher WAL volume.
92+
Implementation of a new type of WAL record
93+
currently requires modifications to core code (specifically,
9394
<filename>src/include/access/rmgrlist.h</filename>).
9495
</para>
9596

@@ -103,8 +104,8 @@
103104
<para>
104105
Any developer of a new <literal>table access method</literal> can refer to
105106
the existing <literal>heap</literal> implementation present in
106-
<filename>src/backend/heap/heapam_handler.c</filename> for more details of
107-
how it is implemented.
107+
<filename>src/backend/heap/heapam_handler.c</filename> for details of
108+
its implementation.
108109
</para>
109110

110111
</chapter>

0 commit comments

Comments
 (0)