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 2018/11/11 18:47:52 UTC
svn commit: r1036844 - in /websites/staging/gora/trunk/content: ./
current/gora-ignite.html current/index.html
Author: buildbot
Date: Sun Nov 11 18:47:52 2018
New Revision: 1036844
Log:
Staging update by buildbot for gora
Added:
websites/staging/gora/trunk/content/current/gora-ignite.html
Modified:
websites/staging/gora/trunk/content/ (props changed)
websites/staging/gora/trunk/content/current/index.html
Propchange: websites/staging/gora/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Nov 11 18:47:52 2018
@@ -1 +1 @@
-1830009
+1846356
Added: websites/staging/gora/trunk/content/current/gora-ignite.html
==============================================================================
--- websites/staging/gora/trunk/content/current/gora-ignite.html (added)
+++ websites/staging/gora/trunk/content/current/gora-ignite.html Sun Nov 11 18:47:52 2018
@@ -0,0 +1,291 @@
+<!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 Ignite 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">
+
+ <title>Apache Gora™ - Gora Ignite 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"/></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 -->
+
+ <div class="container top-buffer" id="Gora_Gora Ignite 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-ignite module. <b>gora-ignite</b> module enables <a href="https://ignite.apache.org/">Apache Ignite</a> backend support for Gora.</p>
+<div class="toc">
+<ul>
+<li><a href="#overview">Overview</a></li>
+<li><a href="#gora-ignite-properties-goraproperties">Gora Ignite Properties - gora.properties</a></li>
+<li><a href="#gora-ignite-mappings-gora-ignite-mappingxml">Gora Ignite mappings - gora-ignite-mapping.xml</a></li>
+<li><a href="#supported-data-types">Supported Data types</a></li>
+</ul>
+</div>
+<h2 id="gora-ignite-properties-goraproperties">Gora Ignite Properties - gora.properties<a class="headerlink" href="#gora-ignite-properties-goraproperties" title="Permanent link">¶</a></h2>
+<ul>
+<li><code>gora.datastore.default=org.apache.gora.ignite.store.IgniteStore</code> - Implementation of the persistent Java storage class for Ignite</li>
+<li><code>gora.datastore.ignite.schema=PUBLIC</code> - Property pointing to the Schema of the Ignite instance </li>
+<li><code>gora.datastore.ignite.host=localhost</code> - Property pointing to the host where the server is running</li>
+<li><code>gora.datastore.ignite.port=10800</code> - Property pointing to the port where the server is running</li>
+<li><code>gora.datastore.ignite.user=username</code> - An optional property defining the username of the server if available</li>
+<li><code>gora.datastore.ignite.password=password</code> - An optional property defining the password of the server if available</li>
+<li><code>gora.datastore.ignite.additionalConfigurations=</code> - An optional property defining additional configurations for the Ignite connection, format and available parameters: <a href="https://apacheignite-sql.readme.io/docs/jdbc-driver#section-parameters">Ignite JDBC Parameters</a></li>
+</ul>
+<h2 id="gora-ignite-mappings-gora-ignite-mappingxml">Gora Ignite mappings - gora-ignite-mapping.xml<a class="headerlink" href="#gora-ignite-mappings-gora-ignite-mappingxml" title="Permanent link">¶</a></h2>
+<p>You should then create a gora-ignite-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>
+<div class="codehilite"><pre><span class="nt"><gora-otd></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">table=</span><span class="s">"Employee"</span><span class="nt">></span>
+ <span class="nt"><primarykey</span> <span class="na">column=</span><span class="s">"pkssn"</span> <span class="na">type=</span><span class="s">"VARCHAR"</span> <span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"ssn"</span> <span class="na">column=</span><span class="s">"ssn"</span> <span class="na">type=</span><span class="s">"VARCHAR"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"name"</span> <span class="na">column=</span><span class="s">"name"</span> <span class="na">type=</span><span class="s">"VARCHAR"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"dateOfBirth"</span> <span class="na">column=</span><span class="s">"dateOfBirth"</span> <span class="na">type=</span><span class="s">"BIGINT"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"salary"</span> <span class="na">column=</span><span class="s">"salary"</span> <span class="na">type=</span><span class="s">"INT"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"boss"</span> <span class="na">column=</span><span class="s">"boss"</span> <span class="na">type=</span><span class="s">"BINARY"</span><span class="nt">/></span>
+ <span class="nt"><field</span> <span class="na">name=</span><span class="s">"webpage"</span> <span class="na">column=</span><span class="s">"webpage"</span> <span class="na">type=</span><span class="s">"BINARY"</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.</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 table e.g. <b>Employee</b> which will be used to persist each Gora object</p>
+</li>
+</ol>
+<p>In addition, within the class element we should define two type of child elements: a primary key (<b>primarykey</b> tag) and some fields (<b>field</b> tag).</p>
+<p>The primary key element defines which column is used by Ignite to identify the records stored in the DataStore. It has two costumizable parameters: <b>column</b> which defines the column's name of the table to be used as identifier for the records. And <b>type</b> which defines the data type of the aforementioned column.</p>
+<p>The fields elements define the actual mapping between persistent object's attributes and the table's columns. These mapping have three customizable parameters: <b>name</b> which correspond to the object attribute's name. <b>column</b> which defines the column's name of the table to be assosiated with the attribute. And <b>type</b> which defines the data type of that column.</p>
+<p>Notice that complex structures such 3-union fields are mapped using Binary fields through <a href="https://avro.apache.org/">Avro</a> serialization.</p>
+<h2 id="supported-data-types">Supported Data types<a class="headerlink" href="#supported-data-types" title="Permanent link">¶</a></h2>
+<p>Description of supported <b>type</b> values:</p>
+<table class="table">
+<thead>
+<tr>
+<th>Type value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>BINARY</td>
+<td>Store as Byte[]</td>
+</tr>
+<tr>
+<td>BOOLEAN</td>
+<td>Store as Boolean</td>
+</tr>
+<tr>
+<td>INT</td>
+<td>Store as Integer</td>
+</tr>
+<tr>
+<td>TINYINT</td>
+<td>Store as Byte</td>
+</tr>
+<tr>
+<td>SMALLINT</td>
+<td>Store as Short</td>
+</tr>
+<tr>
+<td>BIGINT</td>
+<td>Store as Long</td>
+</tr>
+<tr>
+<td>DECIMAL</td>
+<td>Store as BigDecimal</td>
+</tr>
+<tr>
+<td>DOUBLE</td>
+<td>Store as Double</td>
+</tr>
+<tr>
+<td>REAL</td>
+<td>Store as Float</td>
+</tr>
+<tr>
+<td>VARCHAR</td>
+<td>Store as Unicode string</td>
+</tr>
+</tbody>
+</table>
+<p>A more detailed list of data types supported by Ignite and its equivalents in Java refer to <a href="https://apacheignite-sql.readme.io/docs/data-types">Ignite JDBC Data types</a></p>
+
+ </div> <!-- /container (main block) -->
+
+ <hr>
+
+ <div class="container">
+ <footer>
+ <p>Copyright © 2010-2018 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>
+</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 Sun Nov 11 18:47:52 2018
@@ -215,6 +215,7 @@ following modules are currently implemen
<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="./gora-ignite.html">gora-ignite</a>: Module for <a href="https://ignite.apache.org/">Apache Ignite</a> backend and IgniteStore 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>