vgritsenko 2004/02/25 05:38:03
Modified: src/documentation/content/xdocs book.xml guide-tools.xml
guide-user.xml
Log:
corrections to the guides
Revision Changes Path
1.10 +31 -31 xml-xindice/src/documentation/content/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/book.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- book.xml 8 Feb 2004 04:03:14 -0000 1.9
+++ book.xml 25 Feb 2004 13:38:03 -0000 1.10
@@ -26,33 +26,33 @@
-->
<book software="Xindice" title="Xindice" copyright="The Apache Software
Foundation" xmlns:xlink="http://www.w3.org/1999/xlink";>
- <menu label="Project">
- <menu-item label="Overview" href="index.html"/>
- <menu-item label="News" href="news.html"/>
- <menu-item label="License" href="license.html"/>
- <menu-item label="Changes" href="changes.html"/>
- <menu-item label="Todo" href="todo.html"/>
- <menu-item label="Download"
href="http://xml.apache.org/xindice/download.cgi"/>
- <menu-item label="Download Template" type="hidden"
href="download.html"/>
- </menu>
- <menu label="Documentation">
- <menu-item label="Administrator Guide"
href="guide-administrator.html"/>
- <menu-item label="User Guide" href="guide-user.html"/>
- <menu-item label="Developer Guide" href="guide-developer.html"/>
- <menu-item label="Commandline Tool Guide" href="guide-tools.html"/>
- <menu-item label="FAQ" href="faq.html"/>
- <menu-item label="Wiki" href="http://wiki.apache.org/xindice"/>
- <menu-item label="Javadocs" href="api/index.html"/>
- </menu>
- <menu label="Community">
- <menu-item label="Contributing" href="contributing.html"/>
- <menu-item label="Who we are" href="who.html"/>
- <menu-item label="Mailing lists" href="mail.html"/>
- <menu-item label="Code Repository"
href="http://xml.apache.org/cvs.html"/>
- <menu-item label="Bug database"
href="http://nagoya.apache.org/bugzilla/index.html"/>
- </menu>
- <menu label="Resources">
- <menu-item label="Related links" href="related.html"/>
- <menu-item label="XML:DB Initiative" href="http://www.xmldb.org"/>
- </menu>
+ <menu label="Project">
+ <menu-item label="Overview" href="index.html"/>
+ <menu-item label="News" href="news.html"/>
+ <menu-item label="License" href="license.html"/>
+ <menu-item label="Changes" href="changes.html"/>
+ <menu-item label="Todo" href="todo.html"/>
+ <menu-item label="Download"
href="http://xml.apache.org/xindice/download.cgi"/>
+ <menu-item label="Download Template" type="hidden" href="download.html"/>
+ </menu>
+ <menu label="Documentation">
+ <menu-item label="Administrator Guide" href="guide-administrator.html"/>
+ <menu-item label="User Guide" href="guide-user.html"/>
+ <menu-item label="Developer Guide" href="guide-developer.html"/>
+ <menu-item label="Commandline Tool Guide" href="guide-tools.html"/>
+ <menu-item label="FAQ" href="faq.html"/>
+ <menu-item label="Wiki" href="http://wiki.apache.org/xindice"/>
+ <menu-item label="Javadocs" href="api/index.html"/>
+ </menu>
+ <menu label="Community">
+ <menu-item label="Contributing" href="contributing.html"/>
+ <menu-item label="Who we are" href="who.html"/>
+ <menu-item label="Mailing lists" href="mail.html"/>
+ <menu-item label="Code Repository"
href="http://xml.apache.org/cvs.html"/>
+ <menu-item label="Bug database"
href="http://nagoya.apache.org/bugzilla/index.html"/>
+ </menu>
+ <menu label="Resources">
+ <menu-item label="Related links" href="related.html"/>
+ <menu-item label="XML:DB Initiative" href="http://www.xmldb.org"/>
+ </menu>
</book>
1.11 +975 -1273
xml-xindice/src/documentation/content/xdocs/guide-tools.xml
Index: guide-tools.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/guide-tools.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- guide-tools.xml 8 Feb 2004 04:03:14 -0000 1.10
+++ guide-tools.xml 25 Feb 2004 13:38:03 -0000 1.11
@@ -26,1304 +26,1006 @@
-->
<document>
- <header>
- <title>Xindice 1.1 Commandline Tool Guide</title>
- <version>$Revision$</version>
- <authors>
- <person id="jk" name="Jay Kalafus" email=""/>
- <person id="ks" name="Kimbro Staken" email=""/>
- </authors>
- <notice/>
- <abstract/>
- </header>
+ <header>
+ <title>Xindice 1.1 Commandline Tool Guide</title>
+ <version>$Revision$</version>
+ <authors>
+ <person id="jk" name="Jay Kalafus" email=""/>
+ <person id="ks" name="Kimbro Staken" email=""/>
+ </authors>
+ <notice/>
+ <abstract/>
+ </header>
+
+ <body>
+ <note>
+ If you notice incorrectness in this documentation, please
+ <link href="mail.html">notify</link> Xindice community. Your feedback
+ will help create better documentation.
+ </note>
- <body>
- <note>
- If you notice incorrectness in this documentation, please
- <link href="mail.html">notify</link> Xindice community. Your feedback
- will help create better documentation.
- </note>
+ <section>
+ <title>Collection Management Commands</title>
<section>
- <title>Collection Management Commands</title>
- <section>
- <title>Adding a Collection</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice add_collection-c
- (or context)
- -n
- (or name)
-
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>add_collection</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>ac</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
create the new
+ <title>Adding a Collection</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice add_collection -c (or context)
+ -n (or name) [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>add_collection</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>ac</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to create the
new
collection.
- </li>
- <li>
- <code>-n</code> The name of the collection to create
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Creating a Top Level Collection</title>
- <source><![CDATA[
-xindice add_collection -c /db -n pebbles
- ]]></source>
- </section>
- <section>
- <title>Creating a Sub Collection Under an Existing
Collection</title>
- <source><![CDATA[
-xindice add_collection -c /db/pebbles -n boulder
- ]]></source>
- </section>
- </section>
- <section>
- <title>Deleting a Collection</title>
- <p>
- Deletes a collection or subcollection from the database. If
deleting a collection that has subcollections and documents
- they will also be deleted.
- </p>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice delete_collection-c
- (or context)
- -n
- (or name)
-
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>delete_collection</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>dc</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
delete the collection.
- </li>
- <li>
- <code>-n</code> The name of the collection to delete.
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Deleting a Top Level Collection</title>
- <source><![CDATA[
-xindice delete_collection -c /db -n pebbles
- ]]></source>
- </section>
- <section>
- <title>Deleting a Sub Collection</title>
- <source><![CDATA[
-xindice delete_collection -c /db/pebbles -n boulder
- ]]></source>
- </section>
- </section>
- <section>
- <title>List Collections</title>
- <p>
- List all collections under the collection context given. If
no collection is given then the root
- collection will be asumed.
- </p>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice list_collections
- [-c
- (or context)
- ]
+ </li>
+ <li>
+ <code>-n</code> The name of the collection to create
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Creating a Top Level Collection</title>
+ <source><![CDATA[
+ xindice add_collection -c /db -n pebbles
+ ]]></source>
+ </section>
+ <section>
+ <title>Creating a Sub Collection Under an Existing
Collection</title>
+ <source><![CDATA[
+ xindice add_collection -c /db/pebbles -n boulder
+ ]]></source>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>list_collections</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>lc</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which all sub
collections are listed
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Listing the Top Level Collections</title>
- <source><![CDATA[
-xindice list_collections -c /db
- ]]></source>
- </section>
- <section>
- <title>Listing a Sub Collection</title>
- <source><![CDATA[
-xindice list_collections -c /db/pebbles
- ]]></source>
- </section>
- </section>
+ <section>
+ <title>Deleting a Collection</title>
+ <p>
+ Deletes a collection or subcollection from the database. If
deleting
+ a collection that has subcollections and documents they will also
be
+ deleted.
+ </p>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice delete_collection -c (or context)
+ -n (or name)
+ [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>delete_collection</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>dc</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to delete the
collection.
+ </li>
+ <li>
+ <code>-n</code> The name of the collection to delete.
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Deleting a Top Level Collection</title>
+ <source><![CDATA[
+ xindice delete_collection -c /db -n pebbles
+ ]]></source>
+ </section>
+ <section>
+ <title>Deleting a Sub Collection</title>
+ <source><![CDATA[
+ xindice delete_collection -c /db/pebbles -n boulder
+ ]]></source>
+ </section>
</section>
+
<section>
- <title>Document Management Commands</title>
- <section>
- <title>Adding a Document</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice add_document-c
- (or context)
- -f
- (or file path)
+ <title>List Collections</title>
+ <p>
+ List all collections under the collection context given.
+ </p>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice list_collections -c (or context) [-v (or )]</code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>list_collections</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>lc</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which all sub
collections are listed
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Listing the Top Level Collections</title>
+ <source><![CDATA[
+ xindice list_collections -c /db
+ ]]></source>
+ </section>
+ <section>
+ <title>Listing a Sub Collection</title>
+ <source><![CDATA[
+ xindice list_collections -c /db/pebbles
+ ]]></source>
+ </section>
+ </section>
+ </section>
- [-n
- (or key to assign to document)
- ]
+ <section>
+ <title>Document Management Commands</title>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>add_document</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>ad</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to add
the document
- </li>
- <li>
- <code>-f</code> The complete file path to the document
being added
- </li>
- <li>
- <code>-n</code> The key to assign to the document
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Adding a document to a collection with a key of
"stones"</title>
- <source><![CDATA[
-xindice add_document -c /db/pebbles -f /tmp/stones.xml -n stones
- ]]></source>
- </section>
- <section>
- <title>Adding a document to the root collection with an
automatically generated key</title>
- <source><![CDATA[
-xindice add_document -c /db -f /tmp/bookmarks.xml
- ]]></source>
- </section>
- </section>
- <section>
- <title>Adding Multiple Documents</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice add_multiple_documents-c
- (or context)
- -f
- (or Directory to use )
+ <section>
+ <title>Adding a Document</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice add_document -c (or context)
+ -f (or file path)
+ [-n (or key to assign to document)]
+ [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>add_document</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>ad</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to add the
document
+ </li>
+ <li>
+ <code>-f</code> The complete file path to the document being
added
+ </li>
+ <li>
+ <code>-n</code> The key to assign to the document
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Adding a document to a collection with a key of
"stones"</title>
+ <source><![CDATA[
+ xindice add_document -c /db/pebbles -f /tmp/stones.xml -n stones
+ ]]></source>
+ </section>
+ <section>
+ <title>Adding a document to the root collection with an
automatically generated key</title>
+ <source><![CDATA[
+ xindice add_document -c /db -f /tmp/bookmarks.xml
+ ]]></source>
+ </section>
+ </section>
- [-e
- (or file extenstion )
- ]
+ <section>
+ <title>Adding Multiple Documents</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice add_multiple_documents -c (or context)
+ -f (or Directory to use )
+ [-e (or file extenstion )]
+ [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>add_multiple_documents</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>addmultiple</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to add the
documents
+ </li>
+ <li>
+ <code>-f</code> The path to the directory to import documents
from
+ </li>
+ <li>
+ <code>-e</code> The file extension to use when importing
documents
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Adding all files from a directory to a collection</title>
+ <source><![CDATA[
+ xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs
+ ]]></source>
+ </section>
+ <section>
+ <title>Adding all files from a directory with an extension of
".xml" </title>
+ <source><![CDATA[
+ xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs -e xml
+ ]]></source>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>add_multiple_documents</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>addmultiple</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to add
the documents
- </li>
- <li>
- <code>-f</code> The path to the directory to import
documents from
- </li>
- <li>
- <code>-e</code> The file extension to use when importing
documents
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Adding all files from a directory to a
collection</title>
- <source><![CDATA[
-xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs
- ]]></source>
- </section>
- <section>
- <title>Adding all files from a directory with an extension of
".xml" </title>
- <source><![CDATA[
-xindice add_multiple_documents -c /db/pebbles -f /tmp/mydocs -e xml
- ]]></source>
- </section>
- </section>
- <section>
- <title>Deleting a Document</title>
- <p>
- Deletes an existing document from a collection or nested
collection within the database.
- </p>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice delete_document-c
- (or context)
- -n
- (or document key)
+ <section>
+ <title>Deleting a Document</title>
+ <p>
+ Deletes an existing document from a collection or nested collection
+ within the database.
+ </p>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice delete_document -c (or context)
+ -n (or document key)
+ [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>delete_document</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>dd</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to delete the
document
+ </li>
+ <li>
+ <code>-n</code> The key of the document to be deleted
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Deleting a Document from a collection</title>
+ <source><![CDATA[
+ xindice delete_document -c /db/pebbles -n stones
+ ]]></source>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>delete_document</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>dd</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
delete the document
- </li>
- <li>
- <code>-n</code> The key of the document to be deleted
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Deleting a Document from a collection</title>
- <source><![CDATA[
-xindice delete_document -c /db/pebbles -n stones
- ]]></source>
- </section>
- </section>
- <section>
- <title>Retrieving a Document</title>
- <p>
+ <section>
+ <title>Retrieving a Document</title>
+ <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice retrieve_document-c
- (or context)
- -n
- (or document key)
- -f
- (or file path and name )
-
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>retrieve_document</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>rd</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
retrieve the document
- </li>
- <li>
- <code>-n</code> The key of the document to be retrieved
- </li>
- <li>
- <code>-f</code> The file path to store the document under
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- <li>
- <code>-u</code> The URI for the Xindice host to use.
- http://host:[port]
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Retrieving a document from a collection</title>
- <source><![CDATA[
-xindice retrieve_document -c /db/pebbles -n stones -f /tmp/stones.xml
- ]]></source>
- </section>
- </section>
- <section>
- <title>Importing a Directory Tree</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice import-c
- (or context)
- -f
- (or file path and name )
-
- [-e
- (or file extenstion )
- ]
-
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>import</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>import</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
import the documents
- </li>
- <li>
- <code>-f</code> The path to the documents being added
- </li>
- <li>
- <code>-e</code> The file extension to use when importing
documents
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Importing all directories and documents</title>
- <source><![CDATA[
-xindice import -c /db/pebbles -f /tmp/flintstones
- ]]></source>
- </section>
- <section>
- <title>Importing all directories and documents with an
extension of ".xml" </title>
- <source><![CDATA[
-xindice import -c /db/pebbles -f /tmp/flintstones -e xml
- ]]></source>
- </section>
- </section>
- <section>
- <title>Exporting a Directory Tree</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice export-c
- (or context)
- -f
- (or directory path)
-
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>export</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>export</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
export the document tree
- </li>
- <li>
- <code>-f</code> The directory to create the collection
structure under
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Creating a directory tree indentical to a
collection</title>
- <source><![CDATA[
-xindice export -c /db/pebbles -f /tmp/pebbles
- ]]></source>
- </section>
- </section>
+ </p>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice retrieve_document -c (or context)
+ -n (or document key)
+ -f (or file path and name )
+ [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>retrieve_document</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>rd</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to retrieve
the document
+ </li>
+ <li>
+ <code>-n</code> The key of the document to be retrieved
+ </li>
+ <li>
+ <code>-f</code> The file path to store the document under
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Retrieving a document from a collection</title>
+ <source><![CDATA[
+ xindice retrieve_document -c /db/pebbles -n stones -f /tmp/stones.xml
+ ]]></source>
+ </section>
</section>
- <!--chapter>
-<docinfo>
- <title>XMLObject Management Actions</title>
-</docinfo>
-
-<sect1>
- <title>Adding a XMLObject</title>
- <para>
- Adds a new XMLObject or nested XMLObject to the database. Adding an
XMLObject requires
- an implementing class and a name. In order to add the XMLObject the
collection that it is being added
- to must already exist. to sucessfully complete this topertation, the
implementing class must be in the server's classpath.
- </para>
-
- <bridgehead renderas="sect2">Summary:</bridgehead>
- <cmdsynopsis>
- <command>xindice add_xmlobject</command>
- <arg choice="req">-c <replaceable>context</replaceable></arg>
- <arg choice="req">-i <replaceable>implementing
class</replaceable></arg>
- <arg choice="req">-n <replaceable>object name </replaceable></arg>
- <arg choice="opt">-v <replaceable></replaceable></arg>
- </cmdsynopsis>
-
- <informaltable frame="none">
- <tgroup cols="2">
- <tbody>
- <row><entry>Action:</entry><entry><command>add_xmlobject
</command></entry></row>
- <row><entry>Abberviated-Action:</entry><entry><command>ao
</command></entry></row>
- <row><entry>Access Level:</entry><entry>Admin </entry></row>
- </tbody>
- </tgroup>
- </informaltable>
-
- <bridgehead renderas="sect2">Parameters:</bridgehead>
- <simplelist>
- <member>
- <command>-c</command> The collection context under which to add the
XMLObject
- </member>
- <member>
- <command>-i</command> The fully qualified class name for the
implementing class
- </member>
- <member>
- <command>-n</command> The name to assign to the XMLObject
- </member>
- <member>
- <command>-v</command> Show verbose output
- </member>
- </simplelist>
-
- <bridgehead renderas="sect2">Examples:</bridgehead>
- <example>
- <title>Create a XMLObject in the pebbles collection </title>
- <screen>
- xindice add_xmlobject -c /db/pebbles -i example.XmlRockObject -n
rockXMLObject
- </screen>
- </example>
- <example>
- <title>Create a XMLObject in a sub collection</title>
- <screen>
- xindice add_xmlobject -c /db/pebbles/boulder -i
example.XmlRockObject -n rockXMLObject
- </screen>
- </example>
-</sect1>
-
-<sect1>
- <title>Deleting a XMLObject</title>
- <para>
- Deletes an XMLObject or nested XMLObject from the database. Deleting
an XMLObject requires the collection name and the
- XMLObject name.
- </para>
-
- <bridgehead renderas="sect2">Summary:</bridgehead>
- <cmdsynopsis>
- <command>xindice delete_xmlobject</command>
- <arg choice="req">-c <replaceable>context</replaceable></arg>
- <arg choice="req">-n <replaceable>name </replaceable></arg>
- <arg choice="opt">-v <replaceable></replaceable></arg>
- </cmdsynopsis>
-
- <informaltable frame="none">
- <tgroup cols="2">
- <tbody>
- <row><entry>Action:</entry><entry><command>delete_xmlobject
</command></entry></row>
- <row><entry>Abberviated-Action:</entry><entry><command>do
</command></entry></row>
- <row><entry>Access Level:</entry><entry>Admin </entry></row>
- </tbody>
- </tgroup>
- </informaltable>
- <bridgehead renderas="sect2">Parameters:</bridgehead>
- <simplelist>
- <member>
- <command>-c</command> The collection context under which to delete
the XMLObject
- </member>
- <member>
- <command>-n</command> The name of the XMLObject to delete
- </member>
- <member>
- <command>-v</command> Show verbose output
- </member>
- </simplelist>
-
- <bridgehead renderas="sect2">Examples:</bridgehead>
- <example>
- <title>Delete an XMLObject in the pebbles collection </title>
- <screen>
- xindice delete_xmlobject -c /db/pebbles -n rockXMLObject
- </screen>
- </example>
- <example>
- <title>Delete an XMLObject from the boulder sub collection</title>
- <screen>
- xindice delete_xmlobject -c /db/pebbles/boulder -n rockXMLObject
- </screen>
- </example>
-</sect1>
-
-
-<sect1>
- <title>Listing XMLObjects</title>
- <para>
- Lists all XMLObjects or nested XMLObjects in the database. The
listing of XMLObjects works in a similar fashion to
- listing collections.
- </para>
-
- <bridgehead renderas="sect2">Summary:</bridgehead>
- <cmdsynopsis>
- <command>xindice lists_xmlobjects</command>
- <arg choice="req">-c <replaceable>context</replaceable></arg>
- <arg choice="opt">-v <replaceable></replaceable></arg>
- </cmdsynopsis>
-
- <informaltable frame="none">
- <tgroup cols="2">
- <tbody>
- <row><entry>Action:</entry><entry><command>list_xmlobjects
</command></entry></row>
- <row><entry>Abberviated-Action:</entry><entry><command>lo
</command></entry></row>
- <row><entry>Access Level:</entry><entry>User </entry></row>
- </tbody>
- </tgroup>
- </informaltable>
-
- <bridgehead renderas="sect2">Parameters:</bridgehead>
- <simplelist>
- <member>
- <command>-c</command> The collection context under which to list
the XMLObjects
- </member>
- <member>
- <command>-v</command> Show verbose output
- </member>
- </simplelist>
-
- <bridgehead renderas="sect2">Examples:</bridgehead>
- <example>
- <title>List all XMLObjects in the pebbles collection </title>
- <screen>
- xindice list_xmlobjects -c /db/pebbles
- </screen>
- </example>
- <example>
- <title>List all XMLObjects in the boulder sub collection</title>
- <screen>
- xindice list_xmlobjects -c /db/pebbles/boulder
- </screen>
- </example>
-</sect1>
-
-<sect1>
- <title>Invoke an XMLObject</title>
- <para>
- Allows the invocation of an XMLObject in the database.
- This command requires two arguments - the collection
- to invoke the object under and the URI for the XMLObject.
- The URI given can be either relative or the absolute path.
- (See the users guide for more information on URI's)
- </para>
-
- <bridgehead renderas="sect2">Summary:</bridgehead>
- <cmdsynopsis>
- <command>xindice invoke</command>
- <arg choice="req">-c <replaceable>context</replaceable></arg>
- <arg choice="req">-o <replaceable>object URI</replaceable></arg>
- <arg choice="opt">-v <replaceable></replaceable></arg>
- </cmdsynopsis>
-
- <informaltable frame="none">
- <tgroup cols="2">
- <tbody>
- <row><entry>Action:</entry><entry><command>invoke
</command></entry></row>
- <row><entry>Abberviated-Action:</entry><entry><command>invoke
</command></entry></row>
- <row><entry>Access Level:</entry><entry>User </entry></row>
- </tbody>
- </tgroup>
- </informaltable>
-
- <bridgehead renderas="sect2">Parameters:</bridgehead>
- <simplelist>
- <member>
- <command>-c</command> The collection context under which to invoke
the XMLObject
- </member>
- <member>
- <command>-o</command> The XMLObject that is being invoked
- </member>
- <member>
- <command>-v</command> Show verbose output
- </member>
- </simplelist>
-
- <bridgehead renderas="sect2">Examples:</bridgehead>
- <example>
- <title> Invoke the rockXMLObject in the pebbles collection</title>
- <screen>
- xindice invoke -c /db/pebbles -o rockXMLObject
- </screen>
- </example>
- <example>
- <title>
- Invoke a rockXMLObject with a method named crush that takes a
- name parameter named rock
- </title>
- <screen>
- xindice invoke -c /db/pebbles -o rockXMLObject/crush?rock=boulder
- </screen>
- </example>
-</sect1>
-</chapter-->
<section>
- <title>Collection Indexer Actions</title>
- <section>
- <title>Adding a Collection Indexer</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice add_indexer-c
- (or context)
- -n
- (or index name )
- -p
- (or index pattern)
-
- [--pagesize
- (or pagesize)
- ]
-
- [--maxkeysize
- (or max key size)
- ]
+ <title>Importing a Directory Tree</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice import -c (or context)
+ -f (or file path and name )
+ [-e (or file extenstion )]
+ [-v (or ) ]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>import</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>import</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to import the
documents
+ </li>
+ <li>
+ <code>-f</code> The path to the documents being added
+ </li>
+ <li>
+ <code>-e</code> The file extension to use when importing
documents
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Importing all directories and documents</title>
+ <source><![CDATA[
+ xindice import -c /db/pebbles -f /tmp/flintstones
+ ]]></source>
+ </section>
+ <section>
+ <title>Importing all directories and documents with an extension
of ".xml" </title>
+ <source><![CDATA[
+ xindice import -c /db/pebbles -f /tmp/flintstones -e xml
+ ]]></source>
+ </section>
+ </section>
- [-t
- (or index type)
- ]
+ <section>
+ <title>Exporting a Directory Tree</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice export -c (or context) -f (or directory path) [-v
(or )]</code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>export</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>export</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to export the
document tree
+ </li>
+ <li>
+ <code>-f</code> The directory to create the collection structure
under
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Creating a directory tree indentical to a collection</title>
+ <source><![CDATA[
+ xindice export -c /db/pebbles -f /tmp/pebbles
+ ]]></source>
+ </section>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>add_indexer</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>ai</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to add
the indexer
- </li>
- <li>
- <code>-n</code> The name of the index being added
- </li>
- <li>
- <code>-p</code> The pattern used to create the index
- </li>
- <li>
- <code>--maxkeysize</code> The MaxKeySize for the index (
default: 0 = none )
- </li>
- <li>
- <code>--pagesize</code> The PageSize for the index (
default: 4096)
- </li>
- <li>
- <code>-t</code>
+ <section>
+ <title>Collection Indexer Actions</title>
+ <section>
+ <title>Adding a Collection Indexer</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>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 )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>add_indexer</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>ai</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to add the
indexer
+ </li>
+ <li>
+ <code>-n</code> The name of the index being added
+ </li>
+ <li>
+ <code>-p</code> The pattern used to create the index
+ </li>
+ <li>
+ <code>--maxkeysize</code> The MaxKeySize for the index (
default: 0 = none )
+ </li>
+ <li>
+ <code>--pagesize</code> The PageSize for the index ( default:
4096)
+ </li>
+ <li>
+ <code>-t</code>
The data type for the index to create. Possible values
are:
- <code><![CDATA[ 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]]></code>
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>To create a collection index in the pebbles collection
for docuemnts with a "rock" element</title>
- <source><![CDATA[
-xindice add_indexer -c /db/pebbles -n rockindex -p rock
- ]]></source>
- </section>
- <section>
- <title>To create a collection index in the boulder sub
collection for documents containing a rock elements with an attribute of
"hard"</title>
- <source><![CDATA[
-xindice add_indexer -c /db/pebbles/boulder -n hardindex -p [EMAIL PROTECTED]
- ]]></source>
- </section>
- </section>
- <section>
- <title>Deleting a Collection Indexer</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice delete_indexer-c
- (or context)
- -n
- (or index name)
+ <code><![CDATA[ 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]]></code>
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>
+ To create a collection index in the pebbles collection for
+ documents with a "rock" element
+ </title>
+ <source><![CDATA[
+ xindice add_indexer -c /db/pebbles -n rockindex -p rock
+ ]]></source>
+ </section>
+ <section>
+ <title>
+ To create a collection index in the boulder sub collection
+ for documents containing a rock elements with an attribute of
"hard"
+ </title>
+ <source><![CDATA[
+ xindice add_indexer -c /db/pebbles/boulder -n hardindex -p [EMAIL
PROTECTED]
+ ]]></source>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>delete_indexer </code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>di </code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin </td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
delete the index
- </li>
- <li>
- <code>-n</code> The name of the indexer being deleted
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Delete a collecion index in the pebbles
collection</title>
- <source><![CDATA[
-xindice delete_indexer -c /db/pebbles -n hardindex
- ]]></source>
- </section>
- </section>
- <section>
- <title>Listing Collection Indexers</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice list_indexers-c
- (or context)
+ <section>
+ <title>Deleting a Collection Indexer</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice delete_indexer -c (or context) -n (or index name)
[-v (or )]</code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>delete_indexer </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>di </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin </td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to delete the
index
+ </li>
+ <li>
+ <code>-n</code> The name of the indexer being deleted
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Delete a collecion index in the pebbles collection</title>
+ <source><![CDATA[
+ xindice delete_indexer -c /db/pebbles -n hardindex
+ ]]></source>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>list_indexers</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>li</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to list
the indexers
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>To list all collection indexes from the pebbles
collection </title>
- <source><![CDATA[
-xindice list_indexers -c /db/pebbles
- ]]></source>
- </section>
- </section>
+ <section>
+ <title>Listing Collection Indexers</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice list_indexers -c (or context) [-v (or )]</code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>list_indexers</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>li</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to list the
indexers
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>To list all collection indexes from the pebbles collection
</title>
+ <source><![CDATA[
+ xindice list_indexers -c /db/pebbles
+ ]]></source>
+ </section>
</section>
+ </section>
+
+ <section>
+ <title>Xpath Query Actions</title>
<section>
- <title>Xpath Query Actions</title>
- <section>
- <title>Executing an Xpath Query against a Collection</title>
- <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>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice xpath-c
- (or context)
- -q
- (or query)
- -s
- (or prefix=namespace)
+ <title>Executing an Xpath Query against a Collection</title>
+ <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>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice xpath -c (or context) -q (or query) -s (or
prefix=namespace) [-v (or )]</code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>xpath</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>xpath</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-c</code> The collection context under which to execute
the query
+ </li>
+ <li>
+ <code>-q</code> The query to execute against the collection
+ </li>
+ <li>
+ <code>-s</code> Semi-colon delimited list of namespaces for query
+ in the form prefix=namespace-uri
+ </li>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>
+ Run an Xpath query against all documents in the pebbles
collection
+ with "rock" node that has the type attribute = "hard"
+ </title>
+ <source><![CDATA[
+ xindice xpath -c /db/pebbles -q "/[EMAIL PROTECTED]'hard']"
+ ]]></source>
+ </section>
+ <section>
+ <title>
+ 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
+ </title>
+ <source><![CDATA[
+ xindice xpath -c /db/pebbles -s "br=http://www.bedrock.com"; -q "/br:[EMAIL
PROTECTED]'hard']"
+ ]]></source>
+ </section>
+ </section>
+ </section>
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>xpath</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>xpath</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-c</code> The collection context under which to
execute the query
- </li>
- <li>
- <code>-q</code> The query to execute against the collection
- </li>
- <li>
- <code>-s</code> Semi-colon delimited list of namespaces
for query in the form prefix=namespace-uri
- </li>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>
- Run an Xpath query against all documents in the pebbles
collection with "rock" node that has the type
- attribute = "hard"
- </title>
- <source><![CDATA[
-xindice xpath -c /db/pebbles -q /[EMAIL PROTECTED]"hard"]
- ]]></source>
- </section>
- <section>
- <title>
- 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
- </title>
- <source><![CDATA[
-xindice xpath -c /db/pebbles -s "br=http://www.bedrock.com"; -q /br:[EMAIL
PROTECTED]"hard"]
- ]]></source>
- </section>
- </section>
+ <section>
+ <title>Miscellaneous Actions</title>
+ <section>
+ <title>Shutting down the server</title>
+ <p>Shutdown the Xindice server</p>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice shutdown [-v (or )]
+ </code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>shutdown</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>shutdown</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>Admin</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Shutdown the server</title>
+ <source><![CDATA[
+ xindice shutdown
+ ]]></source>
+ </section>
</section>
<section>
- <title>Miscellaneous Actions</title>
- <section>
- <title>Shutting down the server</title>
- <p>
- Shutdown the Xindice server
- </p>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice shutdown
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>shutdown</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>shutdown</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>Admin</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Shutdown the server </title>
- <source><![CDATA[
-xindice shutdown
- ]]></source>
- </section>
- </section>
- <section>
- <title>Accessing online Help</title>
- <p>
- Show the online help
- </p>
- <section>
- <title>Summary:</title>
- </section>
- <p>
- <code>xindice help
- [-v
- (or )
- ]
- </code>
- </p>
- <table>
- <tr>
- <td>Action:</td>
- <td>
- <code>help</code>
- </td>
- </tr>
- <tr>
- <td>Abberviated-Action:</td>
- <td>
- <code>help</code>
- </td>
- </tr>
- <tr>
- <td>Access Level:</td>
- <td>User</td>
- </tr>
- </table>
- <section>
- <title>Parameters:</title>
- </section>
- <ul>
- <li>
- <code>-v</code> Show verbose output
- </li>
- </ul>
- <section>
- <title>Examples:</title>
- </section>
- <section>
- <title>Show online Help</title>
- <source><![CDATA[
-xindice help
- ]]></source>
- </section>
- </section>
+ <title>Accessing online Help</title>
+ <p>Show the online help</p>
+ <section>
+ <title>Summary:</title>
+ </section>
+ <p>
+ <code>xindice help [-v (or )]</code>
+ </p>
+ <table>
+ <tr>
+ <td>Action:</td>
+ <td>
+ <code>help</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Abberviated-Action:</td>
+ <td>
+ <code>help</code>
+ </td>
+ </tr>
+ <tr>
+ <td>Access Level:</td>
+ <td>User</td>
+ </tr>
+ </table>
+ <section>
+ <title>Parameters:</title>
+ </section>
+ <ul>
+ <li>
+ <code>-v</code> Show verbose output
+ </li>
+ </ul>
+ <section>
+ <title>Examples:</title>
+ </section>
+ <section>
+ <title>Show online Help</title>
+ <source><![CDATA[
+ xindice help
+ ]]></source>
+ </section>
</section>
- </body>
+ </section>
+ </body>
</document>
1.12 +27 -23
xml-xindice/src/documentation/content/xdocs/guide-user.xml
Index: guide-user.xml
===================================================================
RCS file:
/home/cvs/xml-xindice/src/documentation/content/xdocs/guide-user.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- guide-user.xml 8 Feb 2004 04:03:14 -0000 1.11
+++ guide-user.xml 25 Feb 2004 13:38:03 -0000 1.12
@@ -366,9 +366,7 @@
line tools and the result of the query will be displayed.
</p>
<section>
- <title>
- Executing an XPath query against a collection of XML documents
- </title>
+ <title>Executing an XPath query against a collection of XML
documents</title>
<p>
Here we assume we have a collection /db/data/products that
contains
documents that are similar to the following.
@@ -385,8 +383,8 @@
will be returned.
</p>
<source><![CDATA[
- xindice xpath_query -c /db/data/products -q /[EMAIL PROTECTED]"120320"]
- ]]></source>
+ xindice xpath_query -c /db/data/products -q "/[EMAIL PROTECTED]'120320']"
+ ]]></source>
<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
@@ -405,27 +403,34 @@
is possible to retrieve the original document that this node
was
selected from for further processing.
</p>
- <source><![CDATA[<product product_id="120320"
xmlns:src="http://xml.apache.org/xindice/NodeSource";
-src:col="/db/data/products" src:key="120320">
-<description>Glazed Ham</description>
-</product>]]></source>
+ <source><![CDATA[
+<product product_id="120320"
+ xmlns:src="http://xml.apache.org/xindice/NodeSource";
+ src:col="/db/data/products" src:key="120320">
+ <description>Glazed Ham</description>
+</product>
+ ]]></source>
<p>
If more then one result is found the results look something
like
this. This could be the result of the query /product
</p>
<source><![CDATA[
-<product product_id="120320"
xmlns:src="http://xml.apache.org/xindice/NodeSource";
-src:col="/db/data/products" src:key="120320">
-<description>Glazed Ham</description>
+<product product_id="120320"
+ xmlns:src="http://xml.apache.org/xindice/NodeSource";
+ src:col="/db/data/products" src:key="120320">
+ <description>Glazed Ham</description>
</product>
-<product product_id="120321"
xmlns:src="http://xml.apache.org/xindice/NodeSource";
-src:col="/db/data/products" src:key="120321">
-<description>Boiled Ham</description>
+<product product_id="120321"
+ xmlns:src="http://xml.apache.org/xindice/NodeSource";
+ src:col="/db/data/products" src:key="120321">
+ <description>Boiled Ham</description>
</product>
-<product product_id="120322"
xmlns:src="http://xml.apache.org/xindice/NodeSource";
-src:col="/db/data/products" src:key="120322">
-<description>Honey Ham</description>
-</product>]]></source>
+<product product_id="120322"
+ xmlns:src="http://xml.apache.org/xindice/NodeSource";
+ src:col="/db/data/products" src:key="120322">
+ <description>Honey Ham</description>
+</product>
+ ]]></source>
</section>
<p>
While it is certainly useful to be able to query from the command
@@ -458,6 +463,5 @@
</p>
</section>
-->
-
</body>
</document>
