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
|
<?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_xml_auto_dtd">
<refmeta>
<refentrytitle>xml_auto_dtd</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xml_auto_dtd</refname>
<refpurpose>returns an XML DTD for the result of a SQL query with a FOR XML clause</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xml_auto_dtd">
<funcprototype id="fproto_xml_auto_dtd">
<funcdef>varchar <function>xml_auto_dtd</function></funcdef>
<paramdef>in <parameter>query</parameter> varchar</paramdef>
<paramdef>in <parameter>root_element</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_xml_auto_dtd"><title>Description</title>
<para>This function returns an XML DTD for the results of a SQL query with
a FOR XML clause. The returned DTD will apply to the output generated
by xml_auto with the query in question after wrapping it into the specified root element.
</para>
</refsect1>
<refsect1 id="params_xml_auto_dtd"><title>Parameters</title>
<refsect2><title>query</title>
<para>valid SQL query</para></refsect2>
<refsect2><title>root_element</title>
<para>name of root element to wrap result into</para></refsect2>
</refsect1>
<refsect1 id="ret_xml_auto_dtd"><title>Return Types</title><para>varchar of the resultant DTD</para></refsect1>
<refsect1 id="errors_xml_auto_dtd"><title>Errors</title>
<para>If the <parameter>query</parameter> argument is not a valid SQL statement, i.e. SQL compiler signals an error message,
the function resignals the error.
</para>
</refsect1>
<refsect1 id="examples_xml_auto_dtd"><title>Examples</title>
<example id="ex_xml_auto_dtd"><title>Simple Use</title>
<programlisting>
SQL> select xml_auto_dtd (' select "category"."CategoryID", "CategoryName",
"ProductName", "ProductID"
from "Demo".."Categories" "category", "Demo".."Products" as "product"
where "product"."CategoryID" = "category"."CategoryID" for xml auto element', 'root');
callret
VARCHAR
_______________________________________________________________________________
<!-- dtd for output of the following SQL statement:
select "category"."CategoryID", "CategoryName",
"ProductName", "ProductID"
from "Demo".."Categories" "category",
"Demo".."Products" as "product"
where "product"."CategoryID" = "category"."CategoryID"
for xml auto element
-->
<!ELEMENT root (#PCDATA | category)* >
<!ELEMENT category (#PCDATA | CategoryID | CategoryName | product)* >
<!ELEMENT product (#PCDATA | ProductName | ProductID)* >
<!ATTLIST category >
<!ATTLIST product >
<!ELEMENT CategoryID (#PCDATA)>
<!ATTRLIST CategoryID >
<!ELEMENT CategoryName (#PCDATA)>
<!ATTRLIST CategoryName >
<!ELEMENT ProductName (#PCDATA)>
<!ATTRLIST ProductName >
<!ELEMENT ProductID (#PCDATA)>
<!ATTRLIST ProductID >
1 Rows. -- 4 msec.
</programlisting>
</example>
</refsect1>
<refsect1 id="seealso_xml_auto_dtd"><title>See Also</title>
<para><link linkend="fn_xml_auto"><function>xml_auto()</function></link></para>
<para><link linkend="fn_xml_auto_schema"><function>xml_auto_schema()</function></link></para>
</refsect1>
</refentry>
|
