| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| |
| <title>Apache Jena - ARQ - Command Line Applications</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-icons.css" rel="stylesheet" media="screen"><link rel="stylesheet" type="text/css" href="https://jena.apache.org/sass/jena.1b17c39a117e22b46db4c66f6395dc27c134a60377d87d2d5745b8600eb69722.css" integrity="sha256-GxfDmhF+IrRttMZvY5XcJ8E0pgN32H0tV0W4YA62lyI="> |
| <link rel="shortcut icon" href="/images/favicon.ico" /> |
| |
| </head> |
| |
| <body> |
| |
| <nav class="navbar navbar-expand-lg bg-body-tertiary" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></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" id="navbarNav"> |
| <ul class="navbar-nav me-auto mb-2 mb-lg-0"> |
| <li id="homepage" class="nav-item"><a class="nav-link" href="/index.html"><span class="bi-house"></span> Home</a></li> |
| <li id="download" class="nav-item"><a class="nav-link" href="/download/index.cgi"><span class="bi-download"></span> Download</a></li> |
| <li class="nav-item dropdown"> |
| <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false"><span class="bi-journal"></span> Learn <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li class="dropdown-header">Tutorials</li> |
| <li><a class="dropdown-item" href="/tutorials/index.html">Overview</a></li> |
| <li><a class="dropdown-item" href="/documentation/fuseki2/index.html">Fuseki Triplestore</a></li> |
| <li><a class="dropdown-item" href="/documentation/notes/index.html">How-To's</a></li> |
| <li><a class="dropdown-item" href="/documentation/query/manipulating_sparql_using_arq.html">Manipulating SPARQL using ARQ</a></li> |
| <li><a class="dropdown-item" href="/tutorials/rdf_api.html">RDF core API tutorial</a></li> |
| <li><a class="dropdown-item" href="/tutorials/sparql.html">SPARQL tutorial</a></li> |
| <li><a class="dropdown-item" href="/tutorials/using_jena_with_eclipse.html">Using Jena with Eclipse</a></li> |
| <li class="dropdown-divider"></li> |
| <li class="dropdown-header">References</li> |
| <li><a class="dropdown-item" href="/documentation/index.html">Overview</a></li> |
| <li><a class="dropdown-item" href="/documentation/query/index.html">ARQ (SPARQL)</a></li> |
| <li><a class="dropdown-item" href="/documentation/io/">RDF I/O</a></li> |
| <li><a class="dropdown-item" href="/documentation/assembler/index.html">Assembler</a></li> |
| <li><a class="dropdown-item" href="/documentation/tools/index.html">Command-line tools</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdfs/">Data with RDFS Inferencing</a></li> |
| <li><a class="dropdown-item" href="/documentation/geosparql/index.html">GeoSPARQL</a></li> |
| <li><a class="dropdown-item" href="/documentation/inference/index.html">Inference API</a></li> |
| <li><a class="dropdown-item" href="/documentation/ontology/">Ontology API</a></li> |
| <li><a class="dropdown-item" href="/documentation/permissions/index.html">Permissions</a></li> |
| <li><a class="dropdown-item" href="/documentation/extras/querybuilder/index.html">Query Builder</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdf/index.html">RDF API</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdfconnection/">RDF Connection - SPARQL API</a></li> |
| <li><a class="dropdown-item" href="/documentation/rdfstar/index.html">RDF-star</a></li> |
| <li><a class="dropdown-item" href="/documentation/shacl/index.html">SHACL</a></li> |
| <li><a class="dropdown-item" href="/documentation/shex/index.html">ShEx</a></li> |
| <li><a class="dropdown-item" href="/documentation/tdb/index.html">TDB</a></li> |
| <li><a class="dropdown-item" href="/documentation/tdb2/index.html">TDB2</a></li> |
| <li><a class="dropdown-item" href="/documentation/query/text-query.html">Text Search</a></li> |
| </ul> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false"><span class="bi-journal-code"></span> Javadoc <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/documentation/javadoc.html">All Javadoc</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/arq/">ARQ</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/fuseki2/">Fuseki</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/geosparql/">GeoSPARQL</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/jena/">Jena Core</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/permissions/">Permissions</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/extras/querybuilder/">Query Builder</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/shacl/">SHACL</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/tdb/">TDB</a></li> |
| <li><a class="dropdown-item" href="/documentation/javadoc/text/">Text Search</a></li> |
| </ul> |
| </li> |
| </ul> |
| <form class="d-flex" role="search" action="/search" method="GET"> |
| <div class="input-group"> |
| <input class="form-control border-end-0 border m-0" type="search" name="q" id="search-query" placeholder="Search...." aria-label="Search" style="width: 10rem;"> |
| <button class="btn btn-outline-secondary border-start-0 border" type="submit"> |
| <i class="bi-search"></i> |
| </button> |
| </div> |
| </form> |
| <ul class="navbar-nav"> |
| <li id="ask" class="nav-item"><a class="nav-link" href="/help_and_support/index.html" title="Ask"><span class="bi-patch-question"></span><span class="text-body d-none d-xxl-inline"> Ask</span></a></li> |
| |
| <li class="nav-item dropdown"> |
| <a href="#" title="Get involved" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false"><span class="bi-megaphone"></span><span class="text-body d-none d-xxl-inline"> Get involved </span><b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/getting_involved/index.html">Contribute</a></li> |
| <li><a class="dropdown-item" href="/help_and_support/bugs_and_suggestions.html">Report a bug</a></li> |
| <li class="dropdown-divider"></li> |
| <li class="dropdown-header">Project</li> |
| <li><a class="dropdown-item" href="/about_jena/about.html">About Jena</a></li> |
| <li><a class="dropdown-item" href="/about_jena/architecture.html">Architecture</a></li> |
| <li><a class="dropdown-item" href="/about_jena/citing.html">Citing</a></li> |
| <li><a class="dropdown-item" href="/about_jena/team.html">Project team</a></li> |
| <li><a class="dropdown-item" href="/about_jena/contributions.html">Related projects</a></li> |
| <li><a class="dropdown-item" href="/about_jena/roadmap.html">Roadmap</a></li> |
| <li><a class="dropdown-item" href="/about_jena/security-advisories.html">Security Advisories</a></li> |
| <li class="dropdown-divider"></li> |
| <li class="dropdown-header">ASF</li> |
| <li><a class="dropdown-item" href="https://www.apache.org/">Apache Software Foundation</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/licenses/LICENSE-2.0">License</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/security/">Security</a></li> |
| <li><a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| </ul> |
| </li> |
| |
| |
| |
| |
| <li class="nav-item" id="edit"><a class="nav-link" href="https://github.com/apache/jena-site/edit/main/source/documentation/query/cmds.md" title="Edit this page on GitHub"><span class="bi-pencil-square"></span><span class="text-body d-none d-xxl-inline"> Edit this page</span></a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-12"> |
| |
| <div id="breadcrumbs"> |
|
|
|
|
|
|
|
|
|
|
|
|
| <ol class="breadcrumb mt-4 p-2 bg-body-tertiary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item"><a href='/documentation'>DOCUMENTATION</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item"><a href='/documentation/query'>QUERY</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item active">CMDS.HTML</li>
|
|
|
|
|
|
|
|
|
| </ol>
|
|
|
|
|
|
|
| |
| </div> |
| <h1 class="title">ARQ - Command Line Applications</h1> |
| |
| |
| <main class="d-flex flex-xl-row flex-column"> |
| |
| <aside class="text-muted align-self-start mb-3 p-0 d-xl-none d-block"> |
| <h2 class="h6 sticky-top m-0 p-2 bg-body-tertiary">On this page</h2> |
| <nav id="TableOfContents"> |
| <ul> |
| <li> |
| <ul> |
| <li><a href="#arqquery"><code>arq.query</code></a></li> |
| <li><a href="#arqqparse"><code>arq.qparse</code></a></li> |
| <li><a href="#arquparse"><code>arq.uparse</code></a></li> |
| <li><a href="#arqupdate"><code>arq.update</code></a></li> |
| <li><a href="#arqrset"><code>arq.rset</code></a></li> |
| <li><a href="#arqqexpr"><code>arq.qexpr</code></a></li> |
| <li><a href="#arqremote"><code>arq.remote</code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </aside> |
| <article class="flex-column me-lg-4"> |
| <p>The <code>arq</code> package contains some command line applications to run |
| queries, parse queries, process result sets and run test sets.</p> |
| <p>You will need to set the classpath, or use the helper scripts, to |
| run these applications from the command line. The helper scripts |
| are in <code>bin/</code> (Linux, Unix, Cygwin, OS/X) and <code>bat/</code> (Windows) |
| directories. There are ancillary scripts in the directories that |
| the main commands need - see <a href="../tools/index.html">the tools page</a> |
| for setup details.</p> |
| <p>The commands look for file <code>log4j2.properties</code> in the current directory, as well |
| as the usual log4j2 initialization with property <code>log4j.configurationFile</code> and |
| looking for classpath resource <code>log4j2.properties</code>; there is a default setup of |
| log4j2 built-in.</p> |
| <ul> |
| <li> |
| <p><a href="#arqquery"><code>arq.query</code></a> is the main query driver.</p> |
| </li> |
| <li> |
| <p><a href="#arqqparse"><code>arq.qparse</code></a> : parse and print a |
| SPARQL query.</p> |
| </li> |
| <li> |
| <p><a href="#arquparse"><code>arq.uparse</code></a> : parse and print a |
| SPARQL update.</p> |
| </li> |
| <li> |
| <p><a href="#arqupdate"><code>arq.update</code></a> : execute SPARQL/Update |
| requests.</p> |
| </li> |
| <li> |
| <p><a href="#arqremote"><code>arq.remote</code></a> : execute a query by |
| HTTP on a remote SPARQL endpoint.</p> |
| </li> |
| <li> |
| <p><a href="#arqrset"><code>arq.rset</code></a> : transform result sets.</p> |
| </li> |
| <li> |
| <p><a href="#arqqexpr"><code>arq.qexpr</code></a> : evaluate and print an |
| expression.</p> |
| </li> |
| </ul> |
| <p>All commands have a <code>--help</code> command for a summary of the |
| arguments.</p> |
| <p>When using a query in a file, if the query file ends .rq, it is |
| assumed to be a SPARQL query. If it ends .arq, it is assumed to be |
| an ARQ query (extensions to SPARQL). You can specify the syntax |
| explicitly.</p> |
| <h3 id="arqquery"><code>arq.query</code></h3> |
| <p>This is the main command for executing queries on data. The |
| wrappers just set the query language.</p> |
| <ul> |
| <li><code>arq.sparql</code> : wrapper for SPARQL queries</li> |
| <li><code>arq.arq</code> : wrapper for ARQ queries</li> |
| </ul> |
| <p>Running <code>arq.query --help</code> prints the usage message. The main |
| arguments are:</p> |
| <ul> |
| <li><code>--query FILE</code> : The file with the query to execute</li> |
| <li><code>--data FILE</code> : The data to query. It will be included in the |
| default graph.</li> |
| <li><code>--namedgraph FILE</code> : The data to query. It will be included as |
| a named graph.</li> |
| <li><code>--desc/--dataset</code>: |
| <a href="../assembler/">Jena Assembler description</a> of the |
| dataset to be queried, augmented with vocabulary for datasets, not |
| just graphs. See <code>etc/</code> for examples.</li> |
| </ul> |
| <p>The file extension is used to guess the file serialization format. |
| If a data file ends <code>.n3</code>, it is assumed to be N3; if it ends |
| <code>.ttl</code> is Turtle; if it is <code>.nt</code> is N-Triples; otherwise it is |
| assumed to be RDF/XML. The data serialization can be explicitly |
| specified on the command line.</p> |
| <h3 id="arqqparse"><code>arq.qparse</code></h3> |
| <p>Parse a query and print it out.</p> |
| <p><code>arq.qparse</code> will parse the query, print it out again (with line |
| numbers by default) and then parse the serialized query again. If |
| your query has a syntax error, a message is printed but no query is |
| printed. If a query is printed then you get a syntax error message, |
| then your query was syntactically correct but the ARQ serialization |
| is broken. Please report this.</p> |
| <p>The command <code>arq.qparse --print=op --file <i>queryFile</i></code>will |
| print the SPARQL algebra for the query in |
| <a href="../notes/sse.html">SSE format</a>.</p> |
| <h3 id="arquparse"><code>arq.uparse</code></h3> |
| <p>Parse a SPARQL update and print it out.</p> |
| <p><code>arq.uparse</code> will parse the update, print it out again (with line |
| numbers by default) and then parse the serialized update again. If |
| your update has a syntax error, a message is printed but no update is |
| printed. If a update is printed then you get a syntax error message, |
| then your query was syntactically correct but the ARQ serialization |
| is broken. Please report this.</p> |
| <h3 id="arqupdate"><code>arq.update</code></h3> |
| <p>Execute <a href="http://www.w3.org/TR/sparql11-update/">SPARQL Update</a> |
| requests.</p> |
| <ul> |
| <li><code>--desc</code>: |
| <a href="../assembler/">Jena Assembler description</a> of the |
| dataset or graph store to be updated. See <code>etc/</code> for examples.</li> |
| </ul> |
| <h3 id="arqrset"><code>arq.rset</code></h3> |
| <p>Read and write result sets.</p> |
| <p>In particular,</p> |
| <pre><code>java -cp ... arq.rset --in xml --out text |
| </code></pre> |
| <p>will translate a SPARQL XML Result Set into a tabular text form.</p> |
| <h3 id="arqqexpr"><code>arq.qexpr</code></h3> |
| <p>Read and print an expression (something that can go in a <code>FILTER</code> |
| clause). Indicates whether an evaluation exception occurred.</p> |
| <p>The <code>-v</code> argument prints the parsed expression.</p> |
| <h3 id="arqremote"><code>arq.remote</code></h3> |
| <p>Execute a request on a remote SPARQL endpoint using HTTP.</p> |
| <ul> |
| <li><code>--service URL</code> : The endpoint.</li> |
| <li><code>--data FILE</code> : Dataset description (default graph) added to |
| the request.</li> |
| <li><code>--namedgraph FILE</code> : Dataset description (named graph) added |
| to the request.</li> |
| <li><code>--results FORMAT</code> : Write results in specified format. Does |
| not change the request to the server which is always for an XML |
| form.</li> |
| </ul> |
| |
| </article> |
| |
| <aside class="text-muted align-self-start mb-3 mb-xl-5 p-0 d-none d-xl-flex flex-column sticky-top"> |
| <h2 class="h6 sticky-top m-0 p-2 bg-body-tertiary">On this page</h2> |
| <nav id="TableOfContents"> |
| <ul> |
| <li> |
| <ul> |
| <li><a href="#arqquery"><code>arq.query</code></a></li> |
| <li><a href="#arqqparse"><code>arq.qparse</code></a></li> |
| <li><a href="#arquparse"><code>arq.uparse</code></a></li> |
| <li><a href="#arqupdate"><code>arq.update</code></a></li> |
| <li><a href="#arqrset"><code>arq.rset</code></a></li> |
| <li><a href="#arqqexpr"><code>arq.qexpr</code></a></li> |
| <li><a href="#arqremote"><code>arq.remote</code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </aside> |
| </main> |
| |
| </div> |
| </div> |
| </div> |
| |
| <footer class="bd-footer py-4 py-md-5 mt-4 mt-lg-5 bg-body-tertiary"> |
| <div class="container" style="font-size:80%" > |
| <p> |
| Copyright © 2011–2024 The Apache Software Foundation, Licensed under the |
| <a href="https://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 src="/js/popper.min.js.js" type="text/javascript"></script> |
| <script src="/js/bootstrap.min.js" type="text/javascript"></script> |
| <script src="/js/improve.js" type="text/javascript"></script> |
| |
| <script type="text/javascript"> |
| (function() { |
| 'use strict' |
| |
| |
| |
| const links = document.querySelectorAll(`a[href="${window.location.pathname}"]`) |
| if (links !== undefined && links !== null) { |
| for (const link of links) { |
| |
| link.classList.add('active') |
| let parentElement = link.parentElement |
| let count = 0 |
| const levelsLimit = 4 |
| |
| |
| |
| |
| |
| while (['UL', 'LI'].includes(parentElement.tagName) && count <= levelsLimit) { |
| if (parentElement.tagName === 'LI') { |
| |
| |
| |
| parentElement.querySelector('a:first-child').classList.add('active') |
| } |
| parentElement = parentElement.parentElement |
| count++ |
| } |
| } |
| } |
| })() |
| </script> |
| |
| </body> |
| </html> |
