You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by bu...@apache.org on 2012/07/19 00:22:00 UTC
svn commit: r826259 - in /websites/staging/jena/trunk/content: ./
documentation/tdb/commands.html
Author: buildbot
Date: Wed Jul 18 22:21:59 2012
New Revision: 826259
Log:
Staging update by buildbot for jena
Modified:
websites/staging/jena/trunk/content/ (props changed)
websites/staging/jena/trunk/content/documentation/tdb/commands.html
Propchange: websites/staging/jena/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Jul 18 22:21:59 2012
@@ -1 +1 @@
-1362060
+1363154
Modified: websites/staging/jena/trunk/content/documentation/tdb/commands.html
==============================================================================
--- websites/staging/jena/trunk/content/documentation/tdb/commands.html (original)
+++ websites/staging/jena/trunk/content/documentation/tdb/commands.html Wed Jul 18 22:21:59 2012
@@ -159,9 +159,13 @@
<h1 class="title">TDB Command-line Utilities</h1>
<h2 id="contents">Contents</h2>
<ul>
+<li><a href="#installation">Installation</a></li>
<li><a href="#scripts">Scripts</a><ul>
-<li><a href="#script-set-up">Script set up</a></li>
-<li><a href="#argument-structure">Argument Structure</a></li>
+<li><a href="#script-set-up-bash-scripts">Script set up - bash scripts</a></li>
+<li><a href="#script-set-up-windows-bash-files">Script set up - Windows batch files</a></li>
+</ul>
+</li>
+<li><a href="#command-line-script-arguments">Command line script arguments</a><ul>
<li><a href="#setting-options-from-the-command-line">Setting options from the command line</a></li>
</ul>
</li>
@@ -169,29 +173,56 @@
<li><a href="#store-description">Store description</a></li>
<li><a href="#tdbloader">tdbloader</a></li>
<li><a href="#tdbloader2">tdbloader2</a></li>
+<li><a href="#tdbloader3">tdbloader3</a></li>
<li><a href="#tdbquery">tdbquery</a></li>
<li><a href="#tdbdump">tdbdump</a></li>
<li><a href="#tdbstats">tdbstats</a></li>
</ul>
</li>
</ul>
+<h2 id="installation">Installation</h2>
+<p>From Apache Jena version <code>2.7.x</code> onwards, TDB is now installed as part of a single integrated Jena
+package. There is no longer a need to install a separate TDB package to run the TDB command line
+tools, or to use TDB in your Java programs. See the <a href="/download/">downloads</a> page for details on getting the latest Jena
+release.</p>
<h2 id="scripts">Scripts</h2>
-<p>The directory <code>bin/</code> contains shell scripts to run the commands
-from the command line. The scripts are bash scripts which also run
-over <a href="http://www.cygwin.com/" title="http://www.cygwin.com/">Cygwin</a>.</p>
-<h3 id="script-set-up">Script set up</h3>
-<p>Set the environment variable <code>TDBROOT</code> to the root of the the TDB
-installation.</p>
-<p>They are bash scripts, and work on Linux and Cygwin for MS
-Windows.</p>
-<div class="codehilite"><pre> <span class="nv">$</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$TDBROOT</span><span class="o">/</span><span class="n">bin:</span><span class="nv">$PATH</span>
+<p>From the location The directory <code>bin/</code> contains shell scripts to run the commands
+from the command line. The scripts are bash scripts which should work
+on Linux systems, Windows systems using <a href="http://www.cygwin.com/">Cygwin</a> and
+Mac/OS systems. The directory <code>bat/</code> contains Windows batch files which
+provide the same functionality for Windows systems that are not using
+Cygwin.</p>
+<h3 id="script-set-up-bash-scripts">Script set up - bash scripts</h3>
+<p>Set the environment variable <code>JENAROOT</code> to the root of the the Jena
+installation. E.g:</p>
+<div class="codehilite"><pre><span class="n">export</span> <span class="n">JENAROOT</span><span class="o">=</span><span class="sr">/home/som</span><span class="n">ebody</span><span class="sr">/dev/</span><span class="n">apache</span><span class="o">-</span><span class="n">jena</span>
+</pre></div>
+
+
+<p>or</p>
+<div class="codehilite"><pre><span class="n">export</span> <span class="n">JENAROOT</span><span class="o">=</span><span class="sr">/usr/</span><span class="nb">local</span><span class="o">/</span><span class="n">apache</span><span class="o">-</span><span class="n">jena</span>
+</pre></div>
+
+
+<p>Then set the <code>PATH</code> to include the <code>bin</code> directory:</p>
+<div class="codehilite"><pre><span class="n">PATH</span><span class="o">=</span><span class="nv">$TDBROOT</span><span class="o">/</span><span class="n">bin:</span><span class="nv">$PATH</span>
+</pre></div>
+
+
+<p>This can be done in <code>.bashrc</code>, or its equivalent on Mac OS/X, to ensure that the environment
+variables are always available.</p>
+<h3 id="script-set-up-windows-batch-files">Script set up - Windows batch files</h3>
+<p>Setting environment variables in Windows is slightly involved. You can set them
+each time you start a command prompt:</p>
+<div class="codehilite"><pre><span class="n">SET</span> <span class="n">JENAROOT</span><span class="o">=\</span><span class="n">Users</span><span class="o">\</span><span class="n">somebody</span><span class="o">\</span><span class="n">dev</span><span class="o">\</span><span class="n">apache</span><span class="o">-</span><span class="n">jena</span>
+<span class="n">SET</span> <span class="n">PATH</span><span class="o">=</span><span class="nv">%PATH%</span><span class="err">;%</span><span class="nv">JENAROOT</span><span class="o">\</span><span class="n">bin</span>
</pre></div>
-<p>Alternatively, there are wrapper scripts in <code>$TDBROOT/bin2</code> which
-can be placed in a convenient directory that is already on the
-shell command path.</p>
-<h3 id="argument-structure">Argument Structure</h3>
+<p>or you can follow <a href="http://searchsystemschannel.techtarget.com/feature/Setting-Windows-7-environment-variables">this guide</a>
+or one like it to set the environment variables so that they are available every
+time you launch the command prompt.</p>
+<h2 id="command-line-script-arguments">Command line script arguments</h2>
<p>Each command then has command-specific arguments described below.</p>
<p>All commands support <code>--help</code> to give details of named and
positional arguments.</p>
@@ -204,7 +235,7 @@ positional arguments.</p>
<h3 id="setting-options-from-the-command-line">Setting options from the command line</h3>
<p>TDB has a number of
-<a href="configuration.html" title="TDB/Configuration">configuration options</a>
+<a href="configuration.html">configuration options</a>
which can be set from the command line using:</p>
<div class="codehilite"><pre> <span class="o">--</span><span class="n">set</span> <span class="n">tdb:symbol</span><span class="o">=</span><span class="n">value</span>
</pre></div>
@@ -239,8 +270,15 @@ is assumed.</p>
<p>Bulk loader and index builder. Performans bulk load operations more
efficiently than simply reading RDF into a TDB-back model.</p>
<h3 id="tdbloader2"><code>tdbloader2</code></h3>
-<p>Bulk loader and index builder. Faster than tdbloader but only works
-on Linux and Mac OS/X.</p>
+<p>Bulk loader and index builder. Faster than <code>tdbloader</code> but only works
+on Linux and Mac OS/X since it relies on some Unix system utilities.</p>
+<p>This bulk loader can only be used to create a database. It may
+overwrite existing data. It only accepts the --loc argument and a
+list of files to load.</p>
+<h3 id="tdbloader3"><code>tdbloader3</code></h3>
+<p>Bulk loader and index builder. Faster than tdbloader3 but not as
+fast as <code>tdbloader2</code>, however it only requires Java so will work
+anywhere that Jena can be used.</p>
<p>This bulk loader can only be used to create a database. It may
overwrite existing data. It only accepts the --loc argument and a
list of files to load.</p>
@@ -249,15 +287,14 @@ list of files to load.</p>
information. The store is attached on each run of this command so
timing includes some overhead not present in a running system.</p>
<p>Details about query execution can be obtained -- see notes on the
-<a href="optimizer.html#Investigating_what_is_going_on" title="TDB/Optimizer">TDB Optimizer</a>.</p>
+<a href="optimizer.html#Investigating_what_is_going_on">TDB Optimizer</a>.</p>
<h3 id="tdbdump"><code>tdbdump</code></h3>
-<p>(Version 0.8.5)</p>
<p>Dump the store in
-<a href="http://sw.deri.org/2008/07/n-quads/" title="http://sw.deri.org/2008/07/n-quads/">N-Quads</a>
+<a href="http://sw.deri.org/2008/07/n-quads/">N-Quads</a>
format.</p>
<h3 id="tdbstats">tdbstats</h3>
<p>Produce a statistics for the dataset. See the
-<a href="optimizer.html#Statistics_Rule_File" title="TDB/Optimizer">TDB Optimizer description.</a>.</p>
+<a href="optimizer.html#Statistics_Rule_File">TDB Optimizer description.</a>.</p>
</div>
<div id="footer">