You are viewing a plain text version of this content. The canonical link for it is here.
Posted to xindice-dev@xml.apache.org by ks...@apache.org on 2002/02/26 09:35:03 UTC

cvs commit: xml-xindice/docs/src AdministratorsGuide.xml

kstaken     02/02/26 00:35:02

  Modified:    docs/src AdministratorsGuide.xml
  Log:
  Added some docs on import/export
  
  Revision  Changes    Path
  1.4       +40 -0     xml-xindice/docs/src/AdministratorsGuide.xml
  
  Index: AdministratorsGuide.xml
  ===================================================================
  RCS file: /home/cvs/xml-xindice/docs/src/AdministratorsGuide.xml,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- AdministratorsGuide.xml	26 Feb 2002 08:21:28 -0000	1.3
  +++ AdministratorsGuide.xml	26 Feb 2002 08:35:02 -0000	1.4
  @@ -16,7 +16,7 @@
            <year>2001</year>
            <holder>The Apache Software Foundation</holder>
         </copyright>
  -      <pubdate><![CDATA[$Id: AdministratorsGuide.xml,v 1.3 2002/02/26 08:21:28 kstaken Exp $]]></pubdate>
  +      <pubdate><![CDATA[$Id: AdministratorsGuide.xml,v 1.4 2002/02/26 08:35:02 kstaken Exp $]]></pubdate>
         <legalnotice>
            <para>
               This documentation is a work in progress. Links to the most current
  @@ -263,6 +263,46 @@
                  cp -pr /backup/db db
                  ./start
               </screen>
  +         </example>
  +      </sect1>
  +      <sect1>
  +         <title>Exporting the Contents of the Database</title>
  +         <para>
  +            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.
  +         </para>
  +
  +         <example>
  +            <title>Exporting the database</title>
  +            <para>
  +               This example assumes that the Xindice/bin directory
  +               is in your path.
  +            </para>
  +            <screen>
  +               xindiceadmin export -c /db/root -f /path/to/data
  +            </screen>
  +            <para>
  +                The entire contents of the collection /db/root will be exported to the 
  +                directory /path/to/data.
  +            </para>
  +         </example>
  +         <example>
  +            <title>Importing the database</title>
  +            <para>
  +               This example assumes that the Xindice/bin directory
  +               is in your path.
  +            </para>
  +            <screen>              
  +               xindiceadmin import -c /db -f /path/to/data/root              
  +            </screen>
  +            <para>
  +                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.
  +            </para>
            </example>
         </sect1>
      </chapter>