| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| |
| <title>Apache Jena - Txn - A library for working with Transactions</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/txn/txn.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/txn'>TXN</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="breadcrumb-item active">TXN.HTML</li>
|
|
|
|
|
|
|
|
|
| </ol>
|
|
|
|
|
|
|
| |
| </div> |
| <h1 class="title">Txn - A library for working with Transactions</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><a href="#transactions">Transactions</a></li> |
| <li><a href="#usage">Usage</a></li> |
| <li><a href="#working-with-rdf-models">Working with RDF Models</a></li> |
| <li><a href="#autocommit-and-transaction-continuation">Autocommit and Transaction continuation</a></li> |
| <li><a href="#design">Design</a></li> |
| </ul> |
| </nav> |
| </aside> |
| <article class="flex-column me-lg-4"> |
| <p><code>Txn</code> provides a high level interface to Jena transactions. It is a |
| library over the core functionality - applications do not have to use <code>Txn</code> |
| to use transactions.</p> |
| <p>Features:</p> |
| <ul> |
| <li>Java8 idioms</li> |
| <li>Application exceptions cause transaction aborts.</li> |
| <li>“Transaction continuation” - use any existing active transaction.</li> |
| <li>Autocommit - ensure actions are inside a transaction even if none is active.</li> |
| </ul> |
| <h2 id="transactions">Transactions</h2> |
| <p>The <a href="basic_txn_api.html">basic transactions API</a> provides operations |
| <code>begin</code>, <code>commit</code>, <code>abort</code> and <code>end</code>.</p> |
| <p>A write transaction looks like:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">begin</span><span style="color:#666">(</span>ReadWrite<span style="color:#666">.</span><span style="color:#b44">write</span><span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#a2f;font-weight:bold">try</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">...</span> write operations <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span> dataset<span style="color:#666">.</span><span style="color:#b44">commit</span><span style="color:#666">()</span> <span style="color:#666">;</span> <span style="color:#080;font-style:italic">// Or abort |
| </span></span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic"></span><span style="color:#666">}</span> <span style="color:#a2f;font-weight:bold">finally</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> dataset<span style="color:#666">.</span><span style="color:#b44">end</span><span style="color:#666">()</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">}</span> |
| </span></span></code></pre></div><p>This can be simplified by wrapping application code, contained in a Java lambda |
| expression or a Java Runnable object, and calling a method of the dataset or |
| other transactional object. This wil apply the correct entry and exit code for |
| a transaction, eliminating coding errors.</p> |
| <p>This is also available via transactional objects such as <code>Dataset</code>.</p> |
| <p>The pattern is:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">executeRead</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">.</span> <span style="color:#666">.</span> <span style="color:#666">.</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>and</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">executeWrite</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">.</span> <span style="color:#666">.</span> <span style="color:#666">.</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>The form is:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Txn<span style="color:#666">.</span><span style="color:#b44">executeRead</span><span style="color:#666">(</span>ds<span style="color:#666">,</span> <span style="color:#666">()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">.</span> <span style="color:#666">.</span> <span style="color:#666">.</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>and</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Txn<span style="color:#666">.</span><span style="color:#b44">executeWrite</span><span style="color:#666">(</span>ds<span style="color:#666">,</span> <span style="color:#666">()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">.</span> <span style="color:#666">.</span> <span style="color:#666">.</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>is also available (<code>Txn</code> is the implementation of this machinery). Using Txn is |
| this way is necessary for Jena3.</p> |
| <h2 id="usage">Usage</h2> |
| <p>This first example shows how to write a SPARQL query .</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>Query query <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">executeRead</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">try</span><span style="color:#666">(</span>QueryExecution qExec <span style="color:#666">=</span> QueryExecutionFactory<span style="color:#666">.</span><span style="color:#b44">create</span><span style="color:#666">(</span>query<span style="color:#666">,</span> dataset<span style="color:#666">))</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> ResultSetFormatter<span style="color:#666">.</span><span style="color:#b44">out</span><span style="color:#666">(</span>qExec<span style="color:#666">.</span><span style="color:#b44">execSelect</span><span style="color:#666">())</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>Here, a <code>try-with-resources</code> ensures correct handling of the |
| <code>QueryExecution</code> inside a read transaction.</p> |
| <p>Writing to a file is a read-action (it does not update the RDF data, the |
| writer needs to read the dataset or model):</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">executeRead</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> RDFDataMgr<span style="color:#666">.</span><span style="color:#b44">write</span><span style="color:#666">(</span>System<span style="color:#666">.</span><span style="color:#b44">out</span><span style="color:#666">,</span> dataset<span style="color:#666">,</span> Lang<span style="color:#666">.</span><span style="color:#b44">TRIG</span><span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>whereas reading data into an RDF dataset needs to be a write transaction |
| (the dataset or model is changed).</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">executeWrite</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> RDFDataMgr<span style="color:#666">.</span><span style="color:#b44">read</span><span style="color:#666">(</span><span style="color:#b44">"data.ttl"</span><span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>Applications are not limited to a single operation inside a transaction. It |
| can involve multiple applications read operations, such as making several |
| queries:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>Query query1 <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>Query query2 <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>dataset<span style="color:#666">.</span><span style="color:#b44">executeRead</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">try</span><span style="color:#666">(</span>QueryExecution qExec1 <span style="color:#666">=</span> QueryExecutionFactory<span style="color:#666">.</span><span style="color:#b44">create</span><span style="color:#666">(</span>query1<span style="color:#666">,</span> dataset<span style="color:#666">))</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">try</span><span style="color:#666">(</span>QueryExecution qExec2 <span style="color:#666">=</span> QueryExecutionFactory<span style="color:#666">.</span><span style="color:#b44">create</span><span style="color:#666">(</span>query2<span style="color:#666">,</span> dataset<span style="color:#666">))</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span></code></pre></div><p>A <code>calculateRead</code> block can return a result but only with the condition |
| that what is returned does not touch the data again unless it uses a new |
| transaction.</p> |
| <p>This includes returning a result set or returning a model from a dataset.</p> |
| <p><code>ResultSets</code> by default stream - each time <code>hasNext</code> or <code>next</code> is |
| called, new data might be read from the RDF dataset. A copy of the |
| results needs to be taken:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>Query query <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>List<span style="color:#666"><</span>String<span style="color:#666">></span> results <span style="color:#666">=</span> dataset<span style="color:#666">.</span><span style="color:#b44">calculateRead</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#666"><</span>String<span style="color:#666">></span> accumulator <span style="color:#666">=</span> <span style="color:#a2f;font-weight:bold">new</span> ArrayList<span style="color:#666"><>()</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">try</span><span style="color:#666">(</span>QueryExecution qExec <span style="color:#666">=</span> QueryExecutionFactory<span style="color:#666">.</span><span style="color:#b44">create</span><span style="color:#666">(</span>query<span style="color:#666">,</span> dataset<span style="color:#666">))</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> qExec<span style="color:#666">.</span><span style="color:#b44">execSelect</span><span style="color:#666">().</span><span style="color:#b44">forEachRemaining</span><span style="color:#666">((</span>row<span style="color:#666">)->{</span> |
| </span></span><span style="display:flex;"><span> String strThisRow <span style="color:#666">=</span> row<span style="color:#666">.</span><span style="color:#b44">getLiteral</span><span style="color:#666">(</span><span style="color:#b44">"variable"</span><span style="color:#666">).</span><span style="color:#b44">getLexicalForm</span><span style="color:#666">()</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> accumulator<span style="color:#666">.</span><span style="color:#b44">add</span><span style="color:#666">(</span>strThisRow<span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">return</span> accumulator <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic">// use "results" |
| </span></span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic"></span> |
| </span></span><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>Query query <span style="color:#666">=</span> <span style="color:#666">...</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span>ResultSet List<span style="color:#666"><</span>String<span style="color:#666">></span> resultSet <span style="color:#666">=</span> dataset<span style="color:#666">.</span><span style="color:#b44">calculateRead</span><span style="color:#666">(()-></span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#666"><</span>String<span style="color:#666">></span> accumulator <span style="color:#666">=</span> <span style="color:#a2f;font-weight:bold">new</span> ArrayList<span style="color:#666"><>()</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">try</span><span style="color:#666">(</span>QueryExecution qExec <span style="color:#666">=</span> QueryExecutionFactory<span style="color:#666">.</span><span style="color:#b44">create</span><span style="color:#666">(</span>query<span style="color:#666">,</span> dataset<span style="color:#666">))</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">return</span> ResultSetFactory<span style="color:#666">.</span><span style="color:#b44">copyResults</span><span style="color:#666">(</span>qExec<span style="color:#666">.</span><span style="color:#b44">execSelect</span><span style="color:#666">())</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">})</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic">// use "resultSet" |
| </span></span></span></code></pre></div><p>The functions <code>execute</code> and <code>calculate</code> start <code>READ_PROMOTE</code> |
| transactions which start in “read” mode but convert to “write” mode if |
| needed. For details of transaction promotion see the |
| <a href="transactions_api.html#types-modes-promotion">section in the transaction API documentation</a>.</p> |
| <h2 id="working-with-rdf-models">Working with RDF Models</h2> |
| <p>The unit of transaction is the dataset. Model in datasets are just views of that dataset. |
| Model should not be passed out of a transaction because they are still attached to the |
| dataset.</p> |
| <h2 id="autocommit-and-transaction-continuation">Autocommit and Transaction continuation</h2> |
| <p>If there is a transaction already started for the thread, then |
| <code>execute...</code> or <code>calculate...</code> will be performed as part of |
| the transaction and that transaction is not terminated. If there is not transaction already started, |
| a transaction is wrapped around the <code>execute...</code> or <code>calculate...</code> action.</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Dataset dataset <span style="color:#666">=</span> <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic">// Main transaction. |
| </span></span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic"></span>dataset<span style="color:#666">.</span><span style="color:#b44">begin</span><span style="color:#666">(</span>ReadWrite<span style="color:#666">.</span><span style="color:#b44">WRITE</span><span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#a2f;font-weight:bold">try</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#080;font-style:italic">// Part of the transaction above. |
| </span></span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic"></span> dataset<span style="color:#666">.</span><span style="color:#b44">executeRead</span><span style="color:#666">(()</span> <span style="color:#666">-></span> <span style="color:#666">...)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#080;font-style:italic">// Part of the transaction above - no commit/abort |
| </span></span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic"></span> dataset<span style="color:#666">.</span><span style="color:#b44">executeWrite</span><span style="color:#666">(()</span> <span style="color:#666">-></span> <span style="color:#666">...)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#080;font-style:italic">// Outer transaction |
| </span></span></span><span style="display:flex;"><span><span style="color:#080;font-style:italic"></span> dataset<span style="color:#666">.</span><span style="color:#b44">commit</span><span style="color:#666">()</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">}</span> <span style="color:#a2f;font-weight:bold">finally</span> <span style="color:#666">{</span> dataset<span style="color:#666">.</span><span style="color:#b44">end</span><span style="color:#666">()</span> <span style="color:#666">;</span> <span style="color:#666">}</span> |
| </span></span></code></pre></div><h2 id="design">Design</h2> |
| <p><code>Txn</code> uses Java <code>Runnable</code> for the application code, passed into control code |
| that wraps the transaction operations around the application code. This results |
| in application code automatically applied transaction begin/commit/end as needed.</p> |
| <p>A bare read transaction requires the following code structure (no exception handling):</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>txn<span style="color:#666">.</span><span style="color:#b44">begin</span><span style="color:#666">(</span>ReadWrite<span style="color:#666">.</span><span style="color:#b44">READ</span><span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#a2f;font-weight:bold">try</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#666">...</span> application code <span style="color:#666">...</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">}</span> <span style="color:#a2f;font-weight:bold">finally</span> <span style="color:#666">{</span> txn<span style="color:#666">.</span><span style="color:#b44">end</span><span style="color:#666">()</span> <span style="color:#666">;</span> <span style="color:#666">}</span> |
| </span></span></code></pre></div><p>while a write transaction requires either a <code>commit</code> or an <code>abort</code> |
| at the end of the application code as well.</p> |
| <p>Without the transaction continuation code (simplified, the <code>Txn</code> code |
| for a read transaction takes the form:</p> |
| <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#a2f;font-weight:bold">public</span> <span style="color:#a2f;font-weight:bold">static</span> <span style="color:#666"><</span>T <span style="color:#a2f;font-weight:bold">extends</span> Transactional<span style="color:#666">></span> <span style="color:#0b0;font-weight:bold">void</span> <span style="color:#00a000">executeRead</span><span style="color:#666">(</span>T txn<span style="color:#666">,</span> Runnable r<span style="color:#666">)</span> <span style="color:#666">{</span> |
| </span></span><span style="display:flex;"><span> txn<span style="color:#666">.</span><span style="color:#b44">begin</span><span style="color:#666">(</span>ReadWrite<span style="color:#666">.</span><span style="color:#b44">READ</span><span style="color:#666">)</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">try</span> <span style="color:#666">{</span> r<span style="color:#666">.</span><span style="color:#b44">run</span><span style="color:#666">()</span> <span style="color:#666">;</span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#a2f;font-weight:bold">catch</span> <span style="color:#666">(</span>Throwable th<span style="color:#666">)</span> <span style="color:#666">{</span> txn<span style="color:#666">.</span><span style="color:#b44">end</span><span style="color:#666">()</span> <span style="color:#666">;</span> <span style="color:#a2f;font-weight:bold">throw</span> th <span style="color:#666">;</span> <span style="color:#666">}</span> |
| </span></span><span style="display:flex;"><span> txn<span style="color:#666">.</span><span style="color:#b44">end</span><span style="color:#666">()</span> <span style="color:#666">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#666">}</span> |
| </span></span></code></pre></div><p>See <a href="https://github.com/apache/jena/blob/main/jena-arq/src/main/java/org/apache/jena/query/Txn.java"><code>Txn.java</code></a> for full details.</p> |
| |
| </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><a href="#transactions">Transactions</a></li> |
| <li><a href="#usage">Usage</a></li> |
| <li><a href="#working-with-rdf-models">Working with RDF Models</a></li> |
| <li><a href="#autocommit-and-transaction-continuation">Autocommit and Transaction continuation</a></li> |
| <li><a href="#design">Design</a></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> |