| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| |
| <title>Apache Jena - TDB Command-line Utilities</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <link href="/css/bootstrap.min.css" rel="stylesheet" media="screen"> |
| <link href="/css/bootstrap-extension.css" rel="stylesheet" type="text/css"> |
| <link href="/css/jena.css" rel="stylesheet" type="text/css"> |
| <link rel="shortcut icon" href="/images/favicon.ico" /> |
| |
| <script src="https://code.jquery.com/jquery-2.2.4.min.js" |
| integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" |
| crossorigin="anonymous"></script> |
| <script src="/js/jena-navigation.js" type="text/javascript"></script> |
| <script src="/js/bootstrap.min.js" type="text/javascript"></script> |
| |
| <script src="/js/improve.js" type="text/javascript"></script> |
| |
| |
| </head> |
| |
| <body> |
| |
| <nav class="navbar navbar-default" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="/index.html"> |
| <img class="logo-menu" src="/images/jena-logo/jena-logo-notext-small.png" alt="jena logo">Apache Jena</a> |
| </div> |
| |
| <div class="collapse navbar-collapse navbar-ex1-collapse"> |
| <ul class="nav navbar-nav"> |
| <li id="homepage"><a href="/index.html"><span class="glyphicon glyphicon-home"></span> Home</a></li> |
| <li id="download"><a href="/download/index.cgi"><span class="glyphicon glyphicon-download-alt"></span> Download</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-book"></span> Learn <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li class="dropdown-header">Tutorials</li> |
| <li><a href="/tutorials/index.html">Overview</a></li> |
| <li><a href="/documentation/fuseki2/index.html">Fuseki Triplestore</a></li> |
| <li><a href="/documentation/notes/index.html">How-To's</a></li> |
| <li><a href="/documentation/query/manipulating_sparql_using_arq.html">Manipulating SPARQL using ARQ</a></li> |
| <li><a href="/tutorials/rdf_api.html">RDF core API tutorial</a></li> |
| <li><a href="/tutorials/sparql.html">SPARQL tutorial</a></li> |
| <li><a href="/tutorials/using_jena_with_eclipse.html">Using Jena with Eclipse</a></li> |
| <li class="divider"></li> |
| <li class="dropdown-header">References</li> |
| <li><a href="/documentation/index.html">Overview</a></li> |
| <li><a href="/documentation/query/index.html">ARQ (SPARQL)</a></li> |
| <li><a href="/documentation/assembler/index.html">Assembler</a></li> |
| <li><a href="/documentation/tools/index.html">Command-line tools</a></li> |
| <li><a href="/documentation/rdfs/">Data with RDFS Inferencing</a></li> |
| <li><a href="/documentation/geosparql/index.html">GeoSPARQL</a></li> |
| <li><a href="/documentation/inference/index.html">Inference API</a></li> |
| <li><a href="/documentation/javadoc.html">Javadoc</a></li> |
| <li><a href="/documentation/ontology/">Ontology API</a></li> |
| <li><a href="/documentation/permissions/index.html">Permissions</a></li> |
| <li><a href="/documentation/extras/querybuilder/index.html">Query Builder</a></li> |
| <li><a href="/documentation/rdf/index.html">RDF API</a></li> |
| <li><a href="/documentation/rdfconnection/">RDF Connection - SPARQL API</a></li> |
| <li><a href="/documentation/io/">RDF I/O</a></li> |
| <li><a href="/documentation/rdfstar/index.html">RDF-star</a></li> |
| <li><a href="/documentation/shacl/index.html">SHACL</a></li> |
| <li><a href="/documentation/shex/index.html">ShEx</a></li> |
| <li><a href="/documentation/jdbc/index.html">SPARQL over JDBC</a></li> |
| <li><a href="/documentation/tdb/index.html">TDB</a></li> |
| <li><a href="/documentation/tdb2/index.html">TDB2</a></li> |
| <li><a href="/documentation/query/text-query.html">Text Search</a></li> |
| </ul> |
| </li> |
| |
| <li class="drop down"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-book"></span> Javadoc <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/documentation/javadoc.html">All Javadoc</a></li> |
| <li><a href="/documentation/javadoc/arq/">ARQ</a></li> |
| <li><a href="/documentation/javadoc_elephas.html">Elephas</a></li> |
| <li><a href="/documentation/javadoc/fuseki2/">Fuseki</a></li> |
| <li><a href="/documentation/javadoc/geosparql/">GeoSPARQL</a></li> |
| <li><a href="/documentation/javadoc/jdbc/">JDBC</a></li> |
| <li><a href="/documentation/javadoc/jena/">Jena Core</a></li> |
| <li><a href="/documentation/javadoc/permissions/">Permissions</a></li> |
| <li><a href="/documentation/javadoc/extras/querybuilder/">Query Builder</a></li> |
| <li><a href="/documentation/javadoc/shacl/">SHACL</a></li> |
| <li><a href="/documentation/javadoc/tdb/">TDB</a></li> |
| <li><a href="/documentation/javadoc/text/">Text Search</a></li> |
| </ul> |
| </li> |
| |
| <li id="ask"><a href="/help_and_support/index.html"><span class="glyphicon glyphicon-question-sign"></span> Ask</a></li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-bullhorn"></span> Get involved <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/getting_involved/index.html">Contribute</a></li> |
| <li><a href="/help_and_support/bugs_and_suggestions.html">Report a bug</a></li> |
| <li class="divider"></li> |
| <li class="dropdown-header">Project</li> |
| <li><a href="/about_jena/about.html">About Jena</a></li> |
| <li><a href="/about_jena/architecture.html">Architecture</a></li> |
| <li><a href="/about_jena/citing.html">Citing</a></li> |
| <li><a href="/about_jena/team.html">Project team</a></li> |
| <li><a href="/about_jena/contributions.html">Related projects</a></li> |
| <li><a href="/about_jena/roadmap.html">Roadmap</a></li> |
| <li class="divider"></li> |
| <li class="dropdown-header">ASF</li> |
| <li><a href="http://www.apache.org/">Apache Software Foundation</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li> |
| <li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li> |
| <li><a href="http://www.apache.org/security/">Security</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| </ul> |
| </li> |
| |
| |
| |
| |
| <li id="edit"><a href="https://github.com/apache/jena-site/edit/main/source/documentation/tdb/commands.md" title="Edit this page on GitHub"><span class="glyphicon glyphicon-pencil"></span> Edit this page</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-12"> |
| <div id="breadcrumbs"> |
| |
|
|
|
|
|
|
|
|
|
|
|
|
| <ol class="breadcrumb">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li><a href='/documentation'>DOCUMENTATION</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li><a href='/documentation/tdb'>TDB</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="active">COMMANDS</li>
|
|
|
|
|
|
|
|
|
| </ol>
|
|
|
|
|
|
|
| |
| |
| </div> |
| <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-bash-scripts">Script set up - bash scripts</a></li> |
| <li><a href="#script-set-up-windows-batch-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> |
| <li><a href="#tdb-commands">TDB Commands</a> |
| <ul> |
| <li><a href="#store-description">Store description</a></li> |
| <li><a href="#tdbloader">tdbloader</a></li> |
| <li><a href="#tdb-xloader">TDB xloader</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/index.cgi">downloads</a> page |
| for details on getting the latest Jena release.</p> |
| <h2 id="scripts">Scripts</h2> |
| <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">Script set up</h3> |
| <p>The TDB tools are included in the jena toolset. See the |
| <a href="../tools/">command line tools page</a>.</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> |
| <p>There are two equivalent forms of named argument syntax:</p> |
| <pre><code>--arg=val |
| |
| --arg val |
| </code></pre> |
| <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">configuration options</a> |
| which can be set from the command line using:</p> |
| <pre><code> --set tdb:symbol=value |
| </code></pre> |
| <p>Using tdb: is really a short hand for the URI prefix |
| <a href="http://jena.hpl.hp.com/TDB">http://jena.hpl.hp.com/TDB</a># so the full URI form is</p> |
| <pre><code> --set http://jena.hpl.hp.com/TDB#symbol=value |
| </code></pre> |
| <h2 id="tdb-commands">TDB Commands</h2> |
| <h3 id="store-description">Store description</h3> |
| <p>TDB commands use an assembler description for the persistent store</p> |
| <pre><code>--desc=assembler.ttl |
| --tdb=assembler.ttl |
| </code></pre> |
| <p>or a direct reference to the directory with the index and node |
| files:</p> |
| <pre><code>--loc=DIRECTORY |
| --location=DIRECTORY |
| </code></pre> |
| <p>The assembler description follow the form for a dataset given in |
| <a href="assembler.html" title="TDB/Assembler">TDB assembler description</a> page.</p> |
| <p>If neither assembler file nor location is given, <code>--desc=tdb.ttl</code> |
| is assumed.</p> |
| <h3 id="tdbloader"><code>tdbloader</code></h3> |
| <pre><code>tdbloader --loc /path/for/database ...input files ... |
| </code></pre> |
| <p>Input files can be any RDF syntax; triple formats (e.g. N-Triples, Turtle) |
| are loaded into the default graph, quad formats (e.g. N-Quads, TriG) |
| are loaded into the dataset according to the name or the default graph.</p> |
| <p>Bulk loader and index builder. Performs bulk load operations more |
| efficiently than simply reading RDF into a TDB-back model.</p> |
| <h3 id="tdb-xloader">tdb.xloader</h3> |
| <p><code>tdb1.xloader</code> and <code>tdb2.xloader</code> are bulk loaders for very large data for TDB1 |
| and TDB2.</p> |
| <p>See <a href="./tdb-xloader.html">TDB xloader</a> for more information. These loaders only |
| work on Linux since it relies on some Unix system utilities.</p> |
| <h3 id="tdbquery"><code>tdbquery</code></h3> |
| <p>Invoke a SPARQL query on a store. Use <code>--time</code> for timing |
| 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">TDB Optimizer</a>.</p> |
| <h3 id="tdbdump"><code>tdbdump</code></h3> |
| <p>Dump the store in |
| <a href="http://www.w3.org/TR/n-quads/">N-Quads</a> |
| format.</p> |
| <h3 id="tdbstats"><code>tdbstats</code></h3> |
| <p>Produce a statistics for the dataset. See the |
| <a href="optimizer.html#statistics-rule-file">TDB Optimizer description.</a>.</p> |
| <h3 id="tdbloader2"><code>tdbloader2</code></h3> |
| <p><em>This has been replace by <a href="./tdb-xloader.html">TDB xloader</a>.</em></p> |
| <p>This bulk loader can only be used to create a database. It may |
| overwrite existing data. It requires accepts the <code>--loc</code> argument and a |
| list of files to load e.g.</p> |
| <pre><code>tdbloader2 --loc /path/for/database input1.ttl input2.ttl ... |
| </code></pre> |
| <h4 id="advanced-tdbloader2-usage">Advanced <code>tdbloader2</code> Usage</h4> |
| <p>There are various other advanced options available to customise the |
| behaviour of the bulk loader. Run with <code>--help</code> to see the full usage |
| summary.</p> |
| <p>It is possible to do builds in phases by using the <code>tdbloader2data</code> and |
| <code>tdbloader2index</code> scripts separately though this should only be used |
| by advanced users. You can also do this by passing the <code>--phase</code> |
| argument to the <code>tdbloader2</code> script and specifying <code>data</code> or <code>index</code> as |
| desired.</p> |
| <p>The indexing phase of the build uses the <code>sort</code> utility to prepare the raw |
| data for indexing, this can potentially require large amounts of disk space |
| and the scripts will automatically check and warn/abort if the disk space |
| looks to be/is insufficient.</p> |
| <p>If you are building a large dataset (i.e. gigabytes of input data) you may |
| wish to have the <a href="http://www.ivarch.com/programs/pv.shtml">PipeViewer</a> |
| tool installed on your system as this will provide extra progress information |
| during the indexing phase of the build.</p> |
| |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <footer class="footer"> |
| <div class="container" style="font-size:80%" > |
| <p> |
| Copyright © 2011–2022 The Apache Software Foundation, Licensed under the |
| <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. |
| </p> |
| <p> |
| Apache Jena, Jena, the Apache Jena project logo, Apache and the Apache feather logos are trademarks of |
| The Apache Software Foundation. |
| <br/> |
| <a href="https://privacy.apache.org/policies/privacy-policy-public.html" |
| >Apache Software Foundation Privacy Policy</a>. |
| </p> |
| </div> |
| </footer> |
| |
| |
| <script type="text/javascript"> |
| var link = $('a[href="' + this.location.pathname + '"]'); |
| if (link != undefined) |
| link.parents('li,ul').addClass('active'); |
| </script> |
| |
| </body> |
| </html> |
