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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<?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_xmlsql_update">
<refmeta>
<refentrytitle>xmlsql_update</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xmlsql_update</refname>
<refpurpose>Performs insert/update/delete operations
based on an XML updategram.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xmlsql_update">
<funcprototype id="fproto_xmlsql_update">
<funcdef><function>xmlsql_update</function></funcdef>
<paramdef>in <parameter>xml_grams</parameter>XML_Entity </paramdef>
<paramdef><optional>in <parameter>input_parameters</parameter> vector</optional></paramdef>
<paramdef><optional>in <parameter>debug</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xmlsql_update"><title>Description</title>
<para><function>xmlsql_update()</function> supports XML-based insert,
update, and delete operations performed on an existing table in the
database. See <link linkend="updategrams">Updategrams basics</link>
in the "Web and XML section" for a detailed explanation.</para>
</refsect1>
<refsect1 id="params_xmlsql_update"><title>Parameters</title>
<refsect2><title>xml_grams</title>
<para>Mandatory parameter containing the XML document with gram(s).
This can be produced with sequential calls to the
<function>xml_tree()</function> and
<function>xml_tree_doc()</function> functions.</para>
</refsect2>
<refsect2><title>input_parameters</title>
<para>Optional array or vector of parameter pairs (parameter_name, parameter_value).</para>
</refsect2>
<refsect2><title>debug</title>
<para>The debug parameter takes values 1/0 to enable(1) or disable(0) printing of the SQL
statements it generates from the updategrams on the server's standard output. If not specified the default is disabled (0).</para>
</refsect2>
</refsect1>
<refsect1 id="ret_xmlsql_update"><title>Return Values</title>
<para>Zero, if no error is signalled.</para>
</refsect1>
<refsect1 id="errors_xmlsql_update"><title>Errors</title>
<table><title>Errors signalled by xmlsql_update</title>
<tgroup cols="2">
<thead>
<row><entry>Error Code</entry><entry>Error Text</entry></row>
</thead>
<tbody>
<row>
<entry><errorcode>XP370</errorcode></entry>
<entry><errorname>xmlsql_update needs an entity as argument</errorname></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorname>xmlsql_update expects a vector of even length as second argument</errorname></entry>
</row>
<row>
<entry><errorcode>SX999</errorcode></entry>
<entry><errorname>Empty parameters list</errorname></entry>
</row>
<row>
<entry><errorcode>SX998</errorcode></entry>
<entry><errorname>Too many values for query</errorname></entry>
</row>
<row>
<entry><errorcode>SX998</errorcode></entry>
<entry><errorname>No columns specified in updategram</errorname></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<!--
<refsect1 id="examples_xmlsql_update"><title>Examples</title>
<example id="ex_xmlsql_update"><title></title>
</example>
</refsect1>
-->
<refsect1 id="seealso_xmlsql_update"><title>See Also</title>
<para><link linkend="updategrams">Updategrams basics</link></para>
</refsect1>
</refentry>
|
