1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_txn_error">
<refmeta>
<refentrytitle>txn_error</refentrytitle>
<refmiscinfo>txn</refmiscinfo>
</refmeta>
<refnamediv>
<refname>txn_error</refname>
<refpurpose>poison current transaction forcing rollback</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_txn_error">
<funcprototype id="fproto_txn_error">
<funcdef><function>txn_error</function></funcdef>
<paramdef>in <parameter>code</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>
Calling this function will poison the current transaction. This means that
it is forced to roll back at when committed. The code can be
in integer that selects the error message generated when trying to commit.
This is useful before signalling application errors from SQL code that runs
in manual commit mode. This can ensure that even if the client attempts
a commit after getting the error signalled by the application the transaction
will not commit.
</para>
<para>
The code should be the constant 6, resulting the in the 'transaction
rolled back due to previous SQL Error'.
</para>
</refsect1>
</refentry>
|
