← Back to branch summary

~vcs-imports/mammoth-replicator/trunk

« back to all changes in this revision

Viewing changes to doc/src/sgml/ref/abort.sgml

  • Committer: alvherre
  • Date: 2005-12-16 21:24:52 UTC
  • Revision ID: svn-v4:db760fc0-0f08-0410-9d63-cc6633f64896:trunk:1
Initial import of the REL8_0_3 sources from the Pgsql CVS repository.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/ref/abort.sgml
 
1
<!--
 
2
$PostgreSQL: pgsql/doc/src/sgml/ref/abort.sgml,v 1.16 2003-11-29 19:51:38 pgsql Exp $
 
3
PostgreSQL documentation
 
4
-->
 
5
 
 
6
<refentry id="SQL-ABORT">
 
7
 <refmeta>
 
8
  <refentrytitle id="sql-abort-title">ABORT</refentrytitle>
 
9
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 
10
 </refmeta>
 
11
 
 
12
 <refnamediv>
 
13
  <refname>ABORT</refname>
 
14
  <refpurpose>abort the current transaction</refpurpose>
 
15
 </refnamediv>
 
16
 
 
17
 <indexterm zone="sql-abort">
 
18
  <primary>ABORT</primary>
 
19
 </indexterm>
 
20
 
 
21
 <refsynopsisdiv>
 
22
<synopsis>
 
23
ABORT [ WORK | TRANSACTION ]
 
24
</synopsis>
 
25
 </refsynopsisdiv>
 
26
 
 
27
 <refsect1>
 
28
  <title>Description</title>
 
29
 
 
30
  <para>
 
31
   <command>ABORT</command> rolls back the current transaction and causes
 
32
   all the updates made by the transaction to be discarded. 
 
33
   This command is identical
 
34
   in behavior to the standard <acronym>SQL</acronym> command
 
35
   <xref linkend="SQL-ROLLBACK" endterm="SQL-ROLLBACK-TITLE">,
 
36
   and is present only for historical reasons.
 
37
  </para>
 
38
 </refsect1>
 
39
 
 
40
 <refsect1>
 
41
  <title>Parameters</title>
 
42
 
 
43
  <variablelist>
 
44
   <varlistentry>
 
45
    <term><literal>WORK</literal></term>
 
46
    <term><literal>TRANSACTION</literal></term>
 
47
    <listitem>
 
48
     <para>
 
49
      Optional key words. They have no effect.
 
50
     </para>
 
51
    </listitem>
 
52
   </varlistentry>
 
53
  </variablelist>
 
54
 </refsect1>
 
55
 
 
56
 <refsect1>
 
57
  <title>Notes</title>
 
58
 
 
59
  <para>
 
60
   Use <xref linkend="SQL-COMMIT" endterm="SQL-COMMIT-TITLE"> to
 
61
   successfully terminate a transaction.
 
62
  </para>
 
63
 
 
64
  <para>
 
65
   Issuing <command>ABORT</> when not inside a transaction does
 
66
   no harm, but it will provoke a warning message.
 
67
  </para>
 
68
 </refsect1>
 
69
 
 
70
 <refsect1>
 
71
  <title>Examples</title>
 
72
 
 
73
  <para>
 
74
   To abort all changes:
 
75
<programlisting>
 
76
ABORT;
 
77
</programlisting>
 
78
  </para>
 
79
 </refsect1>
 
80
 
 
81
 <refsect1>
 
82
  <title>Compatibility</title>
 
83
 
 
84
  <para>
 
85
   This command is a <productname>PostgreSQL</productname> extension
 
86
   present for historical reasons. <command>ROLLBACK</command> is the
 
87
   equivalent standard SQL command.
 
88
  </para>
 
89
 </refsect1>
 
90
 
 
91
 <refsect1>
 
92
  <title>See Also</title>
 
93
 
 
94
  <simplelist type="inline">
 
95
   <member><xref linkend="sql-begin" endterm="sql-begin-title"></member>
 
96
   <member><xref linkend="sql-commit" endterm="sql-commit-title"></member>
 
97
   <member><xref linkend="sql-rollback" endterm="sql-rollback-title"></member>
 
98
  </simplelist>
 
99
 </refsect1>
 
100
</refentry>
 
101
 
 
102
<!-- Keep this comment at the end of the file
 
103
Local variables:
 
104
mode: sgml
 
105
sgml-omittag:nil
 
106
sgml-shorttag:t
 
107
sgml-minimize-attributes:nil
 
108
sgml-always-quote-attributes:t
 
109
sgml-indent-step:1
 
110
sgml-indent-data:t
 
111
sgml-parent-document:nil
 
112
sgml-default-dtd-file:"../reference.ced"
 
113
sgml-exposed-tags:nil
 
114
sgml-local-catalogs:"/usr/lib/sgml/catalog"
 
115
sgml-local-ecat-files:nil
 
116
End:
 
117
-->