You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general-cvs@xml.apache.org by vg...@apache.org on 2007/12/08 03:01:42 UTC
svn commit: r602294 [7/10] - in /xml/site/targets/xindice: ./ 1.0/ 1.1/
1.1/howto/ 1.2/ 1.2/howto/ dev/ skin/ skin/images/
Added: xml/site/targets/xindice/1.2/guide-tools.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-tools.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.2/guide-tools.html (added)
+++ xml/site/targets/xindice/1.2/guide-tools.html Fri Dec 7 18:01:36 2007
@@ -0,0 +1,2203 @@
+<!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.2 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> > <a href="http://xml.apache.org/">xml.apache</a> > <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">
+ <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>
+<a class="unselected" href="../1.1/index.html">1.1</a>
+</li>
+<li class="current">
+<a class="selected" 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">
+
+
+ </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.2/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.2/guide-administrator.html">Administrator Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.2/guide-user.html">User Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.2/guide-developer.html">Developer Guide</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Tool Guide</div>
+</div>
+<div class="menuitem">
+<a href="../1.2/guide-xpath.html">XPath Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.2/faq.html">FAQ</a>
+</div>
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="../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.2/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.2/howto/compilation-unix.html">Unix</a>
+</div>
+<div class="menuitem">
+<a href="../1.2/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.2/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.2/howto/upgrading-one-one.html">From 1.1b1 and up</a>
+</div>
+<div class="menuitem">
+<a href="../1.2/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.2 Commandline Tool Guide</h1>
+<div class="abstract"></div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#General+Information">General Information</a>
+<ul class="minitoc">
+<li>
+<a href="#Collection+context">Collection context</a>
+</li>
+<li>
+<a href="#Common+parameters">Common parameters</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Collection+Management+Commands">Collection Management Commands</a>
+<ul class="minitoc">
+<li>
+<a href="#Adding+a+Collection">Adding a Collection</a>
+</li>
+<li>
+<a href="#Deleting+a+Collection">Deleting a Collection</a>
+</li>
+<li>
+<a href="#List+Collections">List Collections</a>
+</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>
+</li>
+<li>
+<a href="#Adding+a+Binary+Resource">Adding a Binary Resource</a>
+</li>
+<li>
+<a href="#Adding+Multiple+Documents">Adding Multiple Documents</a>
+</li>
+<li>
+<a href="#Deleting+a+Document">Deleting a Document</a>
+</li>
+<li>
+<a href="#Retrieving+a+Document">Retrieving a Document</a>
+</li>
+<li>
+<a href="#List+Resources">List Resources</a>
+</li>
+<li>
+<a href="#Importing+a+Directory+Tree">Importing a Directory Tree</a>
+</li>
+<li>
+<a href="#Exporting+a+Directory+Tree">Exporting a Directory Tree</a>
+</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>
+</li>
+<li>
+<a href="#Deleting+a+Collection+Indexer">Deleting a Collection Indexer</a>
+</li>
+<li>
+<a href="#Listing+Collection+Indexers">Listing Collection Indexers</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Quering+a+Collection">Quering a Collection</a>
+<ul class="minitoc">
+<li>
+<a href="#Xpath+Query">Xpath Query</a>
+</li>
+<li>
+<a href="#XUpdate+Query">XUpdate Query</a>
+</li>
+<li>
+<a href="#Full+Text+Query">Full Text Query</a>
+</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>
+</li>
+<li>
+<a href="#Accessing+Help">Accessing Help</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 to create better documentation.
+ </div>
+</div>
+
+
+<a name="N10029"></a><a name="General+Information"></a>
+<h2 class="h3">General Information</h2>
+<div class="section">
+<a name="N1002F"></a><a name="Collection+context"></a>
+<h3 class="h4">Collection context</h3>
+<p>
+ Collection context refers to a collection location. It can be either
+ collection canonical name or complete XML:DB URL. The collection
+ context points to must already exist.
+ </p>
+<p>
+ Collection canonical name starts with '/', then has a database name
+ and the collection path. So, a collection 'foo' under a collection
+ 'bar' in database 'db' will have canonical name /db/bar/foo.
+ Canonical names are used for convenience and are converted to complete
+ URLs by the command tool.
+ </p>
+<p>
+ Complete URL has the following format:
+ <span class="codefrag">xmldb:<driver_protocol>://<host>:<port><path></span>,
+ where
+ </p>
+<dl>
+
+<dt>
+<span class="codefrag">driver_protocol</span>
+</dt>
+
+<dd>
+ Either <span class="codefrag">xindice</span> (XML-RPC driver) or <span class="codefrag">xindice-embed</span>
+ (embedded driver). Driver choice depends on whether or not -l switch was
+ specified.
+ </dd>
+
+<dt>
+<span class="codefrag">host</span> and <span class="codefrag">port</span>
+</dt>
+
+<dd>
+ Host name or IP address and port number where Xindice server is running.
+ This information only is used for XML-RPC driver, it can be present in
+ URL when embedded driver is used, but will be ignored, so usually it is
+ omitted. For XML-RPC, host name and port number can be omitted, too, then
+ default address 127.0.0.1:8888 is used.
+ </dd>
+
+<dt>
+<span class="codefrag">path</span>
+</dt>
+
+<dd>
+ Collection canonical name
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<pre class="code">
+ xmldb:xindice://10.1.1.1:8889/db1/col1/col2</pre>
+<p>
+ Context points to a collection col2, which is a child of the collection col1,
+ located in database db1 that is available on Xindice server running on host
+ 10.1.1.1 with port number 8889. To communicate with the server, XML-RPC
+ protocol will be used.
+ </p>
+<pre class="code">
+ xmldb:xindice-embed:///db1/col1/col2</pre>
+<p>
+ Context points to a collection col2, which is a child of the collection col1,
+ located in database db1 that is available on embedded Xindice instance.
+ Command tool will use embedded driver.
+ </p>
+<pre class="code">
+ /db1/col1/col2</pre>
+<p>
+ If -l switch was specified, this canonical name will be converted to
+ <span class="codefrag">xmldb:xindice-embed:///db1/col1/col2</span>. Otherwise, the result
+ will be <span class="codefrag">xmldb:xindice:///db1/col1/col2</span> (please note, that
+ the default target address 127.0.0.1:8888 will be used).
+ </p>
+<a name="N10082"></a><a name="Common+parameters"></a>
+<h3 class="h4">Common parameters</h3>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context that points to Xindice collection under
+ which the action will be executed. The context can be either
+ canonical name of the collection or complete XML:DB URL. The
+ collection context points to must already exist.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network. This is done
+ by using different driver to access database, embedded driver will
+ be used instead of XML-RPC. This parameter should be combined with
+ -d to specify system configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <file path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified. If this parameter is
+ omitted, Xindice will look for system property "xindice.configuration",
+ which can be set by setting environment variable XINDICE_CONFIG or
+ by specifying it as the -D parameter for java command, which is
+ what usually xindice command does itself.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+<dt>
+<span class="codefrag">-h</span>
+</dt>
+
+<dd>
+ Print help screen for an action.
+ </dd>
+
+</dl>
+</div>
+
+<a name="N100B0"></a><a name="Collection+Management+Commands"></a>
+<h2 class="h3">Collection Management Commands</h2>
+<div class="section">
+<a name="N100B6"></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>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice add_collection -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">ac</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ Name for the collection to be created, must be present unless
+ collection configuration is specified. It can also be a collection
+ path rather than a name, in that case all parent collections must
+ already exist.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <file></span>
+</dt>
+
+<dd>
+ Name of the file that holds collection configuration. If specified,
+ the rest of command-specific parameters (like collection name) are
+ ignored. A configuration may include child collections or indexers,
+ all of them will be created at the same time as well.
+ </dd>
+
+<dt>
+<span class="codefrag">--filer <name></span>
+</dt>
+
+<dd>
+ Collection filer, can be HashFiler or BTreeFiler (default:
+ BTreeFiler). A filer defines which data structure is going to be used
+ for storing information. HashFiler generally is more suitable for
+ collections that are not expected to grow significantly.
+ </dd>
+
+<dt>
+<span class="codefrag">--pagesize <number></span>
+</dt>
+
+<dd>
+ Page size for file pages (default: 4096 bytes).
+ </dd>
+
+<dt>
+<span class="codefrag">--pagecount <number></span>
+</dt>
+
+<dd>
+ Initial number of pages in the primary storage (default: 1024).
+ <ul>
+
+<li>
+ BTreeFiler: number of pages filer will be created with. This
+ number can grow as more and more documents are added to the collection
+ </li>
+
+<li>
+ HashFiler: the size of the hash table main storage. Main storage
+ size is constant. If main storage is at its capacity, documents
+ are stored in overflow storage, affecting efficiency of the hash
+ table
+ </li>
+
+</ul>
+
+</dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Create a top level collection pebbles in database db. Collection will use
+ BTreeFiler with default values for page count and page size.</p>
+<pre class="code">
+ xindice add_collection -c /db -n pebbles
+ </pre>
+<p>Create a child collection boulder in collection pebbles.</p>
+<pre class="code">
+ xindice add_collection -c /db/pebbles -n boulder
+ </pre>
+<p>Create a child collection stone in collection boulder.</p>
+<pre class="code">
+ xindice add_collection -c /db/pebbles -n boulder/stone
+ </pre>
+<p>Create a child collection sand in collection pebbles that uses
+ HashFiler with page size equal to 1024 bytes and the size of the hash table main
+ storage equals to 2048.</p>
+<pre class="code">
+ xindice add_collection -c /db/pebbles -n sand --filer HashFiler --pagesize 1024 --pagecount 2048
+ </pre>
+<p>Create a child collection in collection pebbles with the configuration specified
+ in the file /tmp/collections/config.xml. If collection configuration contains
+ any child collections or indexers, they will be created as well.</p>
+<pre class="code">
+ xindice add_collection -c /db/pebbles -f /tmp/collections/config.xml
+ </pre>
+<a name="N10146"></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, indexers and/or documents
+ they will also be deleted.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice delete_collection -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">dc</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ Name of the collection to delete. Required. It can also be a collection
+ path rather than a name.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Delete a top level collection pebbles and all its subcollections,
+ indexers and documents.</p>
+<pre class="code">
+ xindice delete_collection -c /db -n pebbles
+ </pre>
+<p>Delete a child collection boulder from collection pebbles and
+ all its subcollections, indexers and documents.</p>
+<pre class="code">
+ xindice delete_collection -c /db/pebbles -n boulder
+ </pre>
+<p>Delete a child collection stone from collection boulder. Collection
+ boulder is not affected.</p>
+<pre class="code">
+ xindice delete_collection -c /db/pebbles -n boulder/stone
+ </pre>
+<a name="N101A3"></a><a name="List+Collections"></a>
+<h3 class="h4">List Collections</h3>
+<p>
+ List all child collections under the given collection context.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice list_collections -c <context> [-l [-d <path>]] [-v]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">lc</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>List the top level collections in database db.</p>
+<pre class="code">
+ xindice list_collections -c /db
+ </pre>
+<p>List child collections of collection pebbles.</p>
+<pre class="code">
+ xindice list_collections -c /db/pebbles
+ </pre>
+</div>
+
+
+<a name="N101F3"></a><a name="Document+Management+Commands"></a>
+<h2 class="h3">Document Management Commands</h2>
+<div class="section">
+<a name="N101F9"></a><a name="Adding+a+Document"></a>
+<h3 class="h4">Adding a Document</h3>
+<p>
+ Adds a document to a collection. Adding a document requires the file
+ path to the document. If a document key is not provided an auto-generated
+ system key will be used for the document. When entering the file path be
+ sure to include the path and file extension.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice add_document -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">ad</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <file></span>
+</dt>
+
+<dd>
+ File path for the file with the document being added to the
+ collection. Required. File content must be a well-formed XML
+ document.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <key></span>
+</dt>
+
+<dd>
+ Key assigned to the document key. If this parameter is omitted,
+ database will generate an unique key and assign it to the document.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Add a document to the collection pebbles with a key "stones".</p>
+<pre class="code">
+ xindice add_document -c /db/pebbles -f /tmp/stones.xml -n stones
+ </pre>
+<p>Add a document to the collection boulder with an automatically generated key.</p>
+<pre class="code">
+ xindice add_document -c /db/pebbles/boulder -f /tmp/bookmarks.xml
+ </pre>
+<a name="N10256"></a><a name="Adding+a+Binary+Resource"></a>
+<h3 class="h4">Adding a Binary Resource</h3>
+<p>
+ Adds a binary resource a collection, if support of binary resources
+ has been turned on for the collection. If a resource key is not
+ provided an auto-generated system key will be used for the resource.
+ When entering the file path be sure to include the path and file
+ extension.
+ </p>
+<p>
+ The resource may or may not be XML document. Even if resouce
+ is XML document, it cannot be indexed, cannot be quieried with XPath
+ or modified with XUpdate.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice add_resource -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">ar</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <file path></span>
+</dt>
+
+<dd>
+ File path for the resource being added to the collection. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <key></span>
+</dt>
+
+<dd>
+ Key assigned to the resource. If this parameter is omitted,
+ database will generate an unique key and assign it to the resource.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Add a resource to a collection pebbles with a key "stones".</p>
+<pre class="code">
+ xindice add_document -c /db/pebbles -f /tmp/stones.jpg -n stones
+ </pre>
+<p>Add a resource to the collection boulder with an automatically generated key.</p>
+<pre class="code">
+ xindice add_resource -c /db/pebbles/boulder -f /tmp/bookmarks.html
+ </pre>
+<a name="N102B6"></a><a name="Adding+Multiple+Documents"></a>
+<h3 class="h4">Adding Multiple Documents</h3>
+<p>
+ Adds multiple documents to a collection. This command requires
+ the argument pointing to the directory path that contains documents,
+ which are going to be stored in the collection specified by
+ collection context. The collection must already exist. Documents
+ added will be assigned their file name as the document key. The
+ optional "extension" parameter can be used to only import documents
+ with a certain file extension.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice add_multiple_documents -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">addmultiple</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <path></span>
+</dt>
+
+<dd>
+ Directory name to import documents from. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-e <extention></span>
+</dt>
+
+<dd>
+ The file extention that files must have in order to be added to the
+ collection.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Add all files from directory /tmp/mydocs to the collection pebbles.</p>
+<pre class="code">
+ xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs
+ </pre>
+<p>Add all files from directory /tmp/mydocs that have an extension ".xml" to
+ the collection pebbles.</p>
+<pre class="code">
+ xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs -e xml
+ </pre>
+<a name="N10313"></a><a name="Deleting+a+Document"></a>
+<h3 class="h4">Deleting a Document</h3>
+<p>
+ Deletes an existing document from a collection.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice delete_document -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">dd</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ The key of the document to be deleted. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Delete a document with the key "stones" from the collection pebbles.</p>
+<pre class="code">
+ xindice delete_document -c /db/pebbles -n stones
+ </pre>
+<a name="N10362"></a><a name="Retrieving+a+Document"></a>
+<h3 class="h4">Retrieving a Document</h3>
+<p>
+ Retrieves an existing document from a collection and stores it in
+ the file. If the path passed in does not exist, it will be created.
+ If the file specified by path argument already exists, it will be
+ overwritten.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice retrieve_document -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">rd</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ The key of the document to be retrieved. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <file></span>
+</dt>
+
+<dd>
+ The file path to store the document under. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Retrieve a document with the key "stones" from the collection pebbles
+ and save it in the file /tmp/stones.xml.</p>
+<pre class="code">
+ xindice retrieve_document -c /db/pebbles -n stones -f /tmp/stones.xml
+ </pre>
+<a name="N103B8"></a><a name="List+Resources"></a>
+<h3 class="h4">List Resources</h3>
+<p>
+ List all resource keys under the given collection context.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice list_documents -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">ld</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>List all documents in the collection pebbles.</p>
+<pre class="code">
+ xindice list_documents -c /db/pebbles
+ </pre>
+<a name="N10400"></a><a name="Importing+a+Directory+Tree"></a>
+<h3 class="h4">Importing a Directory Tree</h3>
+<p>
+ Adds multiple documents into a collection, copying the directory
+ structure into the database as collections. This command takes a
+ directory and creates a collection with the same name. Directories
+ under the directory will also be created as child 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.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice import -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <path></span>
+</dt>
+
+<dd>
+ The path to a directory to be imported as a collection. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-e <extention></span>
+</dt>
+
+<dd>
+ The file extention that files must have in order to be added to the
+ collection.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Import all directories and documents to the collection pebbles, starting
+ with directory /tmp/flintstones.</p>
+<pre class="code">
+ xindice import -c /db/pebbles -f /tmp/flintstones
+ </pre>
+<p>Import all directories and documents with an extension of ".xml" to the
+ collection pebbles, starting with directory /tmp/flintstones.</p>
+<pre class="code">
+ xindice import -c /db/pebbles -f /tmp/flintstones -e xml
+ </pre>
+<a name="N10457"></a><a name="Exporting+a+Directory+Tree"></a>
+<h3 class="h4">Exporting a Directory Tree</h3>
+<p>
+ Creates an directory tree from a collection and its subcollections.
+ The directory tree will be created starting at the directory passed
+ in as an argument. That directory must exist already. The collection
+ documents will be converted to files with the keys used as file names.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice export -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <path></span>
+</dt>
+
+<dd>
+ The path to a directory where collection structure will be created.
+ The directory must already exist. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Creating a directory tree indentical to a collection pebbles tree in
+ directory /tmp/export</p>
+<pre class="code">
+ xindice export -c /db/pebbles -f /tmp/export
+ </pre>
+</div>
+
+
+<a name="N104A1"></a><a name="Collection+Indexer+Actions"></a>
+<h2 class="h3">Collection Indexer Actions</h2>
+<div class="section">
+<a name="N104A7"></a><a name="Adding+a+Collection+Indexer"></a>
+<h3 class="h4">Adding a Collection Indexer</h3>
+<p>
+ Adds a new collection index. In order to add the collection index,
+ the collection it is being added to must already exist. This command
+ has optional parameters for setting the index page size, index page
+ count, and the index data type.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice add_indexer -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">ai</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ The name of the indexer. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-p <pattern></span>
+</dt>
+
+<dd>
+ The pattern used to create the index. Required, unless indexer configuration
+ is specified. Name and Value indexers can only have one pattern,
+ which is going to follow the -p switch. Full text indexer can have multiple
+ patterns and its syntax is different, -p switch is followed by semicolon
+ delimited list of patterns for indexer in the form pattern=alias.
+ </dd>
+
+<dt>
+<span class="codefrag">-t <type></span>
+</dt>
+
+<dd>
+ The data type/index type.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <file></span>
+</dt>
+
+<dd>
+ Name of the file that holds indexer configuration. If specified,
+ the rest of command-specific parameters (like indexer name) are
+ ignored.
+ </dd>
+
+<dt>
+<span class="codefrag">--pagesize <pagesize></span>
+</dt>
+
+<dd>
+ Page size for file pages (default: 4096). Does not apply to
+ LuceneIndexer.
+ </dd>
+
+<dt>
+<span class="codefrag">--pagecount <pagecount></span>
+</dt>
+
+<dd>
+ Number of pages in the primary storage (default: 1024). Does
+ not apply to LuceneIndexer.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>Possible values of index type are:</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">What is indexed</th><th colspan="1" rowspan="1">Indexer type</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">string</td><td colspan="1" rowspan="1">Non-normalized string value</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">trimmed</td><td colspan="1" rowspan="1">Normalized (whitespace stripped) string value</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">short</td><td colspan="1" rowspan="1">16-bit signed short integer</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">int</td><td colspan="1" rowspan="1">32-bit signed integer</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">long</td><td colspan="1" rowspan="1">64-bit signed integer</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">float</td><td colspan="1" rowspan="1">32-bit floating point value</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">double</td><td colspan="1" rowspan="1">64-bit floating point value (XPath number)</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">byte</td><td colspan="1" rowspan="1">8-bit signed byte</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">char</td><td colspan="1" rowspan="1">16-bit signed character</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">boolean</td><td colspan="1" rowspan="1">8-bit boolean value</td><td colspan="1" rowspan="1">ValueIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">name</td><td colspan="1" rowspan="1">Presence of the pattern in a document</td><td colspan="1" rowspan="1">NameIndexer</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">text</td><td colspan="1" rowspan="1">Pattern text content</td><td colspan="1" rowspan="1">LuceneIndexer</td>
+
+</tr>
+
+</table>
+<p>
+ By default type will be "string" for element pattern or "trimmed"
+ for attribute pattern.
+ </p>
+<p>
+<strong>Examples</strong>
+</p>
+<p>
+ Create a Value indexer named "rockindex" in the pebbles collection and
+ index value of a "rock" element as a string.
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/pebbles -n rockindex -p rock
+ </pre>
+<p>
+ Create a Value indexer with name "hardindex" in the boulder collection
+ for documents containing a rock elements with an attribute of "hard" and
+ index value of an attribute "hard" of the "rock" element as normalized
+ string.
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/pebbles/boulder -n hardindex -p rock@hard
+ </pre>
+<p>
+ Create a Value indexer named "weight" in the pebbles collection and index
+ value of an attribute "weight" of the "rock" element as a floating point
+ value.
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/pebbles -n weight -p rock@weight -t float
+ </pre>
+<p>
+ Create a Name indexer named "type" in the pebbles collection and index
+ document keys of the documents that contain "rock" elements with an
+ attribute of "type".
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/pebbles -n type -p rock@type -t name
+ </pre>
+<p>
+ Create a Lucene indexer named "text" in the pebbles collection and index
+ text content of element "origin" (with alias "origin") and text of attribute
+ "donatedby" of the element "location" (with alias "donated").
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/pebbles -n text -p origin=origin;location@donatedby=donated -t text
+ </pre>
+<a name="N1060E"></a><a name="Deleting+a+Collection+Indexer"></a>
+<h3 class="h4">Deleting a Collection Indexer</h3>
+<p>
+ Deletes a collection index referred by the name. Deleting an index
+ does not affect collection and its documents.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice delete_indexer -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">di</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ The name of the indexer being deleted. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Delete index with name "hardindex" in the pebbles collection.</p>
+<pre class="code">
+ xindice delete_indexer -c /db/pebbles -n hardindex
+ </pre>
+<a name="N1065D"></a><a name="Listing+Collection+Indexers"></a>
+<h3 class="h4">Listing Collection Indexers</h3>
+<p>
+ Lists all indexers of a collection.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice list_indexers -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+ Command name abbreviation: <span class="codefrag">li</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>To list all collection indexes in the pebbles collection </p>
+<pre class="code">
+ xindice list_indexers -c /db/pebbles
+ </pre>
+</div>
+
+
+<a name="N106A6"></a><a name="Quering+a+Collection"></a>
+<h2 class="h3">Quering a Collection</h2>
+<div class="section">
+<a name="N106AC"></a><a name="Xpath+Query"></a>
+<h3 class="h4">Xpath Query</h3>
+<p>
+ Execute XPath query against a collection. The query is executed for all
+ documents in the collection.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice xpath -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-q <query></span>
+</dt>
+
+<dd>
+ XPath query to execute. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-s <namespaces></span>
+</dt>
+
+<dd>
+ Semicolon delimited list of namespaces for query in the form
+ prefix=namespace-uri.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>
+ Run XPath query against all documents in the pebbles collection
+ and find all "rock" elements that have the "type" attribute
+ equals to "hard".
+ </p>
+<pre class="code">
+ xindice xpath -c /db/pebbles -q "/rock[@type='hard']"
+ </pre>
+<p>
+ Run Xpath query against all documents in the pebbles collection
+ and find all "rock" elements that have the "type" attribute equals
+ to "hard" when the rock element is in the namespace
+ http://www.bedrock.com.
+ </p>
+<pre class="code">
+ xindice xpath -c /db/pebbles -s "br=http://www.bedrock.com" -q "/br:rock[@type='hard']"
+ </pre>
+<a name="N10703"></a><a name="XUpdate+Query"></a>
+<h3 class="h4">XUpdate Query</h3>
+<p>
+ Execute XUpdate query against a document or a collection.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice xupdate -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-f <file path></span>
+</dt>
+
+<dd>
+ Name of the file which holds XUpdate query. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-n <name></span>
+</dt>
+
+<dd>
+ Document key, if query to be run against single document.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>
+ Run XUpdate query from file /path/to/xupdate.xml against all
+ documents in the test collection.
+ </p>
+<pre class="code">
+ xindice xupdate -c /db/test -f /path/to/xupdate.xml
+ </pre>
+<p>
+ Run XUpdate query from file /path/to/xupdate.xml against the document
+ with the key "document-to-update.xml" in the test collection.
+ </p>
+<pre class="code">
+ xindice xupdate -c /db/test -n document-to-update.xml -f /path/to/xupdate.xml
+ </pre>
+<a name="N1075A"></a><a name="Full+Text+Query"></a>
+<h3 class="h4">Full Text Query</h3>
+<p>
+ Execute Lucene query against a collection. This type of query
+ requires existing LuceneIndexer for the collection.
+ </p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice xpath -c <context> [-l [-d <path>]] [-v] [parameters...]</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-q <query></span>
+</dt>
+
+<dd>
+ Lucene query to execute. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>
+ Find documents that have word 'Xindice' and do not have word 'XPath'
+ in the text content of "title" element in the book collection,
+ assuming that element "title" is included in LuceneIndexer with alias
+ "chaptertitle".
+ </p>
+<pre class="code">
+ xindice xpath -c /db/pebbles -q "+chaptertitle:Xindice -chaptertitle:XPath"
+ </pre>
+</div>
+
+
+<a name="N107A4"></a><a name="Miscellaneous+Actions"></a>
+<h2 class="h3">Miscellaneous Actions</h2>
+<div class="section">
+<a name="N107AA"></a><a name="Shutting+down+the+Server"></a>
+<h3 class="h4">Shutting down the Server</h3>
+<p>Shuts down the Xindice server. Shutdown command only works with embedded driver.
+ Usually, this command is unnecessary, because all other commands will execute
+ shutdown command after their main work has been done, if embedded drived is used.
+ For XML-RPC driver, command can be executed, but it does not do anything, as the
+ lifecycle is managed by application container (such as Tomcat).</p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice shutdown -c <context> [-l [-d <path>]] [-v]</span>
+
+</p>
+<p>
+<strong>Parameters</strong>
+</p>
+<dl>
+
+<dt>
+<span class="codefrag">-c <context></span>
+</dt>
+
+<dd>
+ The collection context. Required.
+ </dd>
+
+<dt>
+<span class="codefrag">-l</span>
+</dt>
+
+<dd>
+ Use a local database rather then going over the network.
+ Should be combined with -d to specify the configuration to use.
+ </dd>
+
+<dt>
+<span class="codefrag">-d <path></span>
+</dt>
+
+<dd>
+ Path to the database configuration to use for the local
+ database. Only applies if -l is specified.
+ </dd>
+
+<dt>
+<span class="codefrag">-v</span>
+</dt>
+
+<dd>
+ Show verbose output, additional information and exceptions.
+ </dd>
+
+</dl>
+<p>
+<strong>Examples</strong>
+</p>
+<p>Shutdown the server</p>
+<pre class="code">
+ xindice shutdown -c /db
+ </pre>
+<a name="N107EC"></a><a name="Accessing+Help"></a>
+<h3 class="h4">Accessing Help</h3>
+<p>Show available commands</p>
+<p>
+<strong>Summary</strong>
+</p>
+<p>
+
+<span class="codefrag">xindice --help</span>
+
+</p>
+<p>
+ Command name abbreviations: <span class="codefrag">-h, help</span>
+
+</p>
+</div>
+
+<p align="right">
+<font size="-2">by Jay Kalafus, Kimbro Staken</font>
+</p>
+<span class="version">
+ version 598114</span>
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </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 ©
+ 2001-2007 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: xml/site/targets/xindice/1.2/guide-tools.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: xml/site/targets/xindice/1.2/guide-tools.html
------------------------------------------------------------------------------
svn:keywords = Id Revision Author Date
Added: xml/site/targets/xindice/1.2/guide-tools.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-tools.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.
Propchange: xml/site/targets/xindice/1.2/guide-tools.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