Skip to content

Commit a27512e

Browse files
author
Thomas G. Lockhart
committed
Complete merge of all old man page information.
ecpg reference page still needs formatting.
1 parent 2aa64f7 commit a27512e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+2286
-766
lines changed

‎doc/src/sgml/ref/abort.sgml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
<!--
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/abort.sgml,v 1.4 1999/07/22 15:09:05 thomas Exp $
3+
Postgres documentation
4+
-->
5+
16
<refentry id="SQL-ABORT">
27
<refmeta>
3-
<refentrytitle>
8+
<refentrytitle id="sql-abort-title">
49
ABORT
510
</refentrytitle>
611
<refmiscinfo>SQL - Language Statements</refmiscinfo>
@@ -15,10 +20,10 @@
1520
</refnamediv>
1621
<refsynopsisdiv>
1722
<refsynopsisdivinfo>
18-
<date>1998-09-27</date>
23+
<date>1999-07-20</date>
1924
</refsynopsisdivinfo>
2025
<synopsis>
21-
ABORT [ TRANSACTION | WORK ]
26+
ABORT [ WORK | TRANSACTION ]
2227
</synopsis>
2328

2429
<refsect2 id="R2-SQL-ABORT-1">

‎doc/src/sgml/ref/allfiles.sgml

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<!-- allfiles.sgml
2-
-
3-
- Complete list of usable sgml source files in this directory.
4-
-
5-
- -->
1+
<!--
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/allfiles.sgml,v 1.10 1999/07/22 15:09:06 thomas Exp $
3+
Postgres documentation
4+
Complete list of usable sgml source files in this directory.
5+
-->
66

77
<!entity intro-ref system "intro-ref.sgml">
88
<!entity commands system "commands.sgml">
@@ -38,22 +38,6 @@
3838
<!entity trim system "trim.sgml">
3939
<!entity upper system "upper.sgml">
4040

41-
<!-- these are folded into create_table.sgml
42-
<!entity check system "check.sgml">
43-
<!entity constraints system "constraint.sgml">
44-
<!entity default system "default.sgml">
45-
<!entity notNull system "not_null.sgml">
46-
<!entity primaryKey system "primary_key.sgml">
47-
<!entity unique system "unique.sgml">
48-
-->
49-
50-
<!-- these are folded into select.sgml
51-
<!entity groupBy system "group_by.sgml">
52-
<!entity having system "having.sgml">
53-
<!entity orderBy system "order_by.sgml">
54-
<!entity union system "union.sgml">
55-
-->
56-
5741
<!-- these are in the "commands" reference chapter -->
5842
<!entity abort system "abort.sgml">
5943
<!entity alterTable system "alter_table.sgml">
@@ -92,6 +76,7 @@
9276
<!entity dropType system "drop_type.sgml">
9377
<!entity dropUser system "drop_user.sgml">
9478
<!entity dropView system "drop_view.sgml">
79+
<!entity end system "end.sgml">
9580
<!entity explain system "explain.sgml">
9681
<!entity fetch system "fetch.sgml">
9782
<!entity grant system "grant.sgml">
@@ -117,12 +102,15 @@
117102
<!entity createuser system "createuser.sgml">
118103
<!entity destroydb system "destroydb.sgml">
119104
<!entity destroyuser system "destroyuser.sgml">
105+
<!entity ecpgRef system "ecpg-ref.sgml">
120106
<!entity initdb system "initdb.sgml">
121107
<!entity initlocation system "initlocation.sgml">
108+
<!entity ipcclean system "ipcclean.sgml">
122109
<!entity pgAccess system "pgaccess-ref.sgml">
123110
<!entity pgAdmin system "pgadmin-ref.sgml">
124111
<!entity pgDump system "pg_dump.sgml">
125112
<!entity pgDumpall system "pg_dumpall.sgml">
113+
<!entity pgPasswd system "pg_passwd.sgml">
126114
<!entity pgUpgrade system "pg_upgrade.sgml">
127115
<!entity postgres system "postgres-ref.sgml">
128116
<!entity postmaster system "postmaster.sgml">

‎doc/src/sgml/ref/alter_table.sgml

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
<!--
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_table.sgml,v 1.8 1999/07/22 15:09:06 thomas Exp $
3+
Postgres documentation
4+
-->
5+
16
<refentry id="SQL-ALTERTABLE">
27
<refmeta>
3-
<refentrytitle>
8+
<refentrytitle id="sql-altertable-title">
49
ALTER TABLE
510
</refentrytitle>
611
<refmiscinfo>SQL - Language Statements</refmiscinfo>
@@ -15,7 +20,7 @@
1520
</refnamediv>
1621
<refsynopsisdiv>
1722
<refsynopsisdivinfo>
18-
<date>1998-04-15</date>
23+
<date>1999-07-20</date>
1924
</refsynopsisdivinfo>
2025
<synopsis>
2126
ALTER TABLE <replaceable class="PARAMETER">table</replaceable>
@@ -166,9 +171,37 @@ ERROR
166171
</para>
167172

168173
<para>
169-
<quote>[*]</quote> following a name of a table indicates that statement
174+
<quote>*</quote> following a name of a table indicates that the statement
170175
should be run over that table and all tables below it in the
171-
inheritance hierarchy.
176+
inheritance hierarchy;
177+
by default, the attribute will not be added to or renamed in any of the subclasses.
178+
179+
This should always be done when adding or modifying an attribute in a
180+
superclass. If it is not, queries on the inheritance hierarchy
181+
such as
182+
183+
<programlisting>
184+
SELECT <replaceable>NewColumn</replaceable> FROM <replaceable>SuperClass</replaceable>*
185+
</programlisting>
186+
187+
will not work because the subclasses will be missing an attribute
188+
found in the superclass.
189+
</para>
190+
191+
<para>
192+
For efficiency reasons, default values for added attributes are
193+
not placed in existing instances of a class.
194+
That is, existing instances will have NULL values in the new
195+
attributes. If non-NULL values are desired, a subsequent
196+
<command>UPDATE</command> query
197+
(<xref linkend="sql-update-title" endterm="sql-update-title">)
198+
should be run.
199+
</para>
200+
201+
<para>
202+
You must own the class in order to change its schema.
203+
Renaming any part of the schema of a system
204+
catalog is not permitted.
172205
The <citetitle>PostgreSQL User's Guide</citetitle> has further
173206
information on inheritance.
174207
</para>

‎doc/src/sgml/ref/alter_user.sgml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
<!--
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/alter_user.sgml,v 1.8 1999/07/22 15:09:06 thomas Exp $
3+
Postgres documentation
4+
-->
5+
16
<refentry id="SQL-ALTERUSER">
27
<refmeta>
3-
<refentrytitle>
8+
<refentrytitle id="sql-alteruser-title">
49
ALTER USER
510
</refentrytitle>
611
<refmiscinfo>SQL - Language Statements</refmiscinfo>
@@ -15,7 +20,7 @@
1520
</refnamediv>
1621
<refsynopsisdiv>
1722
<refsynopsisdivinfo>
18-
<date>1998-09-08</date>
23+
<date>1999-07-20</date>
1924
</refsynopsisdivinfo>
2025
<synopsis>
2126
ALTER USER <replaceable class="PARAMETER">username</replaceable> [ WITH PASSWORD <replaceable class="PARAMETER">password</replaceable> ]
@@ -126,7 +131,7 @@ ERROR: alterUser: user "username" does not exist
126131
<command>ALTER USER</command> is used to change the attributes of a user's
127132
<productname>Postgres</productname> account.
128133
Please note that it is not possible
129-
to alter a user's "usesysid" via the alter user
134+
to alter a user's "<literal>usesysid</literal>" via the alter user
130135
statement. Also, it is only possible for the
131136
<productname>Postgres</productname>
132137
user or any user with read and modify permissions on
@@ -135,7 +140,7 @@ ERROR: alterUser: user "username" does not exist
135140

136141
<para>
137142
If any of the clauses of the alter user statement are
138-
omitted, the corresponding value in the "pg_shadow" table
143+
omitted, the corresponding value in the <literal>pg_shadow</literal> table
139144
is left unchanged.
140145
</para>
141146

@@ -205,8 +210,6 @@ ALTER USER miriam IN GROUP sales, payroll;
205210
<title>
206211
Compatibility
207212
</title>
208-
<para>
209-
</para>
210213

211214
<refsect2 id="R2-SQL-ALTERUSER-4">
212215
<refsect2info>

‎doc/src/sgml/ref/begin.sgml

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
<refentry id="SQL-BEGINWORK">
1+
<!--
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/begin.sgml,v 1.9 1999/07/22 15:09:06 thomas Exp $
3+
Postgres documentation
4+
-->
5+
6+
<refentry id="SQL-BEGIN">
27
<refmeta>
3-
<refentrytitle id="SQL-BEGINWORK-TITLE">
8+
<refentrytitle id="SQL-BEGIN-TITLE">
49
BEGIN
510
</refentrytitle>
611
<refmiscinfo>SQL - Language Statements</refmiscinfo>
@@ -16,25 +21,36 @@
1621
</refnamediv>
1722
<refsynopsisdiv>
1823
<refsynopsisdivinfo>
19-
<date>1999-06-11</date>
24+
<date>1999-07-20</date>
2025
</refsynopsisdivinfo>
2126
<synopsis>
2227
BEGIN [ WORK | TRANSACTION ]
2328
</synopsis>
2429

25-
<refsect2 id="R2-SQL-BEGINWORK-1">
30+
<refsect2 id="R2-SQL-BEGIN-1">
2631
<refsect2info>
2732
<date>1999-06-11</date>
2833
</refsect2info>
2934
<title>
3035
Inputs
3136
</title>
3237
<para>
33-
None.
38+
39+
<variablelist>
40+
<varlistentry>
41+
<term>WORK</term>
42+
<term>TRANSACTION</term>
43+
<listitem>
44+
<para>
45+
Optional keywords. They have no effect.
46+
</para>
47+
</listitem>
48+
</varlistentry>
49+
</variablelist>
3450
</para>
3551
</refsect2>
3652

37-
<refsect2 id="R2-SQL-BEGINWORK-2">
53+
<refsect2 id="R2-SQL-BEGIN-2">
3854
<refsect2info>
3955
<date>1999-06-11</date>
4056
</refsect2info>
@@ -70,7 +86,7 @@ NOTICE: BeginTransactionBlock and not in default state
7086
</refsect2>
7187
</refsynopsisdiv>
7288

73-
<refsect1 id="R1-SQL-BEGINWORK-1">
89+
<refsect1 id="R1-SQL-BEGIN-1">
7490
<refsect1info>
7591
<date>1999-06-11</date>
7692
</refsect1info>
@@ -88,7 +104,9 @@ NOTICE: BeginTransactionBlock and not in default state
88104
(if execution was successful, otherwise a rollback is done).
89105
<command>BEGIN</command> initiates a user transaction in chained mode,
90106
i.e. all user statements after <command>BEGIN</command> command will
91-
be executed in a single transaction until an explicit COMMIT, ROLLBACK
107+
be executed in a single transaction until an explicit
108+
<xref linkend="sql-commit-title" endterm="sql-commit-title">,
109+
<xref linkend="sql-rollback-title" endterm="sql-rollback-title">,
92110
or execution abort. Statements in chained mode are executed much faster,
93111
because transaction start/commit requires significant CPU and disk
94112
activity. Execution of multiple statements inside a transaction
@@ -102,7 +120,7 @@ NOTICE: BeginTransactionBlock and not in default state
102120
is READ COMMITTED, where queries inside the transaction see only changes
103121
committed before query execution. So, you have to use
104122
<command>SET TRANSACTION ISOLATION LEVEL SERIALIZABLE</command>
105-
just after BEGIN if you need more rigorous transaction isolation.
123+
just after <command>BEGIN</command> if you need more rigorous transaction isolation.
106124
In SERIALIZABLE mode queries will see only changes committed before
107125
the entire
108126
transaction began (actually, before execution of the first DML statement
@@ -116,7 +134,7 @@ NOTICE: BeginTransactionBlock and not in default state
116134
(atomic, consistent, isolatable, and durable) property.
117135
</para>
118136

119-
<refsect2 id="R2-SQL-BEGINWORK-3">
137+
<refsect2 id="R2-SQL-BEGIN-3">
120138
<refsect2info>
121139
<date>1999-06-11</date>
122140
</refsect2info>
@@ -129,7 +147,8 @@ NOTICE: BeginTransactionBlock and not in default state
129147
</para>
130148

131149
<para>
132-
Refer to the <command>LOCK</command> statement for further information
150+
Refer to <xref linkend="sql-lock-title" endterm="sql-lock-title">
151+
for further information
133152
about locking tables inside a transaction.
134153
</para>
135154

@@ -142,7 +161,7 @@ NOTICE: BeginTransactionBlock and not in default state
142161
</refsect2>
143162
</refsect1>
144163

145-
<refsect1 id="R1-SQL-BEGINWORK-2">
164+
<refsect1 id="R1-SQL-BEGIN-2">
146165
<title>
147166
Usage
148167
</title>
@@ -156,25 +175,26 @@ BEGIN WORK;
156175
</para>
157176
</refsect1>
158177

159-
<refsect1 id="R1-SQL-BEGINWORK-3">
178+
<refsect1 id="R1-SQL-BEGIN-3">
160179
<title>
161180
Compatibility
162181
</title>
163-
<para>
164-
<command>BEGIN</command>
165-
is a <productname>Postgres</productname> language extension.
166-
</para>
167-
<refsect2 id="R2-SQL-BEGINWORK-4">
182+
183+
<refsect2 id="R2-SQL-BEGIN-4">
168184
<refsect2info>
169185
<date>1999-06-11</date>
170186
</refsect2info>
171187
<title>
172188
SQL92
173189
</title>
174-
<para>
175-
There is no explicit BEGIN WORK command in <acronym>SQL92</acronym>;
190+
191+
<para>
192+
<command>BEGIN</command>
193+
is a <productname>Postgres</productname> language extension.
194+
There is no explicit <command>BEGIN</command>
195+
command in <acronym>SQL92</acronym>;
176196
transaction initiation is always implicit and it terminates either
177-
with a COMMIT or with a ROLLBACK statement.
197+
with a <command>COMMIT</command> or <command>ROLLBACK</command> statement.
178198

179199
<note>
180200
<para>

‎doc/src/sgml/ref/close.sgml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
<!--
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.7 1999/07/22 15:09:06 thomas Exp $
3+
Postgres documentation
4+
-->
5+
16
<refentry id="SQL-CLOSE">
27
<refmeta>
3-
<refentrytitle>
8+
<refentrytitle id="SQL-CLOSE-TITLE">
49
CLOSE
510
</refentrytitle>
611
<refmiscinfo>SQL - Language Statements</refmiscinfo>
@@ -15,7 +20,7 @@
1520
</refnamediv>
1621
<refsynopsisdiv>
1722
<refsynopsisdivinfo>
18-
<date>1998-09-08</date>
23+
<date>1999-07-20</date>
1924
</refsynopsisdivinfo>
2025
<synopsis>
2126
CLOSE <replaceable class="PARAMETER">cursor</replaceable>
@@ -131,8 +136,6 @@ CLOSE liahona;
131136
<title>
132137
Compatibility
133138
</title>
134-
<para>
135-
</para>
136139

137140
<refsect2 id="R2-SQL-CLOSE-4">
138141
<refsect2info>

0 commit comments

Comments
 (0)