blob: 913fde08a7043c5d96577d0307666d743dd898ea [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="" />
<META http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<META name="Description" content="Apache Gora -- Gora Kudu Module" />
<META name="Keywords" content="Apache Gora NoSQL Framework" />
<META name="Owner" content="" />
<META name="Robots" content="index, follow" />
<META name="Security" content="Public" />
<META name="Source" content="wiki template" />
<META name="DC.Rights" content="Copyright 2010-2023, The Apache Software Foundation" />
<!-- The styles -->
<link href="/resources/css/bootstrap.css" rel="stylesheet">
<style type="text/css">
body {
padding-top: 60px;
padding-bottom: 40px;
.headerlink {
visibility: hidden;
dt:hover > .headerlink, p:hover > .headerlink, td:hover > .headerlink, h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink {
visibility: visible
} </style>
<link href="/resources/css/bootstrap-responsive.css" rel="stylesheet">
<link href="/resources/css/gora.css" rel="stylesheet">
<style type="text/css">
background: #E1E1E1;
background: -moz-linear-gradient(top, #E1E1E1 0%, #A7A7A7 100%); /* firefox */
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#E1E1E1), color-stop(100%,#A7A7A7)); /* webkit */
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#E1E1E1', endColorstr='#A7A7A7',GradientType=0 ); /* ie */
background: -o-linear-gradient(top, #E1E1E1 0%,#A7A7A7 100%); /* opera */
color: #636363;
#stpulldown .stpulldown-logo
height: 40px;
width: 300px;
margin-left: 20px;
margin-top: 5px;
background:url("") no-repeat;
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src=""></script>
<!-- Fav and touch icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="">
<link rel="apple-touch-icon-precomposed" href="">
<link rel="shortcut icon" href="/resources/img/feather-small.png">
<title>Apache Gora&trade; - Gora Kudu Module</title>
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<a class="brand" href="/index.html"><img src="/resources/img/gora-logo.png" alt="Apache Gora" title="Apache Gora"/></a>
<div class="nav-collapse collapse">
<ul class="nav">
<li><a href="/downloads.html">Downloads</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
<ul class="dropdown-menu pull-right">
<li><a href="">Board Reporting</a></li>
<li><a href="/contribute.html">Contribute</a></li>
<li><a href="/mailing_lists.html">Mailing Lists</a></li>
<li><a href="/credits.html">People</a></li>
<li><a href="/related.html">Related Projects</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu pull-right">
<li><a href="/about.html">About</a></li>
<li><a href="/current/index.html">Current Documentation</a></li>
<li><a href="/current/api/javadoc.html">JavaDoc Documentation</a></li>
<li><a href="/current/tutorial.html">Gora Tutorial</a></li>
<li><a href="">Gora Wiki</a></li>
<li><a href="">Gora Wikipedia Entry</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu pull-right">
<li><a href="">Issue Tracking</a></li>
<li><a href="/mailing_lists.html">Mailing Lists</a></li>
<li><a href="">Nightly Builds</a></li>
<li><a href="">Sonar Analysis</a></li>
<li><a href="/version_control.html">Version Control</a></li>
<li><a href="/roadmap.html">Roadmap</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<img src="/resources/img/feather-small.png" alt="Apache" title="Apache" />
<b class="caret"></b>
<ul class="dropdown-menu pull-right">
<li><a href="">Apache Home</a></li>
<li><a href="">Apache License</a></li>
<li><a href="">Security</a></li>
<li><a href="">Support</a></li>
<li><a href="">Thanks</a></li>
<form id="search-form" class="navbar-search pull-right" action="" method="get">
<input value="" name="sitesearch" type="hidden" />
<input class="search-query" name="q" id="query" type="text" />
<script type="text/javascript" src=""></script>
</div> <!--/.nav-collapse -->
</div> <!-- /container -->
</div> <!-- /navbar-inner -->
</div> <!-- /navbar -->
<div class="container top-buffer" id="Gora_Gora Kudu Module">
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permalink">&para;</a></h2>
<p>This is the main documentation for the gora-kudu module. <b>gora-kudu</b> module enables <a href="">Apache Kudu</a> backend support for Gora.</p>
<div id="toc"><ul><li><a class="toc-href" href="#gora-kudu-properties-goraproperties" title="Gora Kudu Properties -">Gora Kudu Properties -</a></li><li><a class="toc-href" href="#gora-kudu-mappings-gora-kudu-mappingxml" title="Gora Kudu mappings - gora-kudu-mapping.xml">Gora Kudu mappings - gora-kudu-mapping.xml</a><ul><li><a class="toc-href" href="#class" title="Class">Class</a></li><li><a class="toc-href" href="#table" title="Table">Table</a></li></ul></li><li><a class="toc-href" href="#supported-data-types" title="Supported Data types">Supported Data types</a></li></ul></div>
<h2 id="gora-kudu-properties-goraproperties">Gora Kudu Properties -<a class="headerlink" href="#gora-kudu-properties-goraproperties" title="Permalink">&para;</a></h2>
<li><code></code> - Implementation of the persistent Java storage class for Kudu</li>
<li><code>gora.datastore.kudu.masterAddresses=localhost:7051</code> - Comma-separated list of "host:port" pairs of the Kudu masters</li>
<li><code>gora.datastore.kudu.flushMode=AUTO_FLUSH_SYNC</code> - Flush mode for the Kudu-client session. More details here: <a href=""></a>.</li>
<li><code>gora.datastore.kudu.flushInterval=1000</code> - Flush interval in ms, which will be used for the next scheduling.</li>
<li><code>gora.datastore.kudu.bossCount=1</code> - Maximum number of boss threads. Optional. If not provided, 1 is used.</li>
<li><code>gora.datastore.kudu.defaultAdminOperationTimeoutMs=1000</code> - Default timeout used for administrative operations (e.g. createTable, deleteTable, etc). Optional. If not provided, defaults to 30s. A value of 0 disables the timeout.</li>
<li><code>gora.datastore.kudu.defaultOperationTimeoutMs=1000</code> - Default timeout used for user operations (using sessions and scanners). Optional. If not provided, defaults to 30s. A value of 0 disables the timeout.</li>
<li><code>gora.datastore.kudu.defaultSocketReadTimeoutMs=10000</code> - Default timeout to use when waiting on data from a socket. Optional. If not provided, defaults to 10s. A value of 0 disables the timeout.</li>
<li><code>gora.datastore.kudu.clientStatistics=true</code> - Client's collection of statistics. Statistics are enabled by default.</li>
<li><code>gora.datastore.kudu.workerCount=2</code> - Maximum number of worker threads. Optional. If not provided, (2 * the number of available processors) is used.</li>
<h2 id="gora-kudu-mappings-gora-kudu-mappingxml">Gora Kudu mappings - gora-kudu-mapping.xml<a class="headerlink" href="#gora-kudu-mappings-gora-kudu-mappingxml" title="Permalink">&para;</a></h2>
<p>You should then create a gora-kudu-mapping.xml which will describe how you want to store each of your Gora persistent objects and which primary keys you want to use:</p>
&lt;table name ="Employee"&gt;
&lt;primaryKey column="pkssn" type="STRING" /&gt;
&lt;hashPartition numBuckets="8"/&gt;
&lt;class name="org.apache.gora.examples.generated.Employee" keyClass="java.lang.String" table="Employee"&gt;
&lt;field name="ssn" column="ssn" type="STRING"/&gt;
&lt;field name="value" column="value" type="STRING"/&gt;
&lt;field name="name" column="name" type="STRING"/&gt;
&lt;field name="dateOfBirth" column="dateOfBirth" type="INT64"/&gt;
&lt;field name="salary" column="salary" type="INT32"/&gt;
&lt;field name="boss" column="boss" type="BINARY"/&gt;
&lt;field name="webpage" column="webpage" type="BINARY"/&gt;
<p>Here you can see that we require the definition of two child elements within the <code>gora-otd</code> mapping configuration: a class and a table.</p>
<h3 id="class">Class<a class="headerlink" href="#class" title="Permalink">&para;</a></h3>
<p>Each <b>class</b> element should contain the following elements;</p>
<p>a parameter defining the Persistent class name e.g. <b>org.apache.gora.examples.generated.Employee</b>,</p>
<p>a parameter defining the keyClass e.g. <b>java.lang.String</b> which specifies the key which maps to the field values,</p>
<p>a parameter defining the table e.g. <b>Employee</b> which will be used to persist each Gora object</p>
<p>In addition, within the class element we should define the fields to be mapped (field tag). The fields elements define the actual mapping between persistent object's attributes and the table's columns. These mapping have three customizable parameters: name which correspond to the object attribute's name. column which defines the column's name of the table to be associated with the attribute. And type which defines the data type of that column.</p>
<p>The DECIMAL data type is parameterizable, so two additional attributes might be used in the XML mapping, scale and precision. Example:</p>
<pre><code> &lt;field name="value" column="value" type="DECIMAL" scale=&rdquo;1&rdquo; precision=&rdquo;1&rdquo;/&gt;
<h3 id="table">Table<a class="headerlink" href="#table" title="Permalink">&para;</a></h3>
<p>Each <b>table</b> element should contain the following elements;</p>
<p>A <strong><code>primaryKey</code></strong> element defining which column is used by Kudu to identify the records stored in the DataStore. It has two attributes: <strong><code>column</code></strong> which defines the column's name of the table to be used as identifier for the records, and <strong><code>type</code></strong> which defines the data type of the aforementioned column.</p>
<p>A partition definition for the table, which could be either a hash partition or a range partition. For more information about Partitioning in Kudu refer to <a href=""></a></p>
<p>Example for Hash partition:</p>
<pre><code> &lt;hashPartition numBuckets="8"/&gt;
<p>The numBuckets attribute specifies the number of hash buckets to be used as partitions.</p>
<p>Example for Range partition:</p>
<pre><code> &lt;rangePartition lower="" upper ="1000"/&gt;
&lt;rangePartition lower="1000" upper =""/&gt;
<p>The lower and upper attributes define the boundaries of each partition. This partition is applied only on the primary key column of the table. Take into consideration that the lower bound is inclusive and the upper one is not.</p>
<h2 id="supported-data-types">Supported Data types<a class="headerlink" href="#supported-data-types" title="Permalink">&para;</a></h2>
<p>Description of supported <b>type</b> values:</p>
<table class="table">
<th>Kudu datatype</th>
<th>Java datatype</th>
<p>For more details about supported data types refer to <a href=""></a></p>
</div> <!-- /container (main block) -->
<div class="container">
<p>Copyright © 2010-2023 The Apache Software Foundation. Licensed under <a href="">Apache License 2.0</a>.
<p>Apache Gora, Gora, Apache, the Apache feather logo, and the Apache Gora project logo are trademarks of The Apache Software Foundation.
</div> <!-- /container -->
<!-- The javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src=""; type="text/javascript"></script>
<script src="/resources/js/bootstrap.min.js"></script>
<script type="text/javascript">stLight.options({publisher: "4059fafd-3891-49f9-8c96-e4100290d8e6", doNotHash: false, doNotCopy: false, hashAddressBar: false});</script>
<link rel="stylesheet" href="/resources/css/docco.css">
<script src="//"></script>