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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
<?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_view_schema">
<refmeta>
<refentrytitle>xml_view_schema</refentrytitle>
<refmiscinfo>xml</refmiscinfo>
</refmeta>
<refnamediv>
<refname>xml_view_schema</refname>
<refpurpose>returns an XML schema for the output of given XML VIEW</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_xml_view_schema">
<funcprototype id="fproto_xml_view_schema">
<funcdef>varchar <function>xml_view_schema</function></funcdef>
<paramdef>in <parameter>query </parameter>varchar</paramdef>
<paramdef>in <parameter>root_element </parameter>varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>
This function return an XML schema for the output of given XML VIEW.
The returned schema will be valid if the HTTP_... output of view
wrapped into the specified root element.
</para>
</refsect1>
<refsect1 id="params"><title>Parameters</title>
<refsect2><title>query</title>
<para>a string which contains a name of XML view </para></refsect2>
<refsect2><title>root_element </title>
<para>a string containing the element name in which the XML schema would be wrapped </para></refsect2>
</refsect1>
<refsect1 id="ret"><title>Return Types</title><para>XML Schema</para></refsect1>
<refsect1 id="errors_xml_view_schema"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname>No XML view [view_name]</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples"><title>Examples</title>
<example id="ex_xml_view_schema"><title>Creating an XML Schema</title>
<!--
<programlisting>
SQL> select xml_view_schema (' 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
_______________________________________________________________________________
<xsd:schema xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<xsd:annotation>
<xsd:documentation>
Schema for output of the following SQL statement:
<[CDATA[ select "category"."CategoryID", "CategoryName",
"ProductName", "ProductID"
from "Demo".."Categories" "category", "Demo".."Products" as "product"
where "product"."CategoryID" = "category"."CategoryID"
for xml auto element]]>
</xsd:documentation>
</xsd:annotation>
<xsd:element name="root" type="root__Type"/>
<xsd:complexType name="root__Type">
<xsd:element name="category" type="category_Type" minOccurs="0" maxOccurs="unbounded"/>
</xsd:complexType>
<xsd:complexType name="category_Type">
<xsd:element name="CategoryID" type="xsd:int" precision="10"/>
<xsd:element name="CategoryName" type="xsd:string" maxLength="15"/>
<xsd:element name="product" type="product_Type" minOccurs="0" maxOccurs="unbounded"/>
</xsd:complexType>
<xsd:complexType name="product_Type">
<xsd:element name="ProductName" type="xsd:string" maxLength="40"/>
<xsd:element name="ProductID" type="xsd:int" precision="10"/>
</xsd:complexType>
</xsd:schema>
1 Rows. - - 5 msec.
</programlisting>
-->
<programlisting>
SQL> select xml_view_schema ('cat', 'root');
callret
VARCHAR
_______________________________________________________________________________
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation>
<xsd:documentation>
Schema of XML view 'cat'
</xsd:documentation>
</xsd:annotation>
<xsd:element name="root" type="root__Type"/>
<xsd:complexType name="root__Type">
<xsd:element name="category" type="root_category_Type" minOccurs="0" maxOccurs="unbounded"/>
</xsd:complexType>
<xsd:complexType name="root_category_Type">
<xsd:attribute name="CategoryID" type="xsd:string"/>
<!-- <xsd:attribute name="CategoryID" type="xsd:int"/> -->
<xsd:attribute name="description" type="xsd:string"/>
<xsd:element name="product" type="category_product_Type" minOccurs="0" maxOccurs="unbounded"/>
</xsd:complexType>
<xsd:complexType name="category_product_Type">
<xsd:attribute name="ProductName" type="xsd:string"/>
</xsd:complexType>
</xsd:schema>
1 Rows. -- 9 msec.
</programlisting>
</example>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para><link linkend="fn_xml_view_dtd">xml_view_dtd()</link></para>
<para><link linkend="fn_xml_validate_dtd">xml_validate_dtd()</link></para>
<para><link linkend="fn_xml_persistent">xml_persistent()</link></para>
</refsect1>
</refentry>
|
