Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 71d40963b505df4524269198e237b3e3 > files > 115

virtuoso-opensource-doc-6.1.4-2.fc14.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
 <head profile="http://internetalchemy.org/2003/02/profile">
  <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
  <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
  <meta name="dc.title" content="Function: XMLELEMENT - Virtuoso Functions Guide" />
  <meta name="dc.subject" content="Function: XMLELEMENT - Virtuoso Functions Guide" />
  <meta name="dc.creator" content="OpenLink Software Documentation Team ;&#10;" />
  <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
  <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
  <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
  <link rel="parent" href="functions.html" title="Chapter Contents" />
  <link rel="prev" href="appendixa.html" title="Appendix" />
  <link rel="next" href="functions.html#.html" title="" />
  <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
  <link rel="stylesheet" type="text/css" href="doc.css" />
  <link rel="stylesheet" type="text/css" href="/doc/translation.css" />
  <title>Function: XMLELEMENT - Virtuoso Functions Guide</title>
  <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
  <meta name="author" content="OpenLink Software Documentation Team ;&#10;" />
  <meta name="copyright" content="OpenLink Software, 1999 - 2009" />
  <meta name="keywords" content="" />
  <meta name="GENERATOR" content="OpenLink XSLT Team" />
 </head>
 <body>
  <div id="header">
    <a name="fn_XMLELEMENT" />
    <img src="../images/misc/logo.jpg" alt="" />
    <h1>22. Virtuoso Functions Guide - XMLELEMENT</h1>
  </div>
  <div id="navbartop">
   <div>
      <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_XMLCONCAT.html" title="XMLCONCAT">Prev</a> | <a class="link" href="fn_XMLFOREST.html" title="XMLFOREST">Next</a>
   </div>
  </div>
  <div id="currenttoc">
   <form method="post" action="/doc/adv_search.vspx">
    <div class="search">Keyword Search: <br />
        <input type="text" name="q" /> <input type="submit" name="go" value="Go" />
    </div>
   </form>
   <div>
      <a href="http://www.openlinksw.com/">www.openlinksw.com</a>
   </div>
   <div>
      <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
   </div>
    <br />
   <div>
      <a href="index.html">Book Home</a>
   </div>
    <br />
   <div>
      <a href="contents.html">Contents</a>
   </div>
   <div>
      <a href="preface.html">Preface</a>
   </div>
    <br />
   <div>
      <a class="selected" href="functions.html">Virtuoso Functions Guide</a>
   </div>
    <br />
   <div>
      <a href="functions.html#admin">Administration</a>
   </div>
   <div>
      <a href="functions.html#aggr">Aggregate Functions</a>
   </div>
   <div>
      <a href="functions.html#array">Array Manipulation</a>
   </div>
   <div>
      <a href="functions.html#bpel">BPEL APIs</a>
   </div>
   <div>
      <a href="functions.html#backup">Backup</a>
   </div>
   <div>
      <a href="functions.html#compression">Compression</a>
   </div>
   <div>
      <a href="functions.html#cursors">Cursor</a>
   </div>
   <div>
      <a href="functions.html#time">Date &amp; Time Manipulation</a>
   </div>
   <div>
      <a href="functions.html#debug">Debug</a>
   </div>
   <div>
      <a href="functions.html#dict">Dictionary Manipulation</a>
   </div>
   <div>
      <a href="functions.html#encoding">Encoding &amp; Decoding</a>
   </div>
   <div>
      <a href="functions.html#file">File Manipulation</a>
   </div>
   <div>
      <a href="functions.html#ft">Free Text</a>
   </div>
   <div>
      <a href="functions.html#hash">Hashing / Cryptographic</a>
   </div>
   <div>
      <a href="functions.html#ldap">LDAP</a>
   </div>
   <div>
      <a href="functions.html#localization">Locale</a>
   </div>
   <div>
      <a href="functions.html#mail">Mail</a>
   </div>
   <div>
      <a href="functions.html#misc">Miscellaneous</a>
   </div>
   <div>
      <a href="functions.html#number">Number</a>
   </div>
   <div>
      <a href="functions.html#phrz">Phrases</a>
   </div>
   <div>
      <a href="functions.html#rdf">RDF data</a>
   </div>
   <div>
      <a href="functions.html#rmt">Remote SQL Data Source</a>
   </div>
   <div>
      <a href="functions.html#repl">Replication</a>
   </div>
   <div>
      <a href="functions.html#soap">SOAP</a>
   </div>
   <div>
      <a href="functions.html#sql">SQL</a>
   </div>
   <div>
      <a href="functions.html#string">String</a>
   </div>
   <div>
      <a href="functions.html#txn">Transaction</a>
   </div>
   <div>
      <a href="functions.html#type">Type Mapping</a>
   </div>
   <div>
      <a href="functions.html#uddi">UDDI</a>
   </div>
   <div>
      <a href="functions.html#udt">User Defined Types &amp; The CLR</a>
   </div>
   <div>
      <a href="functions.html#vad">VAD</a>
   </div>
   <div>
      <a href="functions.html#jvmpl">Virtuoso Java PL API</a>
   </div>
   <div>
      <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
   </div>
   <div>
      <a href="functions.html#ws">Web &amp; Internet</a>
   </div>
   <div>
      <a class="selected" href="functions.html#xml">XML</a>
   </div>
   <div class="selected">
    <div>
        <a href="fn_XMLAGG.html">xmlagg</a>
    </div>
    <div>
        <a href="fn_XMLATTRIBUTES.html">xmlattributes</a>
    </div>
    <div>
        <a href="fn_XMLAddAttribute.html">xmladdattribute</a>
    </div>
    <div>
        <a href="fn_XMLAppendChildren.html">xmlappendchildren</a>
    </div>
    <div>
        <a href="fn_XMLCONCAT.html">xmlconcat</a>
    </div>
    <div>
        <a class="selected" href="fn_XMLELEMENT.html">xmlelement</a>
    </div>
    <div>
        <a href="fn_XMLFOREST.html">xmlforest</a>
    </div>
    <div>
        <a href="fn_XMLInsertAfter.html">xmlinsertafter</a>
    </div>
    <div>
        <a href="fn_XMLInsertBefore.html">xmlinsertbefore</a>
    </div>
    <div>
        <a href="fn_XMLReplace.html">xmlreplace</a>
    </div>
    <div>
        <a href="fn_XMLType.XMLType.html">xmltype.xmltype</a>
    </div>
    <div>
        <a href="fn_XMLType.createNonSchemaBasedXML.html">xmltype.createnonsch...</a>
    </div>
    <div>
        <a href="fn_XMLType.createSchemaBasedXML.html">xmltype.createschema...</a>
    </div>
    <div>
        <a href="fn_XMLType.createXML.html">xmltype.createxml</a>
    </div>
    <div>
        <a href="fn_XMLType.existsNode.html">xmltype.existsnode</a>
    </div>
    <div>
        <a href="fn_XMLType.extract.html">xmltype.extract</a>
    </div>
    <div>
        <a href="fn_XMLType.getClobVal.html">xmltype.getclobval</a>
    </div>
    <div>
        <a href="fn_XMLType.getNamespace.html">xmltype.getnamespace</a>
    </div>
    <div>
        <a href="fn_XMLType.getNumVal.html">xmltype.getnumval</a>
    </div>
    <div>
        <a href="fn_XMLType.getRootElement.html">xmltype.getrooteleme...</a>
    </div>
    <div>
        <a href="fn_XMLType.getSchemaURL.html">xmltype.getschemaurl</a>
    </div>
    <div>
        <a href="fn_XMLType.getStringVal.html">xmltype.getstringval</a>
    </div>
    <div>
        <a href="fn_XMLType.isFragment.html">xmltype.isfragment</a>
    </div>
    <div>
        <a href="fn_XMLType.isSchemaBased.html">xmltype.isschemabase...</a>
    </div>
    <div>
        <a href="fn_XMLType.isSchemaValid.html">xmltype.isschemavali...</a>
    </div>
    <div>
        <a href="fn_XMLType.isSchemaValidated.html">xmltype.isschemavali...</a>
    </div>
    <div>
        <a href="fn_XMLType.schemaValidate.html">xmltype.schemavalida...</a>
    </div>
    <div>
        <a href="fn_XMLType.setSchemaValidated.html">xmltype.setschemaval...</a>
    </div>
    <div>
        <a href="fn_XMLType.toObject.html">xmltype.toobject</a>
    </div>
    <div>
        <a href="fn_XMLType.transform.html">xmltype.transform</a>
    </div>
    <div>
        <a href="fn_XMLUpdate.html">xmlupdate</a>
    </div>
    <div>
        <a href="fn_xper_right_sibling.html">xper navigation</a>
    </div>
    <div>
        <a href="fn_createXML.html">createxml</a>
    </div>
    <div>
        <a href="fn_isentity.html">isentity</a>
    </div>
    <div>
        <a href="fn_serialize_to_UTF8_xml.html">serialize_to_utf8_xm...</a>
    </div>
    <div>
        <a href="fn_tidy_html.html">tidy_html</a>
    </div>
    <div>
        <a href="fn_tidy_list_errors.html">tidy_list_errors</a>
    </div>
    <div>
        <a href="fn_updateXML.html">updatexml</a>
    </div>
    <div>
        <a href="fn_xml_add_system_path.html">xml_add_system_path</a>
    </div>
    <div>
        <a href="fn_xml_auto.html">xml_auto</a>
    </div>
    <div>
        <a href="fn_xml_auto_dtd.html">xml_auto_dtd</a>
    </div>
    <div>
        <a href="fn_xml_auto_schema.html">xml_auto_schema</a>
    </div>
    <div>
        <a href="fn_xml_create_tables_from_mapping_schema_decl.html">xml_create_tables_fr...</a>
    </div>
    <div>
        <a href="fn_xml_cut.html">xml_cut</a>
    </div>
    <div>
        <a href="fn_xml_doc_output_option.html">xml_doc_output_optio...</a>
    </div>
    <div>
        <a href="fn_xml_get_system_paths.html">xml_get_system_paths</a>
    </div>
    <div>
        <a href="fn_xml_load_mapping_schema_decl.html">xml_load_mapping_sch...</a>
    </div>
    <div>
        <a href="fn_xml_load_schema_decl.html">xml_load_schema_decl</a>
    </div>
    <div>
        <a href="fn_xml_namespace_scope.html">xml_namespace_scope</a>
    </div>
    <div>
        <a href="fn_xml_persistent.html">xml_persistent</a>
    </div>
    <div>
        <a href="fn_xml_set_ns_decl.html">xml_set_ns_decl</a>
    </div>
    <div>
        <a href="fn_xml_template.html">xml_template</a>
    </div>
    <div>
        <a href="fn_xml_tree.html">xml_tree</a>
    </div>
    <div>
        <a href="fn_xml_tree_doc.html">xml_tree_doc</a>
    </div>
    <div>
        <a href="fn_xml_tree_doc_media_type.html">xml_tree_doc_media_t...</a>
    </div>
    <div>
        <a href="fn_xml_uri_get.html">xml_uri_get</a>
    </div>
    <div>
        <a href="fn_xml_validate_dtd.html">xml_validate_dtd</a>
    </div>
    <div>
        <a href="fn_xml_validate_schema.html">xml_validate_schema</a>
    </div>
    <div>
        <a href="fn_xml_view_dtd.html">xml_view_dtd</a>
    </div>
    <div>
        <a href="fn_xml_view_schema.html">xml_view_schema</a>
    </div>
    <div>
        <a href="fn_xmlsql_update.html">xmlsql_update</a>
    </div>
    <div>
        <a href="fn_xpath_eval.html">xpath_eval</a>
    </div>
    <div>
        <a href="fn_xper_cut.html">xper_cut</a>
    </div>
    <div>
        <a href="fn_xper_doc.html">xper_doc</a>
    </div>
    <div>
        <a href="fn_xper_locate_words.html">xper_locate_words</a>
    </div>
    <div>
        <a href="fn_xpf_extension.html">xpf_extension</a>
    </div>
    <div>
        <a href="fn_xpf_extension_remove.html">xpf_extension_remove</a>
    </div>
    <div>
        <a href="fn_xquery_eval.html">xquery_eval</a>
    </div>
    <div>
        <a href="fn_xslt.html">xslt</a>
    </div>
    <div>
        <a href="fn_xslt_format_number.html">xslt_format_number</a>
    </div>
    <div>
        <a href="fn_xslt_sheet.html">xslt_sheet</a>
    </div>
    <div>
        <a href="fn_xslt_stale.html">xslt_stale</a>
    </div>
    <div>
        <a href="fn_xte_head.html">xte_head</a>
    </div>
    <div>
        <a href="fn_xte_node.html">xte_node</a>
    </div>
    <div>
        <a href="fn_xte_node_from_nodebld.html">xte_node_from_nodebl...</a>
    </div>
    <div>
        <a href="fn_xte_nodebld_acc.html">xte_nodebld_acc</a>
    </div>
    <div>
        <a href="fn_xte_nodebld_final.html">xte_nodebld_final</a>
    </div>
    <div>
        <a href="fn_xte_nodebld_init.html">xte_nodebld_init</a>
    </div>
    <div>
        <a href="fn_xtree_doc.html">xtree_doc</a>
    </div>
   </div>
   <div>
      <a href="functions.html#XPATH">XPATH &amp; XQUERY</a>
   </div>
    <br />
   <div>
      <a href="functionidx.html">Functions Index</a>
   </div>
    <br />
  </div>
  <div id="text">
    <h2>XMLELEMENT</h2>
    <div class="refpurpose">Creates XML element</div>
    <div class="funcsynopsis">
        <span class="funcdef">
     <span class="function">XMLELEMENT</span>
     </span>
        (<span class="paramdef">
        <span class="parameter">tag_name</span> varchar</span>, 
        <span class="paramdefoptional">[<span class="optional">list_of_attributes</span> sequence]</span>, 
	<span class="paramdefoptional">[<span class="optional">child_or_attribute1</span> any]</span>, 
	<span class="paramdefoptional">[<span class="optional">child_or_attribute2</span> any]</span>, 
	<span class="paramdefoptional">[<span class="optional">...</span>]</span>, 
	<span class="paramdefoptional">[<span class="optional">child_or_attributeN</span> any]</span>);
      </div>
  
  
  
  <div class="refsect1">
      <div class="refsect1title">Description</div>
    <p>
    <span class="computeroutput">XMLELEMENT</span> takes an element name for identifier, an optional collection of attributes for the element, 
    and arguments that make up the element&#39;s content. 
    It returns a XML element. The second parameter may be omitted and at that time the 
    rest parameters may be present. If one of the arguments is a call of the <span class="computeroutput">xpath_eval</span> returning 
    an attribute value, then this value would be added to element&#39;s content (not to element&#39;s attributes).
    </p>
  </div>
  <div class="refsect1">
      <div class="refsect1title">Parameters</div>
    <div class="refsect2">
        <span class="refsect2title">tag_name – </span>
      name of the element, it must be valid XML element name 
    </div>
    <div class="refsect2">
        <span class="refsect2title">list_of_attributes – </span>
      a vector returned by <span class="computeroutput">XMLATTRIBUTES</span> function. If the vector is NULL, then no attribute is created.
    </div>
    <div class="refsect2">
        <span class="refsect2title">child_or_attributeI – </span>
      a string, or name of a column, or concatenation of the names and/or strings, or a vector returned by 
      <span class="computeroutput">XMLELEMENT</span>, <span class="computeroutput">XMLFOREST</span>,
      <span class="computeroutput">XMLCONCAT</span>, or <span class="computeroutput">XMLAGG</span> functions,
      or an entity object returned by 
      corresponding functions (e.g. <span class="computeroutput">xtree_doc</span> or <span class="computeroutput">xquery_eval</span>).
      If the entity object is an attribute entity, then it is joined 
      to the list of the element&#39;s attributes. If a parameter is NULL, then no child element or attribute is created for 
      that parameter.
      
    </div>
  </div>

  
    <div class="refsect1title">Errors</div>
    <table class="data">
      
	
	  <tr>
	    <th class="data">SQLState</th>
        <th class="data">Error Code</th>
        <th class="data">Error Text</th>
        <th class="data">Description</th>
	  </tr>
	
	
	  <tr>
	    <td class="data">
          <a name="err22003" />
          <span class="errorcode">22003</span>
        </td>
	    <td class="data">
          <a name="errSR354" />
          <span class="errorcode">SR354</span>
        </td>
	    <td class="data">
          <span class="errorname">Too few arguments for XMLELEMENT</span>
        </td>
	    <td class="data">There must be at least one argument</td>
	  </tr>
	
      
    </table>
    <br />
  <p />
  <p />
  <div class="refsect1">
      <div class="refsect1title">Examples</div>
    <a name="ex_XMLELEMENT" />
      <div class="example">
        <div class="exampletitle">XMLELEMENT() with a single argument</div>
      <p>
      <span class="computeroutput">XMLELEMENT</span> creates an &#39;Title&#39; element without content.
      </p>
      <div>
          <pre class="screen">
              select XMLELEMENT (&#39;Title&#39;) from &quot;Demo&quot;.&quot;demo&quot;.&quot;Employees&quot;;
callret
VARCHAR
_______________________________________________________________________________

&lt;Title /&gt;
&lt;Title /&gt;
. . .
9 Rows. -- 2 msec.
       </pre>
        </div>
    </div>
    <a name="ex_XMLELEMENT" />
      <div class="example">
        <div class="exampletitle">XMLELEMENT() with content</div>
      <p>The following example produces an &#39;Emp&#39; element with three attributes
     (the &#39;region&#39; attribute is calculated by <span class="computeroutput">xquery_eval</span>)
     and five nested subelements </p>
      <div>
          <pre class="screen">
select XMLELEMENT (&#39;Emp&#39;,
                    XMLATTRIBUTES ( &quot;EmployeeID&quot; AS &quot;EmpID&quot;, &quot;Title&quot;),
                    XMLELEMENT (&#39;Name&#39;, &quot;FirstName&quot; || &#39; &#39; || &quot;LastName&quot; ),
                    xquery_eval(&#39;//@region&#39;, xtree_doc (&#39;&lt;a region=&quot;WA&quot;&gt;&lt;/a&gt;&#39;)), 
                    XMLFOREST (&quot;PostalCode&quot;, &quot;City&quot; as &quot;city&quot;),
                    XMLCONCAT (XMLELEMENT (&#39;HomePhone&#39;, &quot;HomePhone&quot;),
                               XMLELEMENT (&#39;BirthDate&#39;, &quot;BirthDate&quot;))) 
  from &quot;Demo&quot;.&quot;demo&quot;.&quot;Employees&quot;
  where &quot;EmployeeID&quot;=1;

callret
VARCHAR
_______________________________________________________________________________
 
&lt;Emp EmpID=&quot;1&quot; Title=&quot;Sales Representative&quot; region=&quot;WA&quot;&gt;
  &lt;Name&gt;Nancy Davolio&lt;/Name&gt;
  &lt;city&gt;Seattle&lt;/city&gt;
  &lt;PostalCode&gt;98122&lt;/PostalCode&gt;
  &lt;HomePhone&gt;(206) 555-9857&lt;/HomePhone&gt;
  &lt;BirthDate&gt;1948-12-08&lt;/BirthDate&gt;
&lt;/Emp&gt;         
      </pre>
        </div>
    </div>
    <a name="ex_XMLELEMENT" />
      <div class="example">
        <div class="exampletitle">XMLELEMENT() with the aggregate function XMLAGG()</div>
      <p>
          This example produces &#39;Emp&#39; elements, with the list of the &#39;Name&#39; of all employees. 
      </p>
      <div>
          <pre class="screen">
select XMLELEMENT (&#39;Emp&#39;,
                    XMLAGG (XMLELEMENT(&#39;Name&#39;, &quot;FirstName&quot;, &#39; &#39;, &quot;LastName&quot;)))
  from &quot;Demo&quot;.&quot;demo&quot;.&quot;Employees&quot;;
callret
VARCHAR
_______________________________________________________________________________
 
&lt;Emp&gt;
   &lt;Name&gt;Nancy Davolio&lt;/Name&gt;
   &lt;Name&gt;Andrew Fuller&lt;/Name&gt;
   &lt;Name&gt;Janet Leverling&lt;/Name&gt;
   &lt;Name&gt;Margaret Peacock&lt;/Name&gt;
   &lt;Name&gt;Steven Buchanan&lt;/Name&gt;
   &lt;Name&gt;Michael Suyama&lt;/Name&gt;
   &lt;Name&gt;Robert King&lt;/Name&gt;
   &lt;Name&gt;Laura Callahan&lt;/Name&gt;
   &lt;Name&gt;Anne Dodsworth&lt;/Name&gt;
&lt;/Emp&gt;                                          
      </pre>
        </div>
    </div>
  </div>
  <div class="refsect1">
      <div class="refsect1title">See Also</div>
    <p>
        <a href="fn_XMLAGG.html">XMLAGG()</a>
      </p>
    <p>
        <a href="fn_XMLATTRIBUTES.html">XMLATTRIBUTE()</a>
      </p>
    <p>
        <a href="fn_XMLCONCAT.html">XMLCONCAT()</a>
      </p>
    <p>
        <a href="fn_XMLFOREST.html">XMLFOREST()</a>
      </p>
  </div>

</div>
  <div id="footer">
    <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
   <div id="validation">
    <a href="http://validator.w3.org/check/referer">
        <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
    </a>
    <a href="http://jigsaw.w3.org/css-validator/">
        <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
    </a>
   </div>
  </div>
 </body>
</html>