You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gora.apache.org by bu...@apache.org on 2017/08/15 05:53:49 UTC
svn commit: r1016814 - in /websites/staging/gora/trunk/content: ./
current/gora-aerospike.html current/index.html current/overview.html
Author: buildbot
Date: Tue Aug 15 05:53:49 2017
New Revision: 1016814
Log:
Staging update by buildbot for gora
Added:
websites/staging/gora/trunk/content/current/gora-aerospike.html
Modified:
websites/staging/gora/trunk/content/ (props changed)
websites/staging/gora/trunk/content/current/index.html
websites/staging/gora/trunk/content/current/overview.html
Propchange: websites/staging/gora/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Aug 15 05:53:49 2017
@@ -1 +1 @@
-1800489
+1805054
Added: websites/staging/gora/trunk/content/current/gora-aerospike.html
==============================================================================
--- websites/staging/gora/trunk/content/current/gora-aerospike.html (added)
+++ websites/staging/gora/trunk/content/current/gora-aerospike.html Tue Aug 15 05:53:49 2017
@@ -0,0 +1,293 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+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
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<html>
+<head>
+ <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="dev@gora.apache.org" />
+
+ <META http-equiv="Content-Type" content="text/html;charset=UTF-8" />
+ <META name="Description" content="Apache Gora -- Gora Aerospike Module" />
+ <META name="Keywords" content="Apache Gora NoSQL Framework" />
+ <META name="Owner" content="dev@gora.apache.org" />
+ <META name="Robots" content="index, follow" />
+ <META name="Security" content="Public" />
+ <META name="Source" content="wiki template" />
+ <META name="DC.Rights" content="Copyright 2010-2014, 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;
+ }
+ </style>
+ <link href="./../resources/css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="./../resources/css/gora.css" rel="stylesheet">
+
+ <style type="text/css">
+ .stpulldown-gradient
+ {
+ 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("http://gora.apache.org/resources/img/feather-small.png") no-repeat;
+ }
+ </style>
+ <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Fav and touch icons -->
+ <link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-144-precomposed.png">
+ <link rel="apple-touch-icon-precomposed" sizes="114x114" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-114-precomposed.png">
+ <link rel="apple-touch-icon-precomposed" sizes="72x72" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-72-precomposed.png">
+ <link rel="apple-touch-icon-precomposed" href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-57-precomposed.png">
+ <link rel="shortcut icon" href="./../resources/img/feather-small.png">
+
+ <!-- START SOCIAL MEDIA WIDGETS -->
+ <!-- Share This -->
+ <script type="text/javascript">var switchTo5x=true;</script>
+ <script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script>
+ <script type="text/javascript" src="http://s.sharethis.com/loader.js"></script>
+ <!-- END SOCIAL MEDIA WIDGETS -->
+ <title>Apache Gora™ - Gora Aerospike Module</title>
+</head>
+
+<body>
+ <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>
+ <a class="brand" href="./../index.html"><img src="./../resources/img/gora-logo.png" alt="Apache Gora" title="Apache Gora" style="width: 50%; height: 50%;"/></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="https://whimsy.apache.org/board/minutes/Gora.html">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>
+ </ul>
+ </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="https://cwiki.apache.org/confluence/display/GORA/">Gora Wiki</a></li>
+ <li><a href="http://en.wikipedia.org/wiki/Apache_Gora">Gora Wikipedia Entry</a></li>
+ </ul>
+ </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="https://issues.apache.org/jira/browse/GORA">Issue Tracking</a></li>
+ <li><a href="./../mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="https://builds.apache.org/view/All/job/gora-trunk/">Nightly Builds</a></li>
+ <li><a href="https://analysis.apache.org/dashboard/index/76356">Sonar Analysis</a></li>
+ <li><a href="./../version_control.html">Version Control</a></li>
+ <li><a href="./../roadmap.html">Roadmap</a></li>
+ </ul>
+ </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>
+ </a>
+ <ul class="dropdown-menu pull-right">
+ <li><a href="http://www.apache.org">Apache Home</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Support</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ </ul>
+ </li>
+ </ul>
+ <form id="search-form" class="navbar-search pull-right" action="http://www.google.com/cse" method="get">
+ <input value="gora.apache.org" name="sitesearch" type="hidden" />
+ <input class="search-query" name="q" id="query" type="text" />
+ </form>
+ <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+ </div> <!--/.nav-collapse -->
+ </div> <!-- /container -->
+ </div> <!-- /navbar-inner -->
+ </div> <!-- /navbar -->
+
+ <hr>
+
+ <div class="container" id="Gora_Gora Aerospike Module">
+
+<style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">¶</a></h2>
+<p>This is the main documentation for the gora-aerospike module. <b>gora-aerospike</b> module enables <a href="http://www.aerospike.com/">Aerospike</a> backend support for Gora.</p>
+<div class="toc">
+<ul>
+<li><a href="#overview">Overview</a></li>
+<li><a href="#goraproperties">gora.properties</a></li>
+<li><a href="#gora-aerospike-mappings">Gora Aerospike mappings</a></li>
+</ul>
+</div>
+<h2 id="goraproperties">gora.properties<a class="headerlink" href="#goraproperties" title="Permanent link">¶</a></h2>
+<ul>
+<li><code>gora.datastore.default=org.apache.gora.aerospike.store.AerospikeStore</code> - Implementation of the persistent Java storage class for Aerospike</li>
+<li><code>gora.aerospikestore.server.ip=localhost</code> - Property pointing to the host where the server is running</li>
+<li><code>gora.aerospikestore.server.port=3000</code> - Property pointing to the port where the server is running</li>
+<li><code>gora.datastore.mapping.file=gora-aerospike-mapping.xml</code> - The XML mapping file to be used. If no value is used this defaults to gora-aerospike-mapping.xml</li>
+<li><code>gora.aerospikestore.server.username=user_name</code> - An optional property defining the username of the server if available</li>
+<li><code>gora.aerospikestore.server.password=password</code> - An optional property defining the password of the server if available</li>
+</ul>
+<h2 id="gora-aerospike-mappings">Gora Aerospike mappings<a class="headerlink" href="#gora-aerospike-mappings" title="Permanent link">¶</a></h2>
+<p>You should then create a gora-aerospike-mapping.xml which will describe how you want to store each of your Gora persistent objects along with the read and write policies in Aerospike:</p>
+<div class="codehilite"><pre><span class="nt"><gora-otd></span>
+ <span class="nt"><policy</span> <span class="na">name=</span><span class="s">"write"</span> <span class="na">gen=</span><span class="s">"NONE"</span> <span class="na">recordExists=</span><span class="s">"UPDATE"</span> <span class="na">commitLevel=</span><span class="s">"COMMIT_ALL"</span> <span class="na">durableDelete=</span><span class="s">"false"</span><span class="nt">/></span>
+ <span class="nt"><policy</span> <span class="na">name=</span><span class="s">"read"</span> <span class="na">priority=</span><span class="s">"DEFAULT"</span> <span class="na">consistencyLevel=</span><span class="s">"CONSISTENCY_ONE"</span> <span class="na">replica=</span><span class="s">"SEQUENCE"</span> <span class="na">maxRetries=</span><span class="s">"2"</span><span class="nt">/></span>
+
+ <span class="nt"><class</span> <span class="na">name=</span><span class="s">"org.apache.gora.examples.generated.Employee"</span> <span class="na">keyClass=</span><span class="s">"java.lang.String"</span> <span class="na">set=</span><span class="s">"Employee"</span> <span class="na">namespace =</span> <span class="s">"test"</span><span class="nt">></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"name"</span> <span class="na">bin=</span><span class="s">"name"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"dateOfBirth"</span> <span class="na">bin=</span><span class="s">"dateOfBirth"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"ssn"</span> <span class="na">bin=</span><span class="s">"ssn"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"salary"</span> <span class="na">bin=</span><span class="s">"salary"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"boss"</span> <span class="na">bin=</span><span class="s">"boss"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"webpage"</span> <span class="na">bin=</span><span class="s">"webpage"</span><span class="nt">/></span>
+ <span class="nt"></class></span>
+<span class="nt"></gora-otd></span>
+</pre></div>
+
+
+<p>Here you can see that we require the definition of child elements within the <code>gora-otd</code> mapping configuration. We can define the classes and the policies.</p>
+<p>Each <b>class</b> element should contain the following elements; </p>
+<ol>
+<li>
+<p>a parameter defining the Persistent class name e.g. <b>org.apache.gora.examples.generated.Employee</b>, </p>
+</li>
+<li>
+<p>a parameter defining the keyClass e.g. <b>java.lang.String</b> which specifies the key which maps to the field values, </p>
+</li>
+<li>
+<p>a parameter defining the Aerospike set e.g. <b>Employee</b> which will be used to persist each Gora object,</p>
+</li>
+<li>
+<p>a parameter defining the Aerospike namespace e.g. <b>test</b> which will be used to persist each Gora object,</p>
+</li>
+</ol>
+<p>In addition, within the class field we should specify the fields and for which bin each field value maps to. We do not need to explicitly specify the type of each field, as the type is automatically detected in Aerospike server when creating the bin values. Thus each <b>field</b> should contain the field name and the corresponding bin it gets mapped to. e.g. <b> name="webpage" bin="webpage" </b></p>
+<p>Further, we can define the policies on reading and writing data from/to the server.</p>
+<p>Write policy can have following fields and each field values are the default values supported by <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/WritePolicy.html">Aerospike Write Policy API</a></p>
+<ol>
+<li>
+<p>gen - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/GenerationPolicy.html">generation policy</a> (values: EXPECT_GEN_EQUAL, EXPECT_GEN_GT, NONE) </p>
+</li>
+<li>
+<p>recordExists - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/RecordExistsAction.html">record exists action</a> (values: CREATE_ONLY, REPLACE, REPLACE_ONLY, UPDATE, UPDATE_ONLY)</p>
+</li>
+<li>
+<p>commitLevel - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/CommitLevel.html">commit level</a> (values: COMMIT_ALL, COMMIT_MASTER) </p>
+</li>
+<li>
+<p>durableDelete - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/WritePolicy.html#durableDelete">durable delete</a> (values: true, false) </p>
+</li>
+<li>
+<p>expiration - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/WritePolicy.html#expiration">record expiration</a> (values: 0, 10) </p>
+</li>
+</ol>
+<p>Read policy can have following fields and each field values are the default values supported by <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Policy.html">Aerospike Read Policy API</a></p>
+<ol>
+<li>
+<p>priority - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Priority.html">priority policy</a> (values: DEFAULT, HIGH, LOW, MEDIUM) </p>
+</li>
+<li>
+<p>consistencyLevel - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/ConsistencyLevel.html">consistency level</a> (values: CONSISTENCY_ALL, CONSISTENCY_ONE)</p>
+</li>
+<li>
+<p>replica - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Replica.html">replica</a> (values: MASTER, MASTER_PROLES, RANDOM, SEQUENCE) </p>
+</li>
+<li>
+<p>socketTimeout - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Policy.html#socketTimeout">socket timeout</a> (values: timeout in milliseconds) </p>
+</li>
+<li>
+<p>totalTimeout - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Policy.html#totalTimeout">total timeout</a> (values: timeout in milliseconds) </p>
+</li>
+<li>
+<p>timeoutDelay - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Policy.html#timeoutDelay">timeout delay</a> (values: timeout in milliseconds) </p>
+</li>
+<li>
+<p>maxRetries - <a href="https://www.aerospike.com/apidocs/java/com/aerospike/client/policy/Policy.html#maxRetries">max retries</a> (values: int of max num of retries) </p>
+</li>
+</ol>
+
+ </div> <!-- /container (main block) -->
+
+ <hr>
+
+ <div class="container">
+ <footer>
+ <p>Copyright © 2010-2015 The Apache Software Foundation. Licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.
+ </p>
+ <p>Apache Gora, Gora, Apache, the Apache feather logo, and the Apache Gora project logo are trademarks of The Apache Software Foundation.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ <!-- The javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js"; 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>
+ <script>
+ var options={ "publisher": "4059fafd-3891-49f9-8c96-e4100290d8e6", "scrollpx": 50, "ad": { "visible": false}, "chicklets": { "items": ["sharethis", "facebook", "twitter", "linkedin", "pinterest", "email", "googleplus"]}};
+ var st_pulldown_widget = new sharethis.widgets.pulldownbar(options);
+ </script>
+</body>
+</html>
Modified: websites/staging/gora/trunk/content/current/index.html
==============================================================================
--- websites/staging/gora/trunk/content/current/index.html (original)
+++ websites/staging/gora/trunk/content/current/index.html Tue Aug 15 05:53:49 2017
@@ -226,6 +226,7 @@ following modules are currently implemen
<li><a href="./gora-metamodel.html">gora-metamodel</a>: Module for <a href="http://metamodel.incubator.apache.org">Apache MetaModel</a> backend and query functionality;</li>
<li><a href="./gora-mongodb.html">gora-mongodb</a>: Module for <a href="http://www.mongodb.org/">MongoDB</a> backend and MongoStore implementation;</li>
<li><a href="./gora-solr.html">gora-solr</a>: Module for <a href="http://lucene.apache.org/solr">Apache Solr</a> backend and SolrStore implementation;</li>
+<li><a href="./gora-aerospike.html">gora-aerospike</a>: Module for <a href="http://www.aerospike.com/">Aerospike</a> backend and Aerospike implementation;</li>
<li><a href="./tutorial.html">gora-tutorial</a>: The Gora LogManager tutorial;</li>
<li>gora-sources-dist: Packaging module used to build and distribute Gora sources during project releases;</li>
</ul>
Modified: websites/staging/gora/trunk/content/current/overview.html
==============================================================================
--- websites/staging/gora/trunk/content/current/overview.html (original)
+++ websites/staging/gora/trunk/content/current/overview.html Tue Aug 15 05:53:49 2017
@@ -157,7 +157,18 @@ under the License.
<div class="container" id="Gora_Gora Module Overview">
-<h2 id="introduction">Introduction</h2>
+<style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h2>
<p>This is the main entry point for Gora documentation. Here are some pointers for further info:</p>
<ul>
<li>First if you haven't already done so, make sure to check the <a href="./quickstart.html">quick start guide</a>.</li>
@@ -166,7 +177,7 @@ under the License.
for all of the modules combined. We are always looking for <a href="../contribute.html">Documentation contributions</a>.</li>
</ul>
<p>You can find an abstract overview of how to configure Gora <a href="./gora-conf.html">here</a>.</p>
-<h2 id="gora-modules">Gora Modules</h2>
+<h2 id="gora-modules">Gora Modules<a class="headerlink" href="#gora-modules" title="Permanent link">¶</a></h2>
<p>Gora source code is organized in a modular architecture. The gora-core module
is the main module which contains the core of the code. All other modules depend
on the gora-core module.
@@ -184,6 +195,7 @@ following modules are currently implemen
<li><a href="./gora-hbase.html">gora-hbase</a>: Module for <a href="http://hbase.apache.org">Apache HBase</a> backend and HBaseStore implementation;</li>
<li><a href="./gora-sql.html">gora-sql</a>: Module for <a href="http://hsqldb.org/">HSQLDB</a> and <a href="http://www.mysql.com/">MySQL</a> backend and SqlStore implementation;</li>
<li><a href="./gora-mongodb.html">gora-mongodb</a>: Module for <a href="http://www.mongodb.org/">MongoDB</a> backend and MongoStore implementation;</li>
+<li><a href="./gora-aerospike.html">gora-aerospike</a>: Module for <a href="http://www.aerospike.com/">Aerospike</a> backend and Aerospike implementation;</li>
</ul>
</div> <!-- /container (main block) -->