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

Commit f8b6b5f

Browse files
author
Thomas G. Lockhart
committed
Cleanup markup and minor editing to prepare for first release.
1 parent dcff823 commit f8b6b5f

17 files changed

+684
-418
lines changed

doc/src/sgml/ref/create_table.sgml

+96
Original file line numberDiff line numberDiff line change
@@ -1663,6 +1663,102 @@ affect a column or a table.
16631663
</refsect1>
16641664
</refentry>
16651665

1666+
1667+
<REFENTRY ID="SQL-CREATETABLEAS">
1668+
<REFMETA>
1669+
<REFENTRYTITLE>
1670+
CREATE TABLE
1671+
</REFENTRYTITLE>
1672+
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
1673+
</REFMETA>
1674+
<REFNAMEDIV>
1675+
<REFNAME>
1676+
CREATE TABLE
1677+
</REFNAME>
1678+
<REFPURPOSE>
1679+
Creates a new table
1680+
</REFPURPOSE>
1681+
1682+
<REFSYNOPSISDIV>
1683+
<REFSYNOPSISDIVINFO>
1684+
<DATE>1998-09-22</DATE>
1685+
</REFSYNOPSISDIVINFO>
1686+
<SYNOPSIS>
1687+
CREATE TABLE <REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE> [ ( <REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE> [, ...] ) ] AS <REPLACEABLE CLASS="PARAMETER">select_clause</REPLACEABLE>
1688+
</SYNOPSIS>
1689+
1690+
<REFSECT2 ID="R2-SQL-CREATETABLEAS-1">
1691+
<REFSECT2INFO>
1692+
<DATE>1998-09-22</DATE>
1693+
</REFSECT2INFO>
1694+
<TITLE>
1695+
Inputs
1696+
</TITLE>
1697+
<PARA>
1698+
1699+
<VARIABLELIST>
1700+
<VARLISTENTRY>
1701+
<TERM>
1702+
<REPLACEABLE CLASS="PARAMETER">table</REPLACEABLE>
1703+
</TERM>
1704+
<LISTITEM>
1705+
<PARA>
1706+
The name of a new table to be created.
1707+
</PARA>
1708+
</LISTITEM>
1709+
</VARLISTENTRY>
1710+
1711+
<VARLISTENTRY>
1712+
<TERM>
1713+
<REPLACEABLE CLASS="PARAMETER">column</REPLACEABLE>
1714+
</TERM>
1715+
<LISTITEM>
1716+
<PARA>
1717+
The name of a column. Multiple column names can be specified using
1718+
a comma-delimited list of column names.
1719+
</PARA>
1720+
</LISTITEM>
1721+
</VARLISTENTRY>
1722+
1723+
<VARLISTENTRY>
1724+
<TERM>
1725+
<REPLACEABLE CLASS="PARAMETER">select_clause</REPLACEABLE>
1726+
</TERM>
1727+
<LISTITEM>
1728+
<PARA>
1729+
A valid query statement. Refer to SELECT for a description of the
1730+
allowed syntax.
1731+
</PARA>
1732+
</LISTITEM>
1733+
</VARLISTENTRY>
1734+
</VARIABLELIST>
1735+
1736+
<REFSECT2 ID="R2-SQL-CREATETABLEAS-2">
1737+
<REFSECT2INFO>
1738+
<DATE>1998-09-22</DATE>
1739+
</REFSECT2INFO>
1740+
<TITLE>
1741+
Outputs
1742+
</TITLE>
1743+
<PARA>
1744+
Refer to CREATE TABLE and SELECT for a summary of possible output
1745+
messages.
1746+
1747+
<REFSECT1 ID="R1-SQL-CREATETABLEAS-1">
1748+
<REFSECT1INFO>
1749+
<DATE>1998-09-22</DATE>
1750+
</REFSECT1INFO>
1751+
<TITLE>
1752+
Description
1753+
</TITLE>
1754+
<PARA>
1755+
CREATE TABLE AS enables a table to be created from the contents of
1756+
an existing table. It has functionality equivalent to SELECT TABLE INTO,
1757+
but with perhaps a more obvious syntax.
1758+
1759+
</refsect1>
1760+
</refentry>
1761+
16661762
<!-- Keep this comment at the end of the file
16671763
Local variables:
16681764
mode: sgml

doc/src/sgml/ref/explain.sgml

+17-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ EXPLAIN
1010
EXPLAIN
1111
</REFNAME>
1212
<REFPURPOSE>
13-
Shows statement execution details.
13+
Shows statement execution details
1414
</REFPURPOSE>
1515

1616
<REFSYNOPSISDIV>
@@ -64,11 +64,19 @@ Outputs
6464
<VARLISTENTRY>
6565
<TERM>
6666
NOTICE: QUERY PLAN:
67+
<replaceable>plan</replaceable>
6768
</TERM>
6869
<LISTITEM>
6970
<PARA>
7071
Explicit query plan from the <productname>Postgres</productname> backend.
7172

73+
<VARIABLELIST>
74+
<VARLISTENTRY>
75+
<TERM>
76+
<replaceable>status</replaceable>
77+
</TERM>
78+
<LISTITEM>
79+
<PARA>
7280
<VARLISTENTRY>
7381
<TERM>
7482
EXPLAIN
@@ -77,6 +85,7 @@ EXPLAIN
7785
<PARA>
7886
Flag sent after query plan is shown.
7987

88+
</VARIABLELIST>
8089
</VARIABLELIST>
8190

8291
</REFSECT2>
@@ -102,6 +111,13 @@ Description
102111
Notes
103112
</TITLE>
104113
<PARA>
114+
There is only sparse documentation on the optimizer's use of cost
115+
information in <productname>Postgres</productname>.
116+
General information on cost estimation for query optimization
117+
can be found in database textbooks.
118+
Refer to the <citetitle>Programmer's Guide</citetitle>
119+
in the chapters on indexes and the genetic query optimizer for
120+
more information.
105121

106122
</REFSECT2>
107123

doc/src/sgml/ref/fetch.sgml

+6-2
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,8 @@ NOTICE: PerformPortalFetch: portal "<REPLACEABLE CLASS="PARAMETER">cursor</REPL
146146
</TERM>
147147
<LISTITEM>
148148
<PARA>
149-
If <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE> is not previously declared.
149+
If <REPLACEABLE CLASS="PARAMETER">cursor</REPLACEABLE>
150+
is not previously declared.
150151
The cursor must be declared within a transaction block.
151152

152153
<VARLISTENTRY>
@@ -293,6 +294,9 @@ Usage
293294
Compatibility
294295
</TITLE>
295296
<PARA>
297+
The non-embedded use of cursors is a <productname>Postgres</productname>
298+
extension. The syntax and usage of cursors is being compared
299+
against the embedded form of cursors defined in <acronym>SQL92</acronym>.
296300
</PARA>
297301

298302
<REFSECT2 ID="R2-SQL-FETCH-4">
@@ -303,7 +307,7 @@ Compatibility
303307
SQL92
304308
</TITLE>
305309
<PARA>
306-
SQL92 allows absolute positioning of the cursor for
310+
<acronym>SQL92</acronym> allows absolute positioning of the cursor for
307311
FETCH, and allows placing the results into explicit variables.
308312

309313
<synopsis>

doc/src/sgml/ref/grant.sgml

+24-15
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Grants access privilege to a user, a group or all users
1515

1616
<REFSYNOPSISDIV>
1717
<REFSYNOPSISDIVINFO>
18-
<DATE>1998-04-15</DATE>
18+
<DATE>1998-09-23</DATE>
1919
</REFSYNOPSISDIVINFO>
2020
<SYNOPSIS>
2121
GRANT <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...]
@@ -25,7 +25,7 @@ GRANT <REPLACEABLE CLASS="PARAMETER">privilege</REPLACEABLE> [, ...]
2525

2626
<REFSECT2 ID="R2-SQL-GRANT-1">
2727
<REFSECT2INFO>
28-
<DATE>1998-09-01</DATE>
28+
<DATE>1998-09-23</DATE>
2929
</REFSECT2INFO>
3030
<TITLE>
3131
Inputs
@@ -147,13 +147,21 @@ representing all users.
147147

148148
<REFSECT2 ID="R2-SQL-GRANT-2">
149149
<REFSECT2INFO>
150-
<DATE>1998-09-01</DATE>
150+
<DATE>1998-09-23</DATE>
151151
</REFSECT2INFO>
152152
<TITLE>
153153
Outputs
154154
</TITLE>
155155
<PARA>
156156

157+
<VARIABLELIST>
158+
<VARLISTENTRY>
159+
<TERM>
160+
<replaceable>status</replaceable>
161+
</TERM>
162+
<LISTITEM>
163+
<PARA>
164+
157165
<VARIABLELIST>
158166
<VARLISTENTRY>
159167
<TERM>
@@ -175,13 +183,14 @@ if it is impossible
175183
to give privileges to the specified group or users.
176184

177185
</VARIABLELIST>
186+
</VARIABLELIST>
178187

179188
</REFSECT2>
180189
</REFSYNOPSISDIV>
181190

182191
<REFSECT1 ID="R1-SQL-GRANT-1">
183192
<REFSECT1INFO>
184-
<DATE>1998-09-01</DATE>
193+
<DATE>1998-09-23</DATE>
185194
</REFSECT1INFO>
186195
<TITLE>
187196
Description
@@ -202,7 +211,7 @@ There is no need to GRANT privileges to the creator of
202211

203212
<REFSECT2 ID="R2-SQL-GRANT-3">
204213
<REFSECT2INFO>
205-
<DATE>1998-09-01</DATE>
214+
<DATE>1998-09-23</DATE>
206215
</REFSECT2INFO>
207216
<TITLE>
208217
Notes
@@ -235,8 +244,8 @@ Use the <command>psql \z</command> command
235244
Currently, to create a GROUP you have to insert
236245
data manually into table pg_group as:
237246
<programlisting>
238-
INSERT INTO pg_group VALUES ('todos');
239-
CREATE USER miriam IN GROUP todos;
247+
INSERT INTO pg_group VALUES ('todos');
248+
CREATE USER miriam IN GROUP todos;
240249
</programlisting>
241250
Refer to REVOKE statements to revoke access privileges.
242251
</tip>
@@ -249,15 +258,15 @@ Usage
249258
</TITLE>
250259
<PARA>
251260
<ProgramListing>
252-
-- grant insert privilege to all users on table films:
253-
--
254-
GRANT INSERT ON films TO PUBLIC;
261+
-- grant insert privilege to all users on table films:
262+
--
263+
GRANT INSERT ON films TO PUBLIC;
255264
</programlisting>
256265

257266
<programlisting>
258-
-- grant all privileges to user manuel on view kinds:
259-
--
260-
GRANT ALL ON kinds TO manuel;
267+
-- grant all privileges to user manuel on view kinds:
268+
--
269+
GRANT ALL ON kinds TO manuel;
261270
</ProgramListing>
262271

263272
</REFSECT1>
@@ -271,13 +280,13 @@ Compatibility
271280

272281
<REFSECT2 ID="R2-SQL-GRANT-4">
273282
<REFSECT2INFO>
274-
<DATE>1998-09-01</DATE>
283+
<DATE>1998-09-23</DATE>
275284
</REFSECT2INFO>
276285
<TITLE>
277286
SQL92
278287
</TITLE>
279288
<PARA>
280-
The SQL92 syntax for GRANT allows setting privileges
289+
The <acronym>SQL92</acronym> syntax for GRANT allows setting privileges
281290
for individual columns
282291
within a table, and allows setting a privilege to grant
283292
the same privileges to others.

0 commit comments

Comments
 (0)