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 [5/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.1/howto/upgrading-one-one.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/howto/upgrading-one-one.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/howto/upgrading-one-one.html (added)
+++ xml/site/targets/xindice/1.1/howto/upgrading-one-one.html Fri Dec 7 18:01:36 2007
@@ -0,0 +1,448 @@
+<!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 Release 1.1b1 Through 1.1b4 Upgrading How-To</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 class="current">
+<a class="selected" href="../../1.1/index.html">1.1</a>
+</li>
+<li>
+<a class="unselected" href="../../1.2/index.html">1.2-Dev</a>
+</li>
+<li>
+<a class="unselected" href="../../dev/index.html">Dev</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../../skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../1.1/index.html">Overview</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../../skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../1.1/guide-administrator.html">Administrator Guide</a>
+</div>
+<div class="menuitem">
+<a href="../../1.1/guide-user.html">User Guide</a>
+</div>
+<div class="menuitem">
+<a href="../../1.1/guide-developer.html">Developer Guide</a>
+</div>
+<div class="menuitem">
+<a href="../../1.1/guide-tools.html">Tool Guide</a>
+</div>
+<div class="menuitem">
+<a href="../../1.1/guide-xpath.html">XPath Guide</a>
+</div>
+<div class="menuitem">
+<a href="../../1.1/faq.html">FAQ</a>
+</div>
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xml.apache.org/xindice/1.1/api/index.html">Javadocs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../../skin/images/chapter_open.gif');">How-Tos</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../1.1/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../../skin/')" id="menu_1.3.2Title" class="menutitle">Compilation</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../1.1/howto/compilation-unix.html">Unix</a>
+</div>
+<div class="menuitem">
+<a href="../../1.1/howto/compilation-windows.html">Windows</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.3', '../../skin/')" id="menu_1.3.3Title" class="menutitle">Installation</div>
+<div id="menu_1.3.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../1.1/howto/installation-tomcat.html">Tomcat How-to</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3.4', '../../skin/')" id="menu_selected_1.3.4Title" class="menutitle" style="background-image: url('../../skin/images/chapter_open.gif');">Upgrading</div>
+<div id="menu_selected_1.3.4" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">From 1.1b1 and up</div>
+</div>
+<div class="menuitem">
+<a href="../../1.1/howto/upgrading-one-oh.html">From 1.0</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../../skin/')" id="menu_1.4Title" class="menutitle">Resources</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<script language="Javascript" type="text/javascript">
+function printit() {
+ if (window.print) {
+ window.focus();
+ window.print();
+ }
+}
+ </script><script language="Javascript" type="text/javascript">
+var NS = (navigator.appName == "Netscape");
+var VERSION = parseInt(navigator.appVersion);
+if (VERSION > 3) {
+ document.write('<div title="Print this Page" class="printlink">');
+ document.write(' <a class="dida" href="javascript:printit()">');
+ document.write(' <img alt="print - icon" src="../../skin/images/printer.gif" class="skin">');
+ document.write(' <br>');
+ document.write(' PRINT</a>');
+ document.write('</div>');
+}
+ </script>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="upgrading-one-one.pdf"><img alt="PDF -icon" src="../../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Xindice Release 1.1b1 Through 1.1b4 Upgrading How-To</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Intended audience">Intended audience</a>
+</li>
+<li>
+<a href="#Prerequisites">Prerequisites</a>
+</li>
+<li>
+<a href="#Upgrade Steps">Upgrade Steps</a>
+<ul class="minitoc">
+<li>
+<a href="#Overview">Overview</a>
+</li>
+<li>
+<a href="#Procedure">Procedure</a>
+</li>
+<li>
+<a href="#Alternate+Procedure">Alternate Procedure</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<a name="N10018"></a><a name="Intended audience"></a>
+<h2 class="h3">Intended audience</h2>
+<div class="section">
+<p>
+ This How-to is aimed at developers or administrator performing
+ upgrade of one of 1.1 beta releases of Xindice to the final 1.1 release.
+ </p>
+</div>
+<a name="N10020"></a><a name="Prerequisites"></a>
+<h2 class="h3">Prerequisites</h2>
+<div class="section">
+<p>
+ Shutdown. Shutdown the database before starting upgrade process.
+ </p>
+<p>
+ Backup. Always back up your database before starting an upgrade.
+ </p>
+</div>
+<a name="N1002B"></a><a name="Upgrade Steps"></a>
+<h2 class="h3">Upgrade Steps</h2>
+<div class="section">
+<a name="N10030"></a><a name="Overview"></a>
+<h3 class="h4">Overview</h3>
+<p>
+ All Xindice 1.1 beta releases are utilising same configuration files and backward
+ compatible with the Xindice 1.1 final release. The areas where betas are different
+ are:
+ </p>
+<ul>
+
+<li>
+ Changes to BTreeFiler and HashFiler. BTreeFiler has been changed to address
+ incorrect handling of numeric indexes (see Bug #19203). HashFiler has been changed
+ to address inefficient hash function implementation. Due to these changes,
+ existing databases should be upgraded to the latest format using supplied
+ database rebuild utility.
+ </li>
+
+<li>
+ Changes to release packaging. Since Xindice 1.1, there are only two releases
+ are being shipped: source and binary. Binary release includes both xindice.war file
+ ready for deployment, as well as xindice.jar for embedded applications.
+ </li>
+
+<li>
+ Changes to Xindice scripts. Xindice now comes with two main commands, <span class="codefrag">xindice</span>
+ and <span class="codefrag">xindiced</span>. First one is a Xindice command line tool, and second provides
+ a way to start Xindice database with embedded HTTP server (Jetty).
+ </li>
+
+</ul>
+<a name="N1004C"></a><a name="Procedure"></a>
+<h3 class="h4">Procedure</h3>
+<p>
+ Upgrade procedure consists of the following:
+ </p>
+<ul>
+
+<li>
+ Install Xindice 1.1 release.
+ </li>
+
+<li>
+ Point XINDICE_HOME environment variable to the Xindice installation directory.
+ </li>
+
+<li>
+ Copy existing database over to XINDICE_HOME/db. (Alternatively, set environment
+ variable XINDICE_DB_HOME to point to directory which contains db directory.)
+ </li>
+
+<li>
+ In the shell, execute<br>
+ (Unix):
+ <pre class="code">
+ cd $XINDICE_HOME
+ ./bin/xindice_rebuild rebuild db</pre>
+ (Windows):
+ <pre class="code">
+ cd %XINDICE_HOME%
+ bin\xindice_rebuild rebuild db</pre>
+ (If using XINDICE_DB_HOME variable, substitute 'db' with '$XINDICE_DB_HOME/db'.)
+ </li>
+
+<li>
+ Check tool output for any problems. If any of the collections or indices could
+ not be rebuilt to new format, do not panic - just follow an alternate approach
+ outlined below.
+ </li>
+
+<li>
+ Test resulting database using command line tool.
+ </li>
+
+</ul>
+<a name="N10075"></a><a name="Alternate+Procedure"></a>
+<h3 class="h4">Alternate Procedure</h3>
+<p>
+ If any of the collections or indices could not be converted to new format,
+ follow these steps. To migrate collections over to the new database:
+ </p>
+<ul>
+
+<li>
+ Start old Xindice database (using backed up data files).
+ </li>
+
+<li>
+ Export all documents from affected collections (replace <name> with
+ collection path):<br>
+ (Unix):
+ <pre class="code">
+ mkdir export
+ ./bin/xindiceadmin export -c /db/<name> -f export</pre>
+ (Windows):
+ <pre class="code">
+ mkdir export
+ bin\xindiceadmin export -c /db/<name> -f export</pre>
+
+</li>
+
+<li>
+ Stop old Xindice database.
+ </li>
+
+<li>
+ Start new database.
+ </li>
+
+<li>
+ Recreate collections in the new database.
+ </li>
+
+<li>
+ Delete corrupted collections from new database using command line tool. This
+ should also remove all data files and index files of these collections.
+ </li>
+
+<li>
+ Import all documents into the new database:<br>
+ (Unix):
+ <pre class="code">
+ ./bin/xindice import -c /db -f export/<name></pre>
+ (Windows):
+ <pre class="code">
+ bin\xindice import -c /db -f export\<name></pre>
+
+</li>
+
+<li>
+ Create all indexes which were present in the old database.
+ </li>
+
+</ul>
+<p>
+ For indices which can not be converted:
+ </p>
+<ul>
+
+<li>
+ Start new database.
+ </li>
+
+<li>
+ Drop corrupted indices.
+ </li>
+
+<li>
+ Recreate indices anew.
+ </li>
+
+</ul>
+<p>If you run into problems, don't worry. Be sure to send <a href="../../mail.html">feedback</a> so that we can improve these documents for the next person.</p>
+</div>
+<p align="right">
+<font size="-2">by Vadim Gritsenko</font>
+</p>
+<span class="version">
+ version 598506</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.1/howto/upgrading-one-one.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: xml/site/targets/xindice/1.1/howto/upgrading-one-one.html
------------------------------------------------------------------------------
svn:keywords = Id Revision Author Date
Added: xml/site/targets/xindice/1.1/howto/upgrading-one-one.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/howto/upgrading-one-one.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.
Propchange: xml/site/targets/xindice/1.1/howto/upgrading-one-one.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: xml/site/targets/xindice/1.1/index.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/index.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.1/index.html (added)
+++ xml/site/targets/xindice/1.1/index.html Fri Dec 7 18:01:36 2007
@@ -0,0 +1,268 @@
+<!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>Apache Xindice 1.1 Documentation</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 class="current">
+<a class="selected" href="../1.1/index.html">1.1</a>
+</li>
+<li>
+<a class="unselected" href="../1.2/index.html">1.2-Dev</a>
+</li>
+<li>
+<a class="unselected" href="../dev/index.html">Dev</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Overview</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/guide-administrator.html">Administrator Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-user.html">User Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-developer.html">Developer Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-tools.html">Tool Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/guide-xpath.html">XPath Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/faq.html">FAQ</a>
+</div>
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xml.apache.org/xindice/1.1/api/index.html">Javadocs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">How-Tos</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../skin/')" id="menu_1.3.2Title" class="menutitle">Compilation</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/compilation-unix.html">Unix</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/howto/compilation-windows.html">Windows</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.3', '../skin/')" id="menu_1.3.3Title" class="menutitle">Installation</div>
+<div id="menu_1.3.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/installation-tomcat.html">Tomcat How-to</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.4', '../skin/')" id="menu_1.3.4Title" class="menutitle">Upgrading</div>
+<div id="menu_1.3.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../1.1/howto/upgrading-one-one.html">From 1.1b1 and up</a>
+</div>
+<div class="menuitem">
+<a href="../1.1/howto/upgrading-one-oh.html">From 1.0</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Resources</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://wiki.apache.org/xindice">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://xmldb-org.sourceforge.net/">XML:DB Initiative</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<script language="Javascript" type="text/javascript">
+function printit() {
+ if (window.print) {
+ window.focus();
+ window.print();
+ }
+}
+ </script><script language="Javascript" type="text/javascript">
+var NS = (navigator.appName == "Netscape");
+var VERSION = parseInt(navigator.appVersion);
+if (VERSION > 3) {
+ document.write('<div title="Print this Page" class="printlink">');
+ document.write(' <a class="dida" href="javascript:printit()">');
+ document.write(' <img alt="print - icon" src="../skin/images/printer.gif" class="skin">');
+ document.write(' <br>');
+ document.write(' PRINT</a>');
+ document.write('</div>');
+}
+ </script>
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="index.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Apache Xindice 1.1 Documentation</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Apache+Xindice+1.1+Documentation">Apache Xindice 1.1 Documentation</a>
+</li>
+</ul>
+</div>
+
+<a name="N10011"></a><a name="Apache+Xindice+1.1+Documentation"></a>
+<h2 class="h3">Apache Xindice 1.1 Documentation</h2>
+<div class="section">
+<p>
+ Here you can read archived documentation for the Apache
+ Xindice 1.1 release. Use left navigation bar to browse 1.1 documentation,
+ or click on the <span class="codefrag">Back</span> button to return to the main site.
+ </p>
+</div>
+
+<span class="version">
+ version 596928</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>
+<div id="logos">
+<a href="http://validator.w3.org/check/referer"><img style="height: 31px; width: 88px;" title="Valid HTML 4.01!" alt="Valid HTML 4.01!" src="../skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/check/referer"><img style="height: 31px; width: 88px;" title="Valid CSS!" alt="Valid CSS!" src="../skin/images/vcss.png" class="logoImage"></a><a href="http://xml.apache.org/forrest/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="../images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: xml/site/targets/xindice/1.1/index.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: xml/site/targets/xindice/1.1/index.html
------------------------------------------------------------------------------
svn:keywords = Id Revision Author Date
Added: xml/site/targets/xindice/1.1/index.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.1/index.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.
Propchange: xml/site/targets/xindice/1.1/index.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: xml/site/targets/xindice/1.2/faq.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/faq.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.2/faq.html (added)
+++ xml/site/targets/xindice/1.2/faq.html Fri Dec 7 18:01:36 2007
@@ -0,0 +1,465 @@
+<!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>Frequently Asked Questions</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="menuitem">
+<a href="../1.2/guide-tools.html">Tool Guide</a>
+</div>
+<div class="menuitem">
+<a href="../1.2/guide-xpath.html">XPath Guide</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">FAQ</div>
+</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="faq.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Frequently Asked Questions</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Questions">Questions</a>
+<ul class="minitoc">
+<li>
+<a href="#faq-N10014">1. What is Xindice?</a>
+</li>
+<li>
+<a href="#faq-N10020">2. What is Xindice not?</a>
+</li>
+<li>
+<a href="#faq-N1002C">3. Why not use a relational database?</a>
+</li>
+<li>
+<a href="#faq-N10038">4. Why not use an object database?</a>
+</li>
+<li>
+<a href="#faq-N10044">5. Why not use a full-text indexing engine?</a>
+</li>
+<li>
+<a href="#faq-N10050">6. What query languages do you support?</a>
+</li>
+<li>
+<a href="#faq-N1005C">7. Is your XPath implementation fully compliant?</a>
+</li>
+<li>
+<a href="#faq-N10068">8. Which JDK should I use?</a>
+</li>
+<li>
+<a href="#faq-N10074">9.
+ The XML:DB API is missing something, what should I do?
+ </a>
+</li>
+<li>
+<a href="#faq-N10084">10.
+ My 5 megabyte file is crashing the command line, help?
+ </a>
+</li>
+<li>
+<a href="#faq-N1009D">11. XML parser conflict</a>
+</li>
+<li>
+<a href="#faq-N100AD">12.
+ Where is my database?
+ </a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<a name="N10009"></a><a name="Questions"></a>
+<h2 class="h3">Questions</h2>
+<div class="section">
+<a name="N1000D"></a><a name="faq-N10014"></a>
+<h3 class="h4">1. What is Xindice?</h3>
+<p>
+ Xindice is an open source Native XML Database. It stores and indexes
+ compressed XML documents in order to provide that data to a client
+ application with very little server-side processing overhead. It
+ also provides functionality that is unique to XML data, which can't
+ easily be reproduced by relational databases.
+ </p>
+<a name="N10015"></a><a name="faq-N10020"></a>
+<h3 class="h4">2. What is Xindice not?</h3>
+<p>
+ Xindice is not a persistent DOM implementation. It was not designed
+ to store and manage single monster sized documents, where one
+ document is treated as a set of mini documents. It was
+ specifically designed for managing many small to medium sized
+ documents.
+ </p>
+<a name="N1001D"></a><a name="faq-N1002C"></a>
+<h3 class="h4">3. Why not use a relational database?</h3>
+<p>
+ XML documents are organized as tree structures. Relational
+ databases organize data in a tabular, or grid-like fashion, and
+ use relational linking in order to expose hierarchical constraints
+ on the data. Unfortunately, while it's generally very easy to map
+ relational data into XML, trying to map XML, which can be very
+ complex and freeform, into relational data can be incredibly
+ difficult and lossy.
+ </p>
+<a name="N10025"></a><a name="faq-N10038"></a>
+<h3 class="h4">4. Why not use an object database?</h3>
+<p>
+ Object database are tightly coupled with the applications that
+ they serve, and are not generally considered to be client/server
+ databases. Typically, the objects that they manage can only be
+ deserialized and used by the programming language that created
+ them. While object graphs like DOM trees can be persisted in
+ object databases, the number of objects that are produced for a
+ a large collection of XML documents can become a serious
+ performance and resource bottleneck.
+ </p>
+<a name="N1002D"></a><a name="faq-N10044"></a>
+<h3 class="h4">5. Why not use a full-text indexing engine?</h3>
+<p>
+ Full text indexing engines are very fast and appropriate for
+ performing broad queries across a set of documents. The
+ drawbacks to using them for XML applications is that creating
+ an inverted index causes you to lose document context, requiring
+ very intensive post-processing to isolate the document nodes
+ that are being managed. Xindice provides efficient indexing of
+ element and attribute values in addition to the ability to
+ return and manage aggregated document fragments.
+ </p>
+<a name="N10035"></a><a name="faq-N10050"></a>
+<h3 class="h4">6. What query languages do you support?</h3>
+<p>
+ Xindice supports XPath and XUpdate. XPath is the W3C's XML
+ Pathing language, and is a very powerful way of selecting sets of
+ nodes from documents in a collection. XUpdate is the XML:DB
+ Initiative's updating language, and is very flexible in its ability
+ to update sets of documents that meet specific XPath criteria.
+ </p>
+<a name="N1003D"></a><a name="faq-N1005C"></a>
+<h3 class="h4">7. Is your XPath implementation fully compliant?</h3>
+<p>
+ Our XPath implementation is the Apache Software Foundation's Xalan
+ library. Xindice provides indexing mechanisms and query
+ optimization facilities to augment the performance of collection
+ level XPath queries, but Xalan ultimately has the final say in
+ any query.
+ </p>
+<a name="N10045"></a><a name="faq-N10068"></a>
+<h3 class="h4">8. Which JDK should I use?</h3>
+<p>
+ Minimum required JDK version is 1.4, Xindice will also work with
+ versions 1.5 and 1.6.
+ </p>
+<a name="N1004D"></a><a name="faq-N10074"></a>
+<h3 class="h4">9.
+ The XML:DB API is missing something, what should I do?
+ </h3>
+<p>
+ The XML:DB API is being designed be the XML:DB Initiative, and
+ so its interfaces and classes are predetermined by that group.
+ If you have any questions or would like to help further define
+ the standard API for XML databases, please visit
+ <a href="http://xmldb-org.sourceforge.net/">http://xmldb-org.sourceforge.net</a>.
+ </p>
+<a name="N10059"></a><a name="faq-N10084"></a>
+<h3 class="h4">10.
+ My 5 megabyte file is crashing the command line, help?
+ </h3>
+<p>
+ See FAQ #2. Xindice wasn't designed for monster documents,
+ rather, it was designed for collections of small to medium
+ sized documents. The best thing to do in this case would be to
+ look at your 5 megabyte file, and determine whether or not it's
+ a good candidate for being sliced into a set of small documents.
+ If so, you'll want to extract the separate documents and add
+ them to a Xindice collection individually. A good example of
+ this, would be a massive document of this form:
+ </p>
+<pre class="code">
+ <cars>
+ <car>
+ <make>Boyoda</make>
+ <model>Cordova</model>
+ <year>1989</year>
+ </car>
+ <car>
+ <make>Frod</make>
+ <model>Tortorus</model>
+ <year>1990</year>
+ </car>
+ ...
+ </cars>
+ </pre>
+<p>
+ In this case, it makes more sense to split the file into
+ several <span class="codefrag"><car/></span> documents instead of a
+ single <span class="codefrag"><cars/></span> document.
+ </p>
+<a name="N1006E"></a><a name="faq-N1009D"></a>
+<h3 class="h4">11. XML parser conflict</h3>
+<pre class="code">
+ org/w3c/dom/DOMException
+ at org.Xindice.xml.dom.NodeImpl.<clinit>(NodeImpl.java:86)
+ at java.lang.Class.forName0(Native Method)
+ at java.lang.Class.forName(Class.java:120)
+ at org.apache.xerces.parsers.DOMParser.setDocumentClassNa
+ ...
+ </pre>
+<p>
+ This is also a common error one will encounter, and usually is
+ related to having more than one version of the Xerces XML Parser
+ on your CLASSPATH. Before running Xindice or any client programs,
+ be sure that the Xerces Jar file that is included in the Xindice
+ distribution is the first Xerces Jar file on your CLASSPATH.
+ </p>
+<a name="N1007A"></a><a name="faq-N100AD"></a>
+<h3 class="h4">12.
+ Where is my database?
+ </h3>
+<p>
+ Since Xindice 1.1 the database is running under an application
+ server (e.g. Tomcat). The database configuration is located at
+ [your webapps directory]/xindice/WEB-INF/system.xml (assuming
+ of course that your war was unpacked by the container).
+ </p>
+<p>
+ Xindice configuration, by default, uses "./db" as the database
+ location, which is assumed as a path relative to the webapp's
+ /WEB-INF location. This means that usually the database will
+ be located at [your webapps directory]/xindice/WEB-INF/db.
+ </p>
+<p>
+ This behaviour can be overridden in two ways: either by editing
+ /WEB-INF/system.xml and setting an absolute path as the "dbroot"
+ attribute of the "root-collection" tag, or by setting the Java
+ property "xindice.db.home" to a path that will be the parent for
+ the "./db" directory. As an example, setting the property on the
+ command line with a value of "/var/xindice"
+ (-Dxindice.db.home=/var/xindice) will mean that the database will
+ be found at /var/xindice/db.
+ </p>
+</div>
+</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/faq.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: xml/site/targets/xindice/1.2/faq.html
------------------------------------------------------------------------------
svn:keywords = Id Revision Author Date
Added: xml/site/targets/xindice/1.2/faq.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/faq.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.
Propchange: xml/site/targets/xindice/1.2/faq.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: xml/site/targets/xindice/1.2/guide-administrator.html
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-administrator.html?rev=602294&view=auto
==============================================================================
--- xml/site/targets/xindice/1.2/guide-administrator.html (added)
+++ xml/site/targets/xindice/1.2/guide-administrator.html Fri Dec 7 18:01:36 2007
@@ -0,0 +1,625 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Xindice 1.1 Administration 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="menupage">
+<div class="menupagetitle">Administrator Guide</div>
+</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="menuitem">
+<a href="../1.2/guide-tools.html">Tool Guide</a>
+</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-administrator.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>Xindice 1.1 Administration Guide</h1>
+<div class="abstract"></div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Database+Administration">Database Administration</a>
+<ul class="minitoc">
+<li>
+<a href="#Managing+Collections">Managing Collections</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="#Listing+the+Collections">Listing the Collections</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Managing+Indexes">Managing Indexes</a>
+<ul class="minitoc">
+<li>
+<a href="#Adding+an+Index">Adding an Index</a>
+</li>
+<li>
+<a href="#Indexing+both+Elements+and+Attributes">Indexing both Elements and Attributes</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Server+Administration">Server Administration</a>
+<ul class="minitoc">
+<li>
+<a href="#Installing+the+Server">Installing the Server</a>
+</li>
+<li>
+<a href="#Starting+the+Server">Starting the Server</a>
+<ul class="minitoc">
+<li>
+<a href="#Starting+the+Server+on+UNIX">Starting the Server on UNIX</a>
+</li>
+<li>
+<a href="#Starting+the+Server+on+Windows">Starting the Server on Windows</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Stopping+the+Server">Stopping the Server</a>
+<ul class="minitoc">
+<li>
+<a href="#Stopping+the+Server+on+UNIX">Stopping the Server on UNIX</a>
+</li>
+<li>
+<a href="#Stopping+the+Server+on+Windows">Stopping the Server on Windows</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Backing+up+Your+Data">Backing up Your Data</a>
+<ul class="minitoc">
+<li>
+<a href="#Backing+up+the+server">Backing up the server</a>
+</li>
+<li>
+<a href="#Restoring+the+Data">Restoring the Data</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Exporting+the+Contents+of+the+Database">Exporting the Contents of the Database</a>
+<ul class="minitoc">
+<li>
+<a href="#Exporting+the+database">Exporting the database</a>
+</li>
+<li>
+<a href="#Importing+the+database">Importing the database</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+
+<a name="N10022"></a><a name="Database+Administration"></a>
+<h2 class="h3">Database Administration</h2>
+<div class="section">
+<p>
+ Database administration of Xindice is accomplished from the command
+ line using the <span class="codefrag">xindice</span> command. This command
+ allows you to view and alter the database configuration on the fly
+ on a running system.
+ <!--
+ A complete list of available commands and more detail about each
+ command can be found in the <link href="guide-tools.html">Command
+ Line Tools Reference Guide</link>.
+ -->
+ </p>
+<a name="N10030"></a><a name="Managing+Collections"></a>
+<h3 class="h4">Managing Collections</h3>
+<p></p>
+<a name="N10038"></a><a name="Adding+a+Collection"></a>
+<h4>Adding a Collection</h4>
+<p>
+ Adds a collection named products under the collection /db/data.
+ </p>
+<pre class="code">xindice add_collection -c /db/data -n products</pre>
+<a name="N10046"></a><a name="Deleting+a+Collection"></a>
+<h4>Deleting a Collection</h4>
+<p>
+ Deletes the collection named products from the collection /db/data.
+ </p>
+<pre class="code">xindice delete_collection -c /db/data/products</pre>
+<a name="N10054"></a><a name="Listing+the+Collections"></a>
+<h4>Listing the Collections</h4>
+<p>
+ This will display a list of all child collections
+ under the collection /db/data
+ </p>
+<pre class="code">xindice list_collections -c /db/data</pre>
+<a name="N10063"></a><a name="Managing+Indexes"></a>
+<h3 class="h4">Managing Indexes</h3>
+<p>
+ The Xindice indexing system allows you to define indexes to speed
+ performance on commonly used XPath queries. If no indexes are defined
+ you can still execute queries but performance will suffer because
+ the query engine will need to scan the entire collection to create
+ the result node-set.
+ </p>
+<p>
+ Indexes can be added using the <span class="codefrag">xindice</span> command.
+ </p>
+<a name="N10072"></a><a name="Adding+an+Index"></a>
+<h4>Adding an Index</h4>
+<p>
+ Using this simple XML file you might want to index the product_id
+ element because searches for products by product_id are common.
+ </p>
+<pre class="code">
+ <?xml version="1.0"?>
+ <product>
+ <product_id>120320</product_id>
+ <description>Glazed Ham</description>
+ </product>
+ </pre>
+<p>
+ This can be accomplished by running the following command.
+ This will create an index named idindex on all product_id
+ elements in the collection /db/data/catalog.
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/data/catalog -n idindex -p product_id
+ </pre>
+<p>
+ Once this is done the query engine will now use this index to
+ help resolve XPath queries that involve restriction on the
+ value of the product_id element.
+ </p>
+<p>
+ The -p parameter to the command specifies the pattern to use in the
+ index. These patterns are used by the Indexing system to determine
+ best-fit and match-based Indexers for queries and index updating.
+ The pattern used MUST resemble the following scheme.
+ </p>
+<pre class="code">
+ Pattern Description
+ =========== ====================================================
+ elem The value of the named element
+ elem@attr The value of the attribute for the named element
+ * The value for all elements
+ *@attr The value of the named attribute for all elements
+ elem@* The value of all attributes for the named element
+ *@* The value of all attributes for all elements
+ </pre>
+<p>
+ Note: In order to index a namespace other than the default
+ namespace, you must prepend your pattern components with a
+ URI placed in square brackets. Example:
+ </p>
+<pre class="code">
+ [http://www.world.org/People]person
+ *@[http://www.world.org/People]id
+ [http://www.world.org/People]person@[http://www.world.org/People]id
+ </pre>
+<p>
+ Do not include a prefix in these patterns, as the indexing
+ system, like most Namespace processing applications, processes
+ namespaced elements and attributes independently of the prefix
+ that is used.
+ </p>
+<a name="N1009B"></a><a name="Indexing+both+Elements+and+Attributes"></a>
+<h4>Indexing both Elements and Attributes</h4>
+<p>
+ Because the patterns recognize either an element or an attribute,
+ and not both, in order to index all element and attribute values
+ in a collection, you'd have to create two index entries. The *
+ pattern will index all elements and the *@* pattern will index
+ all attributes of all elements.
+ </p>
+<pre class="code">
+ xindice add_indexer -c /db/data/catalog -n idindex -p '*'
+ xindice add_indexer -c /db/data/catalog -n idindex -p '*@*'
+ </pre>
+<p>
+ Excessive use of wildcard indexes can adversely affect the
+ performance of the indexing system. Best practice would be to use
+ specific element or attribute indexes whenever possible, and only
+ define wildcard indexes when it is absolutely necessary.
+ </p>
+</div>
+
+<a name="N100AE"></a><a name="Server+Administration"></a>
+<h2 class="h3">Server Administration</h2>
+<div class="section">
+<a name="N100B4"></a><a name="Installing+the+Server"></a>
+<h3 class="h4">Installing the Server</h3>
+<p>
+ Starting from 1.1, Xindice is not a standalone server anymore.
+ The server functions are now based on your favourite Servlet 2.2
+ (or 2.3) compliant Application Server. Xindice has been tested
+ and proven to work under both Tomcat and Jetty, but there is no
+ particular reason to expect malfunctions under other application
+ servers.
+ </p>
+<p>
+ Installation is then straightforward: just deploy the Xindice
+ WAR file (<span class="codefrag">xindice-1.1b3.war</span>) into your favourite
+ application server and you're ready to go. There are only two
+ minor points to be aware of:
+ </p>
+<ul>
+
+<li>
+ The Xindice XML-RPC endpoint is configured in the client
+ as <span class="codefrag">http://anyserver:anyport/xindice/</span>. This
+ means that it's strongly advisable to deploy the Xindice
+ WAR file under a <span class="codefrag">xindice</span> context. This can be
+ easily accomplished under Tomcat by simply renaming the WAR
+ file to <span class="codefrag">xindice.war</span> or (in Tomcat 4.1.x) by
+ copying the file <span class="codefrag">dist/xindice-1.1b3.xml</span> under
+ the <span class="codefrag">$TOMCAT_HOME/webapps</span> directory. Note that
+ under some Tomcat versions you will need to start twice the
+ server the first time so that Tomcat can configure itself
+ properly.
+ </li>
+
+<li>
+ You probably want to edit the Xindice configuration file
+ that resides under <span class="codefrag">/WEB-INF/system.xml</span>. This
+ file configures, among others, the physical location of the
+ database. By default, your data will be under
+ <span class="codefrag">[your_unpacked_war_location]/WEB-INF/db</span>, which
+ might not be a good idea for many users: leaving the
+ database as is will mean data loss if an upgrade takes place
+ inadvertently, since the directory will be overwritten.
+ Also, if your application server is not unpacking WARs,
+ Xindice won't be able to start.
+ </li>
+
+</ul>
+<p>
+ Having the server packaged as a webapp means also that
+ starting and stopping Xindice is "just" a matter of
+ starting/stopping the application server.
+ </p>
+<a name="N100E5"></a><a name="Starting+the+Server"></a>
+<h3 class="h4">Starting the Server</h3>
+<p>
+ Assuming that you have installed Xindice under Tomcat, and that you
+ have TOMCAT_HOME environment variable pointing to Tomcat installation
+ directory.
+ </p>
+<a name="N100EE"></a><a name="Starting+the+Server+on+UNIX"></a>
+<h4>Starting the Server on UNIX</h4>
+<pre class="code">
+ cd $TOMCAT_HOME/bin
+ ./startup.sh
+ </pre>
+<a name="N100F9"></a><a name="Starting+the+Server+on+Windows"></a>
+<h4>Starting the Server on Windows</h4>
+<pre class="code">
+ cd %TOMCAT_HOME%\bin
+ startup.bat
+ </pre>
+<a name="N10105"></a><a name="Stopping+the+Server"></a>
+<h3 class="h4">Stopping the Server</h3>
+<p>
+ To stop Xindice server, you just stop application server. Assuming
+ that you are using Tomcat.
+ </p>
+<a name="N1010E"></a><a name="Stopping+the+Server+on+UNIX"></a>
+<h4>Stopping the Server on UNIX</h4>
+<pre class="code">
+ cd $TOMCAT_HOME/bin
+ ./shutdown.sh
+ </pre>
+<a name="N10119"></a><a name="Stopping+the+Server+on+Windows"></a>
+<h4>Stopping the Server on Windows</h4>
+<pre class="code">
+ cd %TOMCAT_HOME%\bin
+ shutdown.bat
+ </pre>
+<a name="N10125"></a><a name="Backing+up+Your+Data"></a>
+<h3 class="h4">Backing up Your Data</h3>
+<a name="N1012B"></a><a name="Backing+up+the+server"></a>
+<h4>Backing up the server</h4>
+<p>
+ Just shutdown the application server and copy the db
+ directory structure somewhere else, e.g. using Tomcat and
+ the server version of Xindice with the default configuration:
+ </p>
+<pre class="code">
+ catalina.sh stop
+ cd $TOMCAT_HOME/webapps/xindice/WEB-INF
+ cp -pr db /backup/db
+ catalina.sh start
+ </pre>
+<a name="N10139"></a><a name="Restoring+the+Data"></a>
+<h4>Restoring the Data</h4>
+<p>
+ Restoring the data is simply removing the current database and
+ reversing the backup process.
+ Again, using Tomcat, this will be something like:
+ </p>
+<pre class="code">
+ catalina.sh stop
+ cd $TOMCAT_HOME/webapps/xindice/WEB-INF
+ rm -rf db
+ cp -pr /backup/db db
+ catalina.sh start
+ </pre>
+<a name="N10148"></a><a name="Exporting+the+Contents+of+the+Database"></a>
+<h3 class="h4">Exporting the Contents of the Database</h3>
+<p>
+ Xindice includes tools to export data to a directory hierarchy
+ and to also import data from a directory hierarchy. Each directory
+ in the hierachy corresponds to a collection in Xindice. Each XML
+ document is stored in a separate file named with the key from the
+ database.
+ </p>
+<a name="N10151"></a><a name="Exporting+the+database"></a>
+<h4>Exporting the database</h4>
+<p>
+ This example assumes that the Xindice/bin directory
+ is in your path.
+ </p>
+<pre class="code">
+ xindice export -c /db/root -f /path/to/data
+ </pre>
+<p>
+ The entire contents of the collection /db/root will be exported
+ to the directory /path/to/data.
+ </p>
+<a name="N10162"></a><a name="Importing+the+database"></a>
+<h4>Importing the database</h4>
+<p>
+ This example assumes that the Xindice/bin directory
+ is in your path.
+ </p>
+<pre class="code">
+ xindice import -c /db -f /path/to/data/root
+ </pre>
+<p>
+ Each directory under /path/to/data will be used to create a
+ collection and all XML documents in the hierarchy will be
+ imported in to the database. You can also restrict the documents
+ that are imported by adding -i and the extension of the files
+ you want to import.
+ </p>
+</div>
+
+<p align="right">
+<font size="-2">by Kimbro Staken, Gianugo Rabellino</font>
+</p>
+<span class="version">
+ version 596932</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-administrator.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: xml/site/targets/xindice/1.2/guide-administrator.html
------------------------------------------------------------------------------
svn:keywords = Id Revision Author Date
Added: xml/site/targets/xindice/1.2/guide-administrator.pdf
URL: http://svn.apache.org/viewvc/xml/site/targets/xindice/1.2/guide-administrator.pdf?rev=602294&view=auto
==============================================================================
Binary file - no diff available.
Propchange: xml/site/targets/xindice/1.2/guide-administrator.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