doc/xquery.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3 ]>
   4 <refentry id="xquery">
   5  <refentryinfo>
   6   <productname>Metaproxy XQuery module</productname>
   7   <info><orgname>Index Data</orgname></info>
   8  </refentryinfo>
   9
  10  <refmeta>
  11   <refentrytitle>xquery</refentrytitle>
  12   <manvolnum>3mp</manvolnum>
  13   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  14  </refmeta>
  15
  16  <refnamediv>
  17   <refname>xquery</refname>
  18   <refpurpose>
  19    Metaproxy Module for performing record transform using XQuery
  20   </refpurpose>
  21  </refnamediv>
  22
  23  <refsect1><title>DESCRIPTION</title>
  24   <para>
  25    This filter performs record transforms on XML records using
  26    XQuery. The module is based on Zorba.
  27   </para>
  28   <para>
  29    Configurable values:
  30    <variablelist>
  31     <varlistentry><term>&lt;script name="name"&gt;</term>
  32      <listitem>
  33       <para>
  34        The full path of the XQuery script to be invoked.
  35        This is required and should be set exactly once.
  36       </para>
  37      </listitem>
  38     </varlistentry>
  39     <varlistentry><term>&lt;record name="var"&gt;</term>
  40      <listitem>
  41       <para>
  42        The name of the XQUery variable where the input XML record
  43        is stored.
  44        This is required and should be set exactly once.
  45       </para>
  46      </listitem>
  47     </varlistentry>
  48     <varlistentry><term>&lt;variable name="name" value="value"/&gt;</term>
  49      <listitem>
  50       <para>
  51        Sets XQuery variable name to value. This is set before each
  52        record is converted. This setting may be repeated to set multiple
  53        variables.
  54       </para>
  55      </listitem>
  56     </varlistentry>
  57    </variablelist>
  58   </para>
  59  </refsect1>
  60
  61  <refsect1><title>SCHEMA</title>
  62    <literallayout><xi:include
  63                      xi:href="filter_xquery.rnc"
  64                      xi:parse="text"
  65                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  66    </literallayout>
  67  </refsect1>
  68
  69  <refsect1><title>EXAMPLES</title>
  70   <para>
  71    Configuration:
  72    <screen><![CDATA[
  73     <filter type="session_shared">
  74      <resultset ttl="10" max="3" restart="true"/>
  75      <session ttl="30" max="100"/>
  76     </filter>
  77 ]]>
  78    </screen>
  79   </para>
  80  </refsect1>
  81
  82  <refsect1><title>SEE ALSO</title>
  83   <para>
  84    <citerefentry>
  85     <refentrytitle>metaproxy</refentrytitle>
  86     <manvolnum>1</manvolnum>
  87    </citerefentry>
  88   </para>
  89  </refsect1>
  90
  91 </refentry>
  92
  93 <!-- Keep this comment at the end of the file
  94 Local variables:
  95 mode: nxml
  96 nxml-child-indent: 1
  97 End:
  98 -->