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

Commit d1a3b75

Browse files
author
Thomas G. Lockhart
committed
Add new SQL reference page and the first utility/app reference page
 converted from the man page.
1 parent 44e01bf commit d1a3b75

File tree

5 files changed

+1019
-3
lines changed

5 files changed

+1019
-3
lines changed

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

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<REFENTRY ID="SQL-ABORT">
2+
<REFMETA>
3+
<REFENTRYTITLE>
4+
ABORT
5+
</REFENTRYTITLE>
6+
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
7+
</REFMETA>
8+
<REFNAMEDIV>
9+
<REFNAME>
10+
ABORT
11+
</REFNAME>
12+
<REFPURPOSE>
13+
Aborts the current transaction
14+
</REFPURPOSE>
15+
<REFSYNOPSISDIV>
16+
<REFSYNOPSISDIVINFO>
17+
<DATE>1998-09-27</DATE>
18+
</REFSYNOPSISDIVINFO>
19+
<SYNOPSIS>
20+
ABORT
21+
</SYNOPSIS>
22+
23+
<REFSECT2 ID="R2-SQL-ABORT-1">
24+
<REFSECT2INFO>
25+
<DATE>1998-09-27</DATE>
26+
</REFSECT2INFO>
27+
<TITLE>
28+
Inputs
29+
</TITLE>
30+
<PARA>
31+
None.
32+
33+
</REFSECT2>
34+
35+
<REFSECT2 ID="R2-SQL-ABORT-2">
36+
<REFSECT2INFO>
37+
<DATE>1998-09-27</DATE>
38+
</REFSECT2INFO>
39+
<TITLE>
40+
Outputs
41+
</TITLE>
42+
<PARA>
43+
44+
<VARIABLELIST>
45+
<VARLISTENTRY>
46+
<TERM>
47+
ABORT
48+
</TERM>
49+
<LISTITEM>
50+
<PARA>
51+
Message returned if successful.
52+
53+
<VARLISTENTRY>
54+
<TERM>
55+
NOTICE: UserAbortTransactionBlock and not in in-progress state
56+
ABORT
57+
</TERM>
58+
<LISTITEM>
59+
<PARA>
60+
If there is not any transaction currently in progress.
61+
62+
</VARLISTENTRY>
63+
</VARIABLELIST>
64+
65+
</REFSECT2>
66+
</REFSYNOPSISDIV>
67+
68+
<REFSECT1 ID="R1-SQL-ABORT-1">
69+
<REFSECT1INFO>
70+
<DATE>1998-09-27</DATE>
71+
</REFSECT1INFO>
72+
<TITLE>
73+
Description
74+
</TITLE>
75+
<PARA>
76+
<command>ABORT</command> rolls back the current transaction and causes
77+
all the updates made by the transaction to be discarded.
78+
This command is identical
79+
in behavior to the <acronym>SQL92</acronym> command <command>ROLLBACK</command>,
80+
and is present only for historical reasons.
81+
82+
<REFSECT2 ID="R2-SQL-ABORT-3">
83+
<REFSECT2INFO>
84+
<DATE>1998-09-27</DATE>
85+
</REFSECT2INFO>
86+
<TITLE>
87+
Notes
88+
</TITLE>
89+
<para>
90+
Use the <command>COMMIT</command> statement to successfully
91+
terminate a transaction.
92+
93+
</REFSECT1>
94+
95+
<REFSECT1 ID="R1-SQL-ABORT-2">
96+
<TITLE>
97+
Usage
98+
</TITLE>
99+
<PARA>
100+
<ProgramListing>
101+
--To abort all changes
102+
--
103+
ABORT WORK;
104+
</ProgramListing>
105+
106+
</REFSECT1>
107+
108+
<REFSECT1 ID="R1-SQL-ABORT-3">
109+
<TITLE>
110+
Compatibility
111+
</TITLE>
112+
<PARA>
113+
114+
<REFSECT2 ID="R2-SQL-ABORT-4">
115+
<REFSECT2INFO>
116+
<DATE>1998-09-27</DATE>
117+
</REFSECT2INFO>
118+
<TITLE>
119+
SQL92
120+
</TITLE>
121+
<para>
122+
This command is a <productname>Postgres</productname> extension present
123+
for historical reasons. <command>ROLLBACK</command> is the <acronym>SQL92</acronym>
124+
equivalent command.
125+
</PARA>
126+
127+
</REFENTRY>

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

+4
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
-->
5656

5757
<!-- these are in the "commands" reference chapter -->
58+
<!entity abort system "abort.sgml">
5859
<!entity alterTable system "alter_table.sgml">
5960
<!entity alterUser system "alter_user.sgml">
6061
<!entity begin system "begin.sgml">
@@ -107,3 +108,6 @@
107108
<!entity show system "show.sgml">
108109
<!entity update system "update.sgml">
109110
<!entity vacuum system "vacuum.sgml">
111+
112+
<!-- these are in the "utilities" reference chapter -->
113+
<!entity psqlRef system "psql-ref.sgml">

‎doc/src/sgml/ref/commands.sgml

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
<Chapter>
2-
<Title>Commands</Title>
1+
<chapter id="sql-commands">
2+
<Title>SQL Commands</Title>
33

44
<Para>
5+
This is reference information for the <acronym>SQL</acronym>
6+
commands supported by <productname>Postgres</productname>.
57
</Para>
68

9+
&abort;
710
&alterTable;
811
&alterUser;
912
&begin;
@@ -62,6 +65,8 @@
6265
<title>SQL Functions</title>
6366

6467
<para>
68+
This chapter provides reference information for the <acronym>SQL</acronym>
69+
functions supported by <productname>Postgres</productname>.
6570
</para>
6671

6772
&currentDate;
@@ -71,6 +76,17 @@
7176

7277
</chapter>
7378

79+
<chapter Id="utilities">
80+
<title>Utility Applications</title>
81+
82+
<para>
83+
This is reference information for the
84+
<productname>Postgres</productname> support utilities.
85+
</para>
86+
87+
&psqlRef;
88+
89+
</chapter>
7490

7591
<!-- Keep this comment at the end of the file
7692
Local variables:

0 commit comments

Comments
 (0)