xml-general-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vgritse...@apache.org
Subject svn commit: r602294 [3/10] - in /xml/site/targets/xindice: ./ 1.0/ 1.1/ 1.1/howto/ 1.2/ 1.2/howto/ dev/ skin/ skin/images/
Date Sat, 08 Dec 2007 02:01:42 GMT
Added: xml/site/targets/xindice/1.1/guide-tools.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-tools.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/guide-tools.html (added)
+++ xml/site/targets/xindice/1.1/guide-tools.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,1774 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Xindice 1.1 Commandline Tool Guide</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> &gt; <a href="http://xml.apache.org/">xml.apache</a> &gt; <a href="http://xml.apache.org/xindice/">xindice</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://xml.apache.org"><img class="logoImage" alt="XML Apache" src="../images/group-logo.gif" title="Apache XML Project"></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://xml.apache.org/xindice/"><img class="logoImage" alt="Xindice" src="../images/xindice.gif" title="Apache Xindice: Native XML database"></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="xml.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../1.0/index.html">1.0</a>
+</li>
+<li class="current">
+<a class="selected" href="../1.1/index.html">1.1</a>
+</li>
+<li>
+<a class="unselected" href="../1.2/index.html">1.2-Dev</a>
+</li>
+<li>
+<a class="unselected" href="../dev/index.html">Dev</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs"></div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+
+             &nbsp;
+           </div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/index.html">Overview</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../1.1/guide-administrator.html">Administrator Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-user.html">User Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-developer.html">Developer Guide</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Tool Guide</div>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-xpath.html">XPath Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/faq.html">FAQ</a>
+</div>
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xml.apache.org/xindice/1.1/api/index.html">Javadocs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">How-Tos</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../skin/')" id="menu_1.3.2Title" class="menutitle">Compilation</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/compilation-unix.html">Unix</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/howto/compilation-windows.html">Windows</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.3', '../skin/')" id="menu_1.3.3Title" class="menutitle">Installation</div>
+<div id="menu_1.3.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/installation-tomcat.html">Tomcat How-to</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.4', '../skin/')" id="menu_1.3.4Title" class="menutitle">Upgrading</div>
+<div id="menu_1.3.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/upgrading-one-one.html">From 1.1b1 and up</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/howto/upgrading-one-oh.html">From 1.0</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Resources</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2"></div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<script language="Javascript" type="text/javascript">
+function printit() {
+  if (window.print) {
+    window.focus();
+    window.print();
+  }
+}
+        </script><script language="Javascript" type="text/javascript">
+var NS = (navigator.appName == "Netscape");
+var VERSION = parseInt(navigator.appVersion);
+if (VERSION > 3) {
+  document.write('<div title="Print this Page" class="printlink">');
+  document.write('  <a class="dida" href="javascript:printit()">');
+  document.write('    <img alt="print - icon" src="../skin/images/printer.gif" class="skin">');
+  document.write('    <br>');
+  document.write('  PRINT</a>');
+  document.write('</div>');
+}
+        </script>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="guide-tools.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+        PDF</a>
+</div>
+<h1>Xindice 1.1 Commandline Tool Guide</h1>
+<div class="abstract"></div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Collection+Management+Commands">Collection Management Commands</a>
+<ul class="minitoc">
+<li>
+<a href="#Adding+a+Collection">Adding a Collection</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A">Examples:</a>
+</li>
+<li>
+<a href="#Creating+a+Top+Level+Collection">Creating a Top Level Collection</a>
+</li>
+<li>
+<a href="#Creating+a+Sub+Collection+Under+an+Existing+Collection">Creating a Sub Collection Under an Existing Collection</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Deleting+a+Collection">Deleting a Collection</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N100B8">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N100F5">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10111">Examples:</a>
+</li>
+<li>
+<a href="#Deleting+a+Top+Level+Collection">Deleting a Top Level Collection</a>
+</li>
+<li>
+<a href="#Deleting+a+Sub+Collection">Deleting a Sub Collection</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#List+Collections">List Collections</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N10138">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10175">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N1018B">Examples:</a>
+</li>
+<li>
+<a href="#Listing+the+Top+Level+Collections">Listing the Top Level Collections</a>
+</li>
+<li>
+<a href="#Listing+a+Sub+Collection">Listing a Sub Collection</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Document+Management+Commands">Document Management Commands</a>
+<ul class="minitoc">
+<li>
+<a href="#Adding+a+Document">Adding a Document</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N101B9">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N101F6">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10218">Examples:</a>
+</li>
+<li>
+<a href="#Adding+a+document+to+a+collection+with+a+key+of+%22stones%22">Adding a document to a collection with a key of "stones"</a>
+</li>
+<li>
+<a href="#Adding+a+document+to+the+root+collection+with+an+automatically+generated+key">Adding a document to the root collection with an automatically generated key</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Adding+Multiple+Documents">Adding Multiple Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N1023F">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N1027C">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N1029E">Examples:</a>
+</li>
+<li>
+<a href="#Adding+all+files+from+a+directory+to+a+collection">Adding all files from a directory to a collection</a>
+</li>
+<li>
+<a href="#Adding+all+files+from+a+directory+with+an+extension+of+%22.xml%22">Adding all files from a directory with an extension of ".xml" </a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Deleting+a+Document">Deleting a Document</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N102C5">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10302">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N1031E">Examples:</a>
+</li>
+<li>
+<a href="#Deleting+a+Document+from+a+collection">Deleting a Document from a collection</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Retrieving+a+Document">Retrieving a Document</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N1033A">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10377">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10399">Examples:</a>
+</li>
+<li>
+<a href="#Retrieving+a+document+from+a+collection">Retrieving a document from a collection</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Importing+a+Directory+Tree">Importing a Directory Tree</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N103B5">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N103F2">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10414">Examples:</a>
+</li>
+<li>
+<a href="#Importing+all+directories+and+documents">Importing all directories and documents</a>
+</li>
+<li>
+<a href="#Importing+all+directories+and+documents+with+an+extension+of+%22.xml%22">Importing all directories and documents with an extension of ".xml" </a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Exporting+a+Directory+Tree">Exporting a Directory Tree</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N1043B">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10478">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10494">Examples:</a>
+</li>
+<li>
+<a href="#Creating+a+directory+tree+indentical+to+a+collection">Creating a directory tree indentical to a collection</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Collection+Indexer+Actions">Collection Indexer Actions</a>
+<ul class="minitoc">
+<li>
+<a href="#Adding+a+Collection+Indexer">Adding a Collection Indexer</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N104B7">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N104F4">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N1052B">Examples:</a>
+</li>
+<li>
+<a href="#To+create+a+collection+index+in+the+pebbles+collection+for%0A++++++++++++documents+with+a+%22rock%22+element">
+            To create a collection index in the pebbles collection for
+            documents with a "rock" element
+          </a>
+</li>
+<li>
+<a href="#To+create+a+collection+index+in+the+boulder+sub+collection%0A++++++++++++for+documents+containing+a+rock+elements+with+an+attribute+of+%22hard%22">
+            To create a collection index in the boulder sub collection
+            for documents containing a rock elements with an attribute of "hard"
+          </a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Deleting+a+Collection+Indexer">Deleting a Collection Indexer</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N10552">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N1058F">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N105AB">Examples:</a>
+</li>
+<li>
+<a href="#Delete+a+collecion+index+in+the+pebbles+collection">Delete a collecion index in the pebbles collection</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Listing+Collection+Indexers">Listing Collection Indexers</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N105C7">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10604">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N1061A">Examples:</a>
+</li>
+<li>
+<a href="#To+list+all+collection+indexes+from+the+pebbles+collection">To list all collection indexes from the pebbles collection  </a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Xpath+Query+Actions">Xpath Query Actions</a>
+<ul class="minitoc">
+<li>
+<a href="#Executing+an+Xpath+Query+against+a+Collection">Executing an Xpath Query against a Collection</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N1063D">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N1067A">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N1069C">Examples:</a>
+</li>
+<li>
+<a href="#Run+an+Xpath+query+against+all+documents+in+the+pebbles+collection%0A++++++++++++with+%22rock%22+node+that+has+the+type+attribute+%3D+%22hard%22">
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard"
+          </a>
+</li>
+<li>
+<a href="#Run+an+Xpath+query+against+all+documents+in+the+pebbles+collection%0A++++++++++++with+%22rock%22+node+that+has+the+type+attribute+%3D+%22hard%22+when+the+rock%0A++++++++++++element+is+in+the+namespace+http%3A%2F%2Fwww.bedrock.com">
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard" when the rock
+            element is in the namespace http://www.bedrock.com
+          </a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Miscellaneous+Actions">Miscellaneous Actions</a>
+<ul class="minitoc">
+<li>
+<a href="#Shutting+down+the+server">Shutting down the server</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N106CA">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10707">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10717">Examples:</a>
+</li>
+<li>
+<a href="#Shutdown+the+server">Shutdown the server</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Accessing+online+Help">Accessing online Help</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary%3A-N10733">Summary:</a>
+</li>
+<li>
+<a href="#Parameters%3A-N10770">Parameters:</a>
+</li>
+<li>
+<a href="#Examples%3A-N10780">Examples:</a>
+</li>
+<li>
+<a href="#Show+online+Help">Show online Help</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+    
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+      If you notice incorrectness in this documentation, please
+      <a href="../mail.html">notify</a> Xindice community. Your feedback
+      will help create better documentation.
+    </div>
+</div>
+
+    
+<a name="N10029"></a><a name="Collection+Management+Commands"></a>
+<h2 class="h3">Collection Management Commands</h2>
+<div class="section">
+<a name="N1002F"></a><a name="Adding+a+Collection"></a>
+<h3 class="h4">Adding a Collection</h3>
+<p>
+          Adds a new collection to the database. When adding a collection
+          under an existing collection hierarchy all parent collections must
+          already exist in the database.
+        </p>
+<a name="N10038"></a><a name="Summary%3A"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice add_collection -c (or context)
+                  -n (or name) [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">add_collection</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">ac</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin</td>
+          
+</tr>
+        
+</table>
+<a name="N10075"></a><a name="Parameters%3A"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to create the new
+                  collection.
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The name of the collection to create
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10091"></a><a name="Examples%3A"></a>
+<h4>Examples:</h4>
+<a name="N10098"></a><a name="Creating+a+Top+Level+Collection"></a>
+<h4>Creating a Top Level Collection</h4>
+<pre class="code">
+  xindice add_collection -c /db -n pebbles
+          </pre>
+<a name="N100A3"></a><a name="Creating+a+Sub+Collection+Under+an+Existing+Collection"></a>
+<h4>Creating a Sub Collection Under an Existing Collection</h4>
+<pre class="code">
+  xindice add_collection -c /db/pebbles -n boulder
+          </pre>
+<a name="N100AF"></a><a name="Deleting+a+Collection"></a>
+<h3 class="h4">Deleting a Collection</h3>
+<p>
+          Deletes a collection or subcollection from the database. If deleting
+          a collection that has subcollections and documents they will also be
+          deleted.
+        </p>
+<a name="N100B8"></a><a name="Summary%3A-N100B8"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice delete_collection -c (or context)
+                  -n (or name)
+                  [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">delete_collection</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">dc</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin</td>
+          
+</tr>
+        
+</table>
+<a name="N100F5"></a><a name="Parameters%3A-N100F5"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to delete the collection.
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The name of the collection to delete.
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10111"></a><a name="Examples%3A-N10111"></a>
+<h4>Examples:</h4>
+<a name="N10118"></a><a name="Deleting+a+Top+Level+Collection"></a>
+<h4>Deleting a Top Level Collection</h4>
+<pre class="code">
+  xindice delete_collection -c /db -n pebbles
+          </pre>
+<a name="N10123"></a><a name="Deleting+a+Sub+Collection"></a>
+<h4>Deleting a Sub Collection</h4>
+<pre class="code">
+  xindice delete_collection -c /db/pebbles -n boulder
+          </pre>
+<a name="N1012F"></a><a name="List+Collections"></a>
+<h3 class="h4">List Collections</h3>
+<p>
+          List all collections under the collection context given.
+        </p>
+<a name="N10138"></a><a name="Summary%3A-N10138"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice list_collections -c (or context) [-v (or )]</span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">list_collections</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">lc</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N10175"></a><a name="Parameters%3A-N10175"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which all sub collections are listed
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N1018B"></a><a name="Examples%3A-N1018B"></a>
+<h4>Examples:</h4>
+<a name="N10192"></a><a name="Listing+the+Top+Level+Collections"></a>
+<h4>Listing the Top Level Collections</h4>
+<pre class="code">
+  xindice list_collections -c /db
+          </pre>
+<a name="N1019D"></a><a name="Listing+a+Sub+Collection"></a>
+<h4>Listing a Sub Collection</h4>
+<pre class="code">
+  xindice list_collections -c /db/pebbles
+          </pre>
+</div>
+
+    
+<a name="N101AA"></a><a name="Document+Management+Commands"></a>
+<h2 class="h3">Document Management Commands</h2>
+<div class="section">
+<a name="N101B0"></a><a name="Adding+a+Document"></a>
+<h3 class="h4">Adding a Document</h3>
+<p>
+          Adds a document to a collection or nested collection. Adding a
+          document requires two parameters - the collection it will be stored
+          under, and the file path to the document. If a document key is not
+          provided an auto-generated system key will be used for the document.
+          Documents cannot be added to collections that do not already exist.
+          When entering the file path be sure to include the path and file
+          extension.
+        </p>
+<a name="N101B9"></a><a name="Summary%3A-N101B9"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice add_document -c (or context)
+                  -f (or file path)
+                  [-n (or key to assign to document)]
+                  [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">add_document</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">ad</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N101F6"></a><a name="Parameters%3A-N101F6"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to add the document
+          </li>
+          
+<li>
+            
+<span class="codefrag">-f</span> The complete file path to the document being added
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The key to assign to the document
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10218"></a><a name="Examples%3A-N10218"></a>
+<h4>Examples:</h4>
+<a name="N1021F"></a><a name="Adding+a+document+to+a+collection+with+a+key+of+%22stones%22"></a>
+<h4>Adding a document to a collection with a key of "stones"</h4>
+<pre class="code">
+  xindice add_document -c /db/pebbles -f /tmp/stones.xml -n stones
+          </pre>
+<a name="N1022A"></a><a name="Adding+a+document+to+the+root+collection+with+an+automatically+generated+key"></a>
+<h4>Adding a document to the root collection with an automatically generated key</h4>
+<pre class="code">
+  xindice add_document -c /db -f /tmp/bookmarks.xml
+          </pre>
+<a name="N10236"></a><a name="Adding+Multiple+Documents"></a>
+<h3 class="h4">Adding Multiple Documents</h3>
+<p>
+          Adds multiple documents to a collection or a nested collection. This
+          command requires two arguments: the collection to store the documents
+          under and the directory path containing the documents.  Documents can
+          be added to collections as well as subcollections as long as they
+          exist. Documents added will be assigned their file name as the
+          document key. The optional "extension" parameter can be used to
+          import documents with a certain file extension. Document keys are
+          shown as they are created.
+        </p>
+<a name="N1023F"></a><a name="Summary%3A-N1023F"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice add_multiple_documents -c (or context)
+                  -f (or Directory to use )
+                  [-e (or file extenstion )]
+                  [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">add_multiple_documents</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">addmultiple</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N1027C"></a><a name="Parameters%3A-N1027C"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to add the documents
+          </li>
+          
+<li>
+            
+<span class="codefrag">-f</span> The path to the directory to import documents from
+          </li>
+          
+<li>
+            
+<span class="codefrag">-e</span> The file extension to use when importing documents
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N1029E"></a><a name="Examples%3A-N1029E"></a>
+<h4>Examples:</h4>
+<a name="N102A5"></a><a name="Adding+all+files+from+a+directory+to+a+collection"></a>
+<h4>Adding all files from a directory to a collection</h4>
+<pre class="code">
+  xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs
+          </pre>
+<a name="N102B0"></a><a name="Adding+all+files+from+a+directory+with+an+extension+of+%22.xml%22"></a>
+<h4>Adding all files from a directory with an extension of ".xml" </h4>
+<pre class="code">
+  xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs -e xml
+          </pre>
+<a name="N102BC"></a><a name="Deleting+a+Document"></a>
+<h3 class="h4">Deleting a Document</h3>
+<p>
+          Deletes an existing document from a collection or nested collection
+          within the database.
+        </p>
+<a name="N102C5"></a><a name="Summary%3A-N102C5"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice delete_document -c (or context)
+                  -n (or document key)
+                  [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">delete_document</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">dd</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N10302"></a><a name="Parameters%3A-N10302"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to delete the document
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The key of the document to be deleted
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N1031E"></a><a name="Examples%3A-N1031E"></a>
+<h4>Examples:</h4>
+<a name="N10325"></a><a name="Deleting+a+Document+from+a+collection"></a>
+<h4>Deleting a Document from a collection</h4>
+<pre class="code">
+  xindice delete_document -c /db/pebbles -n stones
+          </pre>
+<a name="N10331"></a><a name="Retrieving+a+Document"></a>
+<h3 class="h4">Retrieving a Document</h3>
+<p>
+               Retrieves an existing document from a collection or nested collection within the database.  The complete path where
+               the document will be stored is required.  If the file path passed in does not exist, it will be created .
+               If the file argument given already exists, it will be overwritten automatically.
+        </p>
+<a name="N1033A"></a><a name="Summary%3A-N1033A"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice retrieve_document -c (or context)
+                  -n (or document key)
+                  -f (or file path and name )
+                  [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">retrieve_document</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">rd</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N10377"></a><a name="Parameters%3A-N10377"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to retrieve the document
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The key of the document to be retrieved
+          </li>
+          
+<li>
+            
+<span class="codefrag">-f</span> The file path to store the document under
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10399"></a><a name="Examples%3A-N10399"></a>
+<h4>Examples:</h4>
+<a name="N103A0"></a><a name="Retrieving+a+document+from+a+collection"></a>
+<h4>Retrieving a document from a collection</h4>
+<pre class="code">
+  xindice retrieve_document -c /db/pebbles -n stones -f /tmp/stones.xml
+          </pre>
+<a name="N103AC"></a><a name="Importing+a+Directory+Tree"></a>
+<h3 class="h4">Importing a Directory Tree</h3>
+<p>
+          Adds multiple documents into a collection or a nested collection
+          within the database, copying the directory structure into the
+          database as collections. This command is designed to take a
+          directory and create a collection from it's name. Directories
+          under the directory will also be created as collections,
+          duplicating the directory tree.  The files within the specified
+          directory are converted into Documents and then stored into the
+          newly created collection with their filenames as the document keys.
+          The optional "extension" parameter can be used to only import
+          documents with a certain file extension. If the collection name
+          used already exists it will be overwritten. Collection and document
+          keys will are shown as they are created.
+        </p>
+<a name="N103B5"></a><a name="Summary%3A-N103B5"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice import -c (or context)
+                  -f (or file path and name )
+                  [-e (or file extenstion )]
+                  [-v (or ) ]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">import</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">import</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin</td>
+          
+</tr>
+        
+</table>
+<a name="N103F2"></a><a name="Parameters%3A-N103F2"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to import the documents
+          </li>
+          
+<li>
+            
+<span class="codefrag">-f</span> The path to the documents being added
+          </li>
+          
+<li>
+            
+<span class="codefrag">-e</span> The file extension to use when importing documents
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10414"></a><a name="Examples%3A-N10414"></a>
+<h4>Examples:</h4>
+<a name="N1041B"></a><a name="Importing+all+directories+and+documents"></a>
+<h4>Importing all directories and documents</h4>
+<pre class="code">
+  xindice import -c /db/pebbles -f /tmp/flintstones
+          </pre>
+<a name="N10426"></a><a name="Importing+all+directories+and+documents+with+an+extension+of+%22.xml%22"></a>
+<h4>Importing all directories and documents with an extension of ".xml" </h4>
+<pre class="code">
+  xindice import -c /db/pebbles -f /tmp/flintstones -e xml
+          </pre>
+<a name="N10432"></a><a name="Exporting+a+Directory+Tree"></a>
+<h3 class="h4">Exporting a Directory Tree</h3>
+<p>
+          Creates an identical directory tree from a collection including any
+          subcollections. The directory tree will be created starting at the
+          directory passed in as an argument. This command requires the
+          collection which you are eporting and the directory to export to as
+          arguments.
+        </p>
+<a name="N1043B"></a><a name="Summary%3A-N1043B"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice export -c (or context) -f (or directory path) [-v (or )]</span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">export</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">export</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N10478"></a><a name="Parameters%3A-N10478"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to export the document tree
+          </li>
+          
+<li>
+            
+<span class="codefrag">-f</span> The directory to create the collection structure under
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10494"></a><a name="Examples%3A-N10494"></a>
+<h4>Examples:</h4>
+<a name="N1049B"></a><a name="Creating+a+directory+tree+indentical+to+a+collection"></a>
+<h4>Creating a directory tree indentical to a collection</h4>
+<pre class="code">
+  xindice export -c /db/pebbles -f /tmp/pebbles
+          </pre>
+</div>
+
+    
+<a name="N104A8"></a><a name="Collection+Indexer+Actions"></a>
+<h2 class="h3">Collection Indexer Actions</h2>
+<div class="section">
+<a name="N104AE"></a><a name="Adding+a+Collection+Indexer"></a>
+<h3 class="h4">Adding a Collection Indexer</h3>
+<p>
+          Adds a new collection index or nested collection index to the
+          database. In order to add the collection index, the collection it is
+          being added to must already exist.  This command allows you to supply
+          optional parameters for setting the index page size, setting the
+          maximum key size for the index, and the index data type.
+        </p>
+<a name="N104B7"></a><a name="Summary%3A-N104B7"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice add_indexer
+                  -c (or context)
+                  -n (or index name )
+                  -p (or index pattern)
+                  [--pagesize (or pagesize)]
+                  [--maxkeysize (or max key size)]
+                  [-t (or  index type)]
+                  [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">add_indexer</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">ai</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin</td>
+          
+</tr>
+        
+</table>
+<a name="N104F4"></a><a name="Parameters%3A-N104F4"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to add the indexer
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The name of the index being added
+          </li>
+          
+<li>
+            
+<span class="codefrag">-p</span> The pattern used to create the index
+          </li>
+          
+<li>
+            
+<span class="codefrag">--maxkeysize</span> The MaxKeySize for the index ( default: 0 = none )
+          </li>
+          
+<li>
+            
+<span class="codefrag">--pagesize</span> The PageSize for the index ( default: 4096)
+          </li>
+          
+<li>
+            
+<span class="codefrag">-t</span>
+                  The data type for the index to create.  Possible values are:
+            <span class="codefrag">      string   Non-normalized string value
+            trimmed  Normalized (whitespace stripped) string value
+            short    16-bit signed short integer
+            int      32-bit signed integer
+            long     64-bit signed integer
+            float    32-bit floating point value
+            double   64-bit floating point value (XPath number)
+            byte     8-bit signed byte
+            char     16-bit signed character
+            boolean  8-bit boolean value
+            name     Store document keys that contain the pattern</span>
+          
+</li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N1052B"></a><a name="Examples%3A-N1052B"></a>
+<h4>Examples:</h4>
+<a name="N10532"></a><a name="To+create+a+collection+index+in+the+pebbles+collection+for%0A++++++++++++documents+with+a+%22rock%22+element"></a>
+<h4>
+            To create a collection index in the pebbles collection for
+            documents with a "rock" element
+          </h4>
+<pre class="code">
+  xindice add_indexer -c /db/pebbles -n rockindex -p rock
+          </pre>
+<a name="N1053D"></a><a name="To+create+a+collection+index+in+the+boulder+sub+collection%0A++++++++++++for+documents+containing+a+rock+elements+with+an+attribute+of+%22hard%22"></a>
+<h4>
+            To create a collection index in the boulder sub collection
+            for documents containing a rock elements with an attribute of "hard"
+          </h4>
+<pre class="code">
+  xindice add_indexer -c /db/pebbles/boulder -n hardindex -p rock@hard
+          </pre>
+<a name="N10549"></a><a name="Deleting+a+Collection+Indexer"></a>
+<h3 class="h4">Deleting a Collection Indexer</h3>
+<p>
+          Deletes a collection index or a nested collection index from the
+          database. Deleting an index requires the collection and index name.
+          If a collection index is deleted, the collection will still remain.
+        </p>
+<a name="N10552"></a><a name="Summary%3A-N10552"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice delete_indexer -c (or context) -n (or index name) [-v (or )]</span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">delete_indexer  </span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">di  </span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin  </td>
+          
+</tr>
+        
+</table>
+<a name="N1058F"></a><a name="Parameters%3A-N1058F"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to delete the index
+          </li>
+          
+<li>
+            
+<span class="codefrag">-n</span> The name of the indexer being deleted
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N105AB"></a><a name="Examples%3A-N105AB"></a>
+<h4>Examples:</h4>
+<a name="N105B2"></a><a name="Delete+a+collecion+index+in+the+pebbles+collection"></a>
+<h4>Delete a collecion index in the pebbles collection</h4>
+<pre class="code">
+  xindice delete_indexer -c /db/pebbles -n hardindex
+          </pre>
+<a name="N105BE"></a><a name="Listing+Collection+Indexers"></a>
+<h3 class="h4">Listing Collection Indexers</h3>
+<p>
+          Lists all collection indexers or nested collection indexes in the
+          database. The listing of indexes works in a similar fashion to
+          listing collections
+        </p>
+<a name="N105C7"></a><a name="Summary%3A-N105C7"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice list_indexers -c (or context) [-v (or )]</span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">list_indexers</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">li</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin</td>
+          
+</tr>
+        
+</table>
+<a name="N10604"></a><a name="Parameters%3A-N10604"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to list the indexers
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N1061A"></a><a name="Examples%3A-N1061A"></a>
+<h4>Examples:</h4>
+<a name="N10621"></a><a name="To+list+all+collection+indexes+from+the+pebbles+collection"></a>
+<h4>To list all collection indexes from the pebbles collection  </h4>
+<pre class="code">
+  xindice list_indexers -c /db/pebbles
+          </pre>
+</div>
+
+    
+<a name="N1062E"></a><a name="Xpath+Query+Actions"></a>
+<h2 class="h3">Xpath Query Actions</h2>
+<div class="section">
+<a name="N10634"></a><a name="Executing+an+Xpath+Query+against+a+Collection"></a>
+<h3 class="h4">Executing an Xpath Query against a Collection</h3>
+<p>
+          Execute an Xpath query against a collection or nested collection. The
+          command requires two arguments: the collection to query against and
+          the query string to use.
+        </p>
+<a name="N1063D"></a><a name="Summary%3A-N1063D"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice xpath -c (or context) -q (or query) -s (or prefix=namespace) [-v (or )]</span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">xpath</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">xpath</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N1067A"></a><a name="Parameters%3A-N1067A"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-c</span> The collection context under which to execute the query
+          </li>
+          
+<li>
+            
+<span class="codefrag">-q</span> The query to execute against the collection
+          </li>
+          
+<li>
+            
+<span class="codefrag">-s</span> Semi-colon delimited list of namespaces for query
+            in the form prefix=namespace-uri
+          </li>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N1069C"></a><a name="Examples%3A-N1069C"></a>
+<h4>Examples:</h4>
+<a name="N106A3"></a><a name="Run+an+Xpath+query+against+all+documents+in+the+pebbles+collection%0A++++++++++++with+%22rock%22+node+that+has+the+type+attribute+%3D+%22hard%22"></a>
+<h4>
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard"
+          </h4>
+<pre class="code">
+  xindice xpath -c /db/pebbles -q "/rock[@type='hard']"
+          </pre>
+<a name="N106AE"></a><a name="Run+an+Xpath+query+against+all+documents+in+the+pebbles+collection%0A++++++++++++with+%22rock%22+node+that+has+the+type+attribute+%3D+%22hard%22+when+the+rock%0A++++++++++++element+is+in+the+namespace+http%3A%2F%2Fwww.bedrock.com"></a>
+<h4>
+            Run an Xpath query against all documents in the pebbles collection
+            with "rock" node that has the type attribute = "hard" when the rock
+            element is in the namespace http://www.bedrock.com
+          </h4>
+<pre class="code">
+  xindice xpath -c /db/pebbles -s "br=http://www.bedrock.com" -q "/br:rock[@type='hard']"
+          </pre>
+</div>
+
+    
+<a name="N106BB"></a><a name="Miscellaneous+Actions"></a>
+<h2 class="h3">Miscellaneous Actions</h2>
+<div class="section">
+<a name="N106C1"></a><a name="Shutting+down+the+server"></a>
+<h3 class="h4">Shutting down the server</h3>
+<p>Shutdown the Xindice server</p>
+<a name="N106CA"></a><a name="Summary%3A-N106CA"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice shutdown [-v (or )]
+          </span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">shutdown</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">shutdown</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">Admin</td>
+          
+</tr>
+        
+</table>
+<a name="N10707"></a><a name="Parameters%3A-N10707"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10717"></a><a name="Examples%3A-N10717"></a>
+<h4>Examples:</h4>
+<a name="N1071E"></a><a name="Shutdown+the+server"></a>
+<h4>Shutdown the server</h4>
+<pre class="code">
+  xindice shutdown
+          </pre>
+<a name="N1072A"></a><a name="Accessing+online+Help"></a>
+<h3 class="h4">Accessing online Help</h3>
+<p>Show the online help</p>
+<a name="N10733"></a><a name="Summary%3A-N10733"></a>
+<h4>Summary:</h4>
+<p>
+          
+<span class="codefrag">xindice help [-v (or )]</span>
+        
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">help</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Abberviated-Action:</td>
+            <td colspan="1" rowspan="1">
+              <span class="codefrag">help</span>
+            </td>
+          
+</tr>
+          
+<tr>
+            
+<td colspan="1" rowspan="1">Access Level:</td>
+            <td colspan="1" rowspan="1">User</td>
+          
+</tr>
+        
+</table>
+<a name="N10770"></a><a name="Parameters%3A-N10770"></a>
+<h4>Parameters:</h4>
+<ul>
+          
+<li>
+            
+<span class="codefrag">-v</span> Show verbose output
+          </li>
+        
+</ul>
+<a name="N10780"></a><a name="Examples%3A-N10780"></a>
+<h4>Examples:</h4>
+<a name="N10787"></a><a name="Show+online+Help"></a>
+<h4>Show online Help</h4>
+<pre class="code">
+  xindice help
+          </pre>
+</div>
+  
+<p align="right">
+<font size="-2">by&nbsp;Jay Kalafus,&nbsp;Kimbro Staken</font>
+</p>
+<span class="version">
+          version 598114</span>
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2001-2007 The Apache Software Foundation.</div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Propchange: xml/site/targets/xindice/1.1/guide-tools.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/guide-tools.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/guide-tools.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-tools.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/guide-tools.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf

Added: xml/site/targets/xindice/1.1/guide-user.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-user.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/guide-user.html (added)
+++ xml/site/targets/xindice/1.1/guide-user.html Fri Dec  7 18:01:36 2007
@@ -0,0 +1,764 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Xindice 1.1 User Guide</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> &gt; <a href="http://xml.apache.org/">xml.apache</a> &gt; <a href="http://xml.apache.org/xindice/">xindice</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://xml.apache.org"><img class="logoImage" alt="XML Apache" src="../images/group-logo.gif" title="Apache XML Project"></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://xml.apache.org/xindice/"><img class="logoImage" alt="Xindice" src="../images/xindice.gif" title="Apache Xindice: Native XML database"></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="xml.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../1.0/index.html">1.0</a>
+</li>
+<li class="current">
+<a class="selected" href="../1.1/index.html">1.1</a>
+</li>
+<li>
+<a class="unselected" href="../1.2/index.html">1.2-Dev</a>
+</li>
+<li>
+<a class="unselected" href="../dev/index.html">Dev</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs"></div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+
+             &nbsp;
+           </div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/index.html">Overview</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../1.1/guide-administrator.html">Administrator Guide</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">User Guide</div>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-developer.html">Developer Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-tools.html">Tool Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-xpath.html">XPath Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/faq.html">FAQ</a>
+</div>
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xml.apache.org/xindice/1.1/api/index.html">Javadocs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">How-Tos</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../skin/')" id="menu_1.3.2Title" class="menutitle">Compilation</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/compilation-unix.html">Unix</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/howto/compilation-windows.html">Windows</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.3', '../skin/')" id="menu_1.3.3Title" class="menutitle">Installation</div>
+<div id="menu_1.3.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/installation-tomcat.html">Tomcat How-to</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.4', '../skin/')" id="menu_1.3.4Title" class="menutitle">Upgrading</div>
+<div id="menu_1.3.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/upgrading-one-one.html">From 1.1b1 and up</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/howto/upgrading-one-oh.html">From 1.0</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Resources</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2"></div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<script language="Javascript" type="text/javascript">
+function printit() {
+  if (window.print) {
+    window.focus();
+    window.print();
+  }
+}
+        </script><script language="Javascript" type="text/javascript">
+var NS = (navigator.appName == "Netscape");
+var VERSION = parseInt(navigator.appVersion);
+if (VERSION > 3) {
+  document.write('<div title="Print this Page" class="printlink">');
+  document.write('  <a class="dida" href="javascript:printit()">');
+  document.write('    <img alt="print - icon" src="../skin/images/printer.gif" class="skin">');
+  document.write('    <br>');
+  document.write('  PRINT</a>');
+  document.write('</div>');
+}
+        </script>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="guide-user.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+        PDF</a>
+</div>
+<h1>Xindice 1.1 User Guide</h1>
+<div class="abstract"></div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Getting+Started+with+Xindice">Getting Started with Xindice</a>
+<ul class="minitoc">
+<li>
+<a href="#Introduction+to+XML+Databases">Introduction to XML Databases</a>
+</li>
+<li>
+<a href="#Apache+Xindice">Apache Xindice</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Introduction+to+Xindice">Introduction to Xindice</a>
+<ul class="minitoc">
+<li>
+<a href="#What+Is+Xindice">What Is Xindice</a>
+</li>
+<li>
+<a href="#Current+Status">Current Status</a>
+</li>
+<li>
+<a href="#Feature+Summary">Feature Summary</a>
+</li>
+<li>
+<a href="#Database+Structure">Database Structure</a>
+<ul class="minitoc">
+<li>
+<a href="#Collection+Path+Example">Collection Path Example</a>
+</li>
+<li>
+<a href="#Collection+Path+Referencing+a+Document">Collection Path Referencing a Document</a>
+</li>
+<li>
+<a href="#Collection+Path+Referencing+a+remote+Document">Collection Path Referencing a remote Document</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Introducing+the+Command+Line+Tools">Introducing the Command Line Tools</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Managing+Documents">Managing Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#Adding+Documents">Adding Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Adding+a+Document+With+a+Given+Key">Adding a Document With a Given Key</a>
+</li>
+<li>
+<a href="#Adding+a+Document+Without+a+Key">Adding a Document Without a Key</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Retrieving+Documents">Retrieving Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Retrieving+a+Document+Using+an+ID">Retrieving a Document Using an ID</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Deleting+Documents">Deleting Documents</a>
+<ul class="minitoc">
+<li>
+<a href="#Deleting+a+document+using+an+ID">Deleting a document using an ID</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Querying+the+Database">Querying the Database</a>
+<ul class="minitoc">
+<li>
+<a href="#Executing+an+XPath+query+against+a+collection+of+XML+documents">Executing an XPath query against a collection of XML documents</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+      
+<div class="note">
+<div class="label">Note</div>
+<div class="content">
+        If you notice incorrectness in this documentation, please
+        <a href="../mail.html">notify</a> Xindice community. Your feedback
+        will help create better documentation.
+      </div>
+</div>
+
+      
+<a name="N10024"></a><a name="Getting+Started+with+Xindice"></a>
+<h2 class="h3">Getting Started with Xindice</h2>
+<div class="section">
+<a name="N1002A"></a><a name="Introduction+to+XML+Databases"></a>
+<h3 class="h4">Introduction to XML Databases</h3>
+<a name="N1002F"></a><a name="Apache+Xindice"></a>
+<h3 class="h4">Apache Xindice</h3>
+</div>
+
+      
+<a name="N10035"></a><a name="Introduction+to+Xindice"></a>
+<h2 class="h3">Introduction to Xindice</h2>
+<div class="section">
+<a name="N1003B"></a><a name="What+Is+Xindice"></a>
+<h3 class="h4">What Is Xindice</h3>
+<p>
+               The Xindice Core server is a database server designed from the
+               ground up to store XML data. The
+               Xindice server is what is termed by
+               the
+               <a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+               as a Native XML Database. You could also refer to it as a
+               seamless XML database which might be an easier to understand
+               description.
+            </p>
+<p>
+               What this means is that to the largest extent possible you work
+               with XML tools and technologies when working with the data in the
+               server. All data that goes into and out of the server is XML. The
+               query language used is XPath and the programming APIs support DOM
+               and SAX. All things that should be familiar to a developer used
+               to using XML in their applications. When working with XML data and
+               Xindice there is no mapping between different data models. You simply
+               design your data as XML and store it as XML.
+            </p>
+<p>
+               What this gives you can be summed up in one word, flexibility. XML
+               provides an extremely flexible mechanism for modeling application
+               data and in many cases will allow you to model constructs that are
+               difficult or impossible to model in more traditional systems. This
+               model is a semi-structured model and for some applications it is
+               an essential component. By
+               using a native XML database such as Xindice to store this data you can
+               focus on building your applications and not worry about how the
+               complex XML construct maps to the underlying data store or trying
+               force a flexible data model into a rigid set of schema constraints.
+            </p>
+<p>
+               Ultimately though, Xindice is a tool. It will be right for some jobs
+               and completely wrong for others. The job it is best at is simply
+               storing XML data. In fact, that's all it does. If you have lots of
+               XML data then Xindice may just be the right tool. However, if your
+               data isn't XML or if you have the need for precise control over
+               the structure of the data you might be better off using another
+               database solution.
+            </p>
+<a name="N10052"></a><a name="Current+Status"></a>
+<h3 class="h4">Current Status</h3>
+<p>
+               Native XML database technology is a very new area and Xindice is very
+               much a project still in development.
+               The server currently supports storing well formed XML documents.
+               This means it does not have any schema that constrains what
+               can be placed into a document collection. This makes Xindice a
+               semi-structured database and provides tremendous
+               flexiblity in how you store your data, but, also means you give up
+               some common database functionality such as data
+               types.
+               In its current state Xindice is already a powerful tool for managing
+               XML data. However, there is still much that needs to be done.
+               Feedback and contributions are actively encouraged.
+            </p>
+<p>
+               This document attempts to
+               describe those features that are working and can be used today.
+               You should review the README file that is part of the Xindice
+               distribution for the most current status on the project.
+            </p>
+<a name="N1005F"></a><a name="Feature+Summary"></a>
+<h3 class="h4">Feature Summary</h3>
+<p>
+               
+<strong>Document Collections</strong>: Documents are stored in
+               collections that can be queried as a whole. You can create
+               collections that contain just documents of the same type or you
+               can create a collection to store all your documents together.
+               The database doesn't care.
+            </p>
+<p>
+               
+<strong>XPath Query Engine</strong>: To query the Document
+               Collections you use <a href="http://www.w3.org/TR/xpath">XPath</a>
+               as defined by the W3C. This provides a reasonably flexible mechanism
+               for querying documents by navigating and restricting the result tree
+               that is returned.
+            </p>
+<p>
+               
+<strong>XML Indexing</strong>: In order to improve the performance
+               of queries over large numbers of documents you can define indexes on
+               element and attribute values. This can dramatically speed up query
+               response time.
+            </p>
+<p>
+               
+<strong>XML:DB XUpdate Implementation</strong>: When you store XML
+               in the database you may want to be able to change that data without
+               retrieving the entire document. XUpdate is the mechanism to use when
+               you want to do server side updates of the data. It is an XML based
+               language for specifying XML modifications and allows those modifications
+               to be applied to entire document collections as well as single documents.
+            </p>
+<p>
+               
+<strong>Java XML:DB API Implementation</strong>: For Java programmers
+               Xindice provides an implementation of the XML:DB API. This API is
+               intended to bring portability to XML database applications just as
+               JDBC has done for relational databases. Most applications developed
+               for Xindice will use the XML:DB API.
+            </p>
+<p>
+               
+<strong>Command Line Management Tools</strong>: To aid the administrator
+               Xindice provides a full suite of command line driven management tools.
+               Just about everything you can do through the XML:DB API can also be
+               done from the command line.
+            </p>
+<p>
+               
+<strong>Modular Architecture</strong>: The Xindice server is
+               constructed in a very modular manner. This makes it easy to add and
+               remove components to tailor the server to a particular environment or
+               to embed it into another application.
+            </p>
+<a name="N10096"></a><a name="Database+Structure"></a>
+<h3 class="h4">Database Structure</h3>
+<p>
+               The Xindice server is designed to store collections of XML documents.
+               Collections can be arranged in a hierarchy similar to that of a
+               typical UNIX or Windows file system.
+            </p>
+<p>
+               In Xindice the data store is rooted in a database instance that can
+               also be used as a document collection. This
+               database instance can then contain any number of child collections.
+               In a default install of Xindice the database instance is called
+               'db' and all collection paths will begin with /db. It is possible to
+               rename the database instance if desired though it is not necessary
+               to do so.
+            </p>
+<p>
+               Collections are referenced in a similar manner to how you
+               would work with a hierarchical file system.
+            </p>
+<a name="N100A5"></a><a name="Collection+Path+Example"></a>
+<h4>Collection Path Example</h4>
+<p>
+                  If you had a collection
+                  created under 'db' called my-collection and a collection under
+                  that called my-child-collection the path used when accessing the
+                  my-child-collection collection would be
+               </p>
+<pre class="code">
+  /db/my-collection/my-child-collection
+                  </pre>
+<p>
+               Within collections there are several types of objects that can be
+               stored. You can store XML documents, XMLObjects and other
+               collections. Each of these objects can also be referenced via a
+               path.</p>
+<a name="N100B6"></a><a name="Collection+Path+Referencing+a+Document"></a>
+<h4>Collection Path Referencing a Document</h4>
+<p>
+                  Extending the previous example by adding a document to
+                  my-child-collection named my-document it to could be
+                  referenced via a path.
+               </p>
+<pre class="code">
+  /db/my-collection/my-child-collection/my-document
+                  </pre>
+<p>
+               There is one catch to this however. Since you can have more then one
+               object in a collection with the same name
+               there is an order of precedence that is applied when evaluating a
+               path. The order of precendence is collection followed by XMLObject
+               and then document. What this means is that if you have a document
+               and a collection with the same name you will not be able to retrieve
+               the document.
+            </p>
+<p>
+               You can also access collections on remote machines by specifying the host
+               and port of the server.
+            </p>
+<a name="N100CA"></a><a name="Collection+Path+Referencing+a+remote+Document"></a>
+<h4>Collection Path Referencing a remote Document</h4>
+<p>
+                  If the previous example was on a remote machine the path would look
+                  something like this.
+               </p>
+<pre class="code">
+  myhost.domain.com:8080/db/my-collection/my-child-collection/my-document
+                  </pre>
+<p>
+                  This can also take the form of a Xindice URI.
+               </p>
+<pre class="code">
+  xindice://myhost.domain.com:8080/db/my-collection/my-child-collection/my-document
+                  </pre>
+<a name="N100E0"></a><a name="Introducing+the+Command+Line+Tools"></a>
+<h3 class="h4">Introducing the Command Line Tools</h3>
+<p>
+               The Xindice server includes a command line program named
+               <span class="codefrag">xindice</span> that allows you to manage the
+               data stored in the server.
+               A complete list of available commands and more
+               detail about each command can be found in the
+               <a href="guide-tools.html">Command Line Tools Reference Guide</a>.
+            </p>
+<p>
+               The
+               <span class="codefrag">xindice</span> tool is located in the
+               Xindice-Core/bin directory and it is
+               probably a good idea to add this directory to your PATH environment
+               variable. All examples in this manual will assume that the
+               Xindice-Core/bin directory is on the operating system path.
+            </p>
+</div>
+      
+<a name="N100F8"></a><a name="Managing+Documents"></a>
+<h2 class="h3">Managing Documents</h2>
+<div class="section">
+<a name="N100FE"></a><a name="Introduction"></a>
+<h3 class="h4">Introduction</h3>
+<p>
+               In many ways the Xindice database can be viewed as a simple file
+               store. This is of course a highly simplified view of things but
+               is a useful place to get started in learning the functionality of
+               the server.
+            </p>
+<p>
+               The Xindice server provides facilities to store, retrieve and
+               delete well formed XML documents.
+            </p>
+<a name="N1010B"></a><a name="Adding+Documents"></a>
+<h3 class="h4">Adding Documents</h3>
+<p></p>
+<a name="N10113"></a><a name="Adding+a+Document+With+a+Given+Key"></a>
+<h4>Adding a Document With a Given Key</h4>
+<p>
+                  The document fx102.xml will be added to the collection
+                  /db/data/products and will be stored under the key fx102.
+               </p>
+<pre class="code">
+  xindice add_document -c /db/data/products -f fx102.xml -n fx102
+                  </pre>
+<a name="N10121"></a><a name="Adding+a+Document+Without+a+Key"></a>
+<h4>Adding a Document Without a Key</h4>
+<p>
+                  The document fx102.xml will be added to the collection
+                  /db/data/products. No key is provided so one will be generated
+                  automatically by the server. The generated key will look similar
+                  to this 0625df6b0001a5d4000bc49d0060b6f5
+               </p>
+<pre class="code">
+  xindice add_document -c /db/data/products -f fx102.xml
+                  </pre>
+<a name="N10130"></a><a name="Retrieving+Documents"></a>
+<h3 class="h4">Retrieving Documents</h3>
+<p>
+               Documents can be retrieved from the database using the ID that
+               they were inserted under.
+            </p>
+<a name="N10139"></a><a name="Retrieving+a+Document+Using+an+ID"></a>
+<h4>Retrieving a Document Using an ID</h4>
+<p>
+                  The document identified by the key fx102 will be retrieved from
+                  the /db/data/products collection and stored in the file fx102.xml
+               </p>
+<pre class="code">
+  xindice retrieve_document -c /db/data/products -n fx102 -f fx102.xml
+                  </pre>
+<a name="N10148"></a><a name="Deleting+Documents"></a>
+<h3 class="h4">Deleting Documents</h3>
+<p></p>
+<a name="N10150"></a><a name="Deleting+a+document+using+an+ID"></a>
+<h4>Deleting a document using an ID</h4>
+<p>
+                  The document identified by the key fx102 will be removed from the
+                  collection /db/data/products.
+               </p>
+<pre class="code">
+  xindice delete_document -c /db/data/products -n fx102
+                  </pre>
+</div>
+      
+<a name="N10160"></a><a name="Querying+the+Database"></a>
+<h2 class="h3">Querying the Database</h2>
+<div class="section">
+<p>
+            Xindice currently supports XPath as a query language. In many
+            applications XPath is only applied at the document level but in
+            Xindice XPath queries can be executed at either the document level
+            or the collection level. This
+            means that a query can be run against multiple documents and the
+            result set will contain all matching nodes from all documents
+            in the collection.
+            The Xindice server also supports the creation of indexes on
+            XML documents to speed up commonly used XPath queries. Please refer
+            to the
+            <a href="guide-administrator.html">Administrators
+               Guide</a> for more detail about configuring indexes.
+         </p>
+<p>
+            You can execute XPath queries against the database using the command
+            line tools and the result of the query will be displayed.
+         </p>
+<a name="N10170"></a><a name="Executing+an+XPath+query+against+a+collection+of+XML+documents"></a>
+<h3 class="h4">Executing an XPath query against a collection of XML documents</h3>
+<p>
+               Here we assume we have a collection /db/data/products that contains
+               documents that are similar to the following.
+            </p>
+<pre class="code">
+  &lt;?xml version="1.0"?&gt;
+  &lt;product product_id="120320"&gt;
+    &lt;description&gt;Glazed Ham&lt;/description&gt;
+  &lt;/product&gt;
+            </pre>
+<p>
+               The XPath /product[@product_id="120320"] will be executed against
+               the collection /db/data/products and all matching product entries
+               will be returned.
+            </p>
+<pre class="code">
+  xindice xpath_query -c /db/data/products -q "/product[@product_id='120320']"
+            </pre>
+<p>
+               The result of the query is an XPath node-set that contains one
+               node for each result. In this particular example there is only
+               one result and the node that matches is the root element so you
+               get back basically the whole document.
+            </p>
+<p>
+               To make it easy to link the result node back to the originating
+               document, Xindice adds a few attributes to the result. These attributes
+               are added in the Query namespace that has the URI
+               <span class="codefrag">http://xml.apache.org/xindice/Query</span>. The
+               <span class="codefrag">col</span> attribute specifies the collection where the document
+               can be found and the <span class="codefrag">key</span> attribute
+               provides the key of the original document. Using this information it
+               is possible to retrieve the original document that this node was
+               selected from for further processing.
+            </p>
+<pre class="code">
+  &lt;product product_id="120320"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120320"&gt;
+    &lt;description&gt;Glazed Ham&lt;/description&gt;
+  &lt;/product&gt;
+            </pre>
+<p>
+               If more then one result is found the results look something like
+               this. This could be the result of the query /product
+            </p>
+<pre class="code">
+  &lt;product product_id="120320"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120320"&gt;
+    &lt;description&gt;Glazed Ham&lt;/description&gt;
+  &lt;/product&gt;
+  &lt;product product_id="120321"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120321"&gt;
+    &lt;description&gt;Boiled Ham&lt;/description&gt;
+  &lt;/product&gt;
+  &lt;product product_id="120322"
+           xmlns:src="http://xml.apache.org/xindice/Query"
+           src:col="/db/data/products" src:key="120322"&gt;
+    &lt;description&gt;Honey Ham&lt;/description&gt;
+  &lt;/product&gt;
+            </pre>
+<p>
+            While it is certainly useful to be able to query from the command
+            line it is  probably more useful to be able to use the results of a
+            query in an application. For more information on building
+            applications for Xindice, please refer to the
+            <a href="guide-developer.html">Developers Guide</a>.
+         </p>
+</div>
+
+      <!--
+         <section>
+            <title>XMLDB Error codes</title>
+            <p>
+               public static final int UNKNOWN_ERROR = 0;
+               public static final int VENDOR_ERROR = 1;
+               public static final int NOT_IMPLEMENTED = 2;
+               public static final int WRONG_CONTENT_TYPE = 3;
+               public static final int PERMISSION_DENIED = 4;
+               public static final int INVALID_URI = 5;
+               public static final int NO_SUCH_SERVICE = 100;
+               public static final int NO_SUCH_COLLECTION = 200;
+               public static final int INVALID_COLLECTION = 201;
+               public static final int COLLECTION_CLOSED = 202;
+               public static final int NO_SUCH_RESOURCE = 300;
+               public static final int INVALID_RESOURCE = 301;
+               public static final int UNKNOWN_RESOURCE_TYPE = 302;
+               public static final int NO_SUCH_DATABASE = 400;
+               public static final int INVALID_DATABASE = 401;
+            </p>
+         </section>
+      -->
+   
+<p align="right">
+<font size="-2">by&nbsp;Kimbro Staken</font>
+</p>
+<span class="version">
+          version 598114</span>
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2001-2007 The Apache Software Foundation.</div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Propchange: xml/site/targets/xindice/1.1/guide-user.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: xml/site/targets/xindice/1.1/guide-user.html
------------------------------------------------------------------------------
    svn:keywords = Id Revision Author Date

Added: xml/site/targets/xindice/1.1/guide-user.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/guide-user.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.

Propchange: xml/site/targets/xindice/1.1/guide-user.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf



---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org


Mime
View raw message