gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r925857 - in /websites/staging/gora/trunk/content: ./ current/gora-metamodule.html
Date Wed, 15 Oct 2014 16:07:54 GMT
Author: buildbot
Date: Wed Oct 15 16:07:54 2014
New Revision: 925857

Log:
Staging update by buildbot for gora

Added:
    websites/staging/gora/trunk/content/current/gora-metamodule.html
Modified:
    websites/staging/gora/trunk/content/   (props changed)

Propchange: websites/staging/gora/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Oct 15 16:07:54 2014
@@ -1 +1 @@
-1630238
+1632107

Added: websites/staging/gora/trunk/content/current/gora-metamodule.html
==============================================================================
--- websites/staging/gora/trunk/content/current/gora-metamodule.html (added)
+++ websites/staging/gora/trunk/content/current/gora-metamodule.html Wed Oct 15 16:07:54 2014
@@ -0,0 +1,354 @@
+<!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 MongoDB 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&trade; - Gora MongoDB 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>
+              </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 MongoDB Module">
+
+<h2 id="overview">Overview</h2>
+<p>This is the main documentation for the gora-mongodb module. gora-mongodb 
+module enables <a href="http://www.mongodb.org">MongoDB</a> backend support for
Gora.</p>
+<p>This module has been tested with MongoDB Server <a href="http://docs.mongodb.org/master/release-notes/2.4/">2.4.x</a>
+and <a href="http://docs.mongodb.org/master/release-notes/2.6/">2.6.x</a> series.
+It will connect to remote MongoDB server(s) using standard <a href="http://docs.mongodb.org/ecosystem/drivers/java/">Java
MongoDB Driver</a></p>
+<div class="toc">
+<ul>
+<li><a href="#overview">Overview</a></li>
+<li><a href="#goraproperties">gora.properties</a></li>
+<li><a href="#gora-mongodb-mappings">Gora MongoDB mappings</a></li>
+</ul>
+</div>
+<h2 id="goraproperties">gora.properties</h2>
+<p>Here is a following sample <code>gora.properties</code> file to enable
MongoStore:</p>
+<div class="codehilite"><pre><span class="c"># MongoDBStore properties</span>
+<span class="n">gora</span><span class="p">.</span><span class="n">datastore</span><span
class="p">.</span><span class="n">default</span><span class="p">=</span><span
class="n">org</span><span class="p">.</span><span class="n">apache</span><span
class="p">.</span><span class="n">gora</span><span class="p">.</span><span
class="n">mongodb</span><span class="p">.</span><span class="n">store</span><span
class="p">.</span><span class="n">MongoStore</span>
+<span class="n">gora</span><span class="p">.</span><span class="n">mongodb</span><span
class="p">.</span><span class="n">override_hadoop_configuration</span><span
class="p">=</span><span class="nb">false</span>
+<span class="n">gora</span><span class="p">.</span><span class="n">mongodb</span><span
class="p">.</span><span class="n">mapping</span><span class="p">.</span><span
class="n">file</span><span class="p">=</span><span class="o">/</span><span
class="n">gora</span><span class="o">-</span><span class="n">mongodb</span><span
class="o">-</span><span class="n">mapping</span><span class="p">.</span><span
class="n">xml</span>
+<span class="n">gora</span><span class="p">.</span><span class="n">mongodb</span><span
class="p">.</span><span class="n">servers</span><span class="p">=</span><span
class="n">localhost</span>
+<span class="n">gora</span><span class="p">.</span><span class="n">mongodb</span><span
class="p">.</span><span class="n">db</span><span class="p">=</span><span
class="n">sample</span>
+</pre></div>
+
+
+<p>Description of supported properties:</p>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Example value</th>
+<th>Required ?</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>gora.datastore.default</td>
+<td>org.apache.gora.mongodb.store.MongoStore</td>
+<td>Yes</td>
+<td>Implementation of the persistent Java storage class for MongoDB</td>
+</tr>
+<tr>
+<td>gora.mongodb.override_hadoop_configuration</td>
+<td>false</td>
+<td>No</td>
+<td>If true, it will allow properties to be overriden by configuration coming from
Hadoop</td>
+</tr>
+<tr>
+<td>gora.mongodb.mapping.file</td>
+<td>/gora-mongodb-mapping.xml</td>
+<td>No</td>
+<td>The XML mapping file to be used. If no value is used this defaults to gora-mongodb-mapping.xml</td>
+</tr>
+<tr>
+<td>gora.mongodb.servers</td>
+<td>localhost:27017</td>
+<td>Yes</td>
+<td>This value should specify the host:port for a running MongoDB node. Multiple values
have to be separated by a coma character.</td>
+</tr>
+<tr>
+<td>gora.mongodb.db</td>
+<td>mytestdatabase</td>
+<td>Yes</td>
+<td>This value should specify the database for storage of documents.</td>
+</tr>
+<tr>
+<td>gora.mongodb.login</td>
+<td>login</td>
+<td>No</td>
+<td>Login that will be used to authenticate against MongoDB server. If blank, driver
won't try authentication.</td>
+</tr>
+<tr>
+<td>gora.mongodb.secret</td>
+<td>password</td>
+<td>No</td>
+<td>Secret that will be used to authenticate against MongoDB server.</td>
+</tr>
+</tbody>
+</table>
+<h2 id="gora-mongodb-mappings">Gora MongoDB mappings</h2>
+<p>You should then create a <code>gora-mongodb-mapping.xml</code> which
will describe <b>how</b> you want to
+store each of your Gora persistent objects:</p>
+<div class="codehilite"><pre><span class="nt">&lt;gora-otd&gt;</span>
+
+    <span class="nt">&lt;class</span> <span class="na">name=</span><span
class="s">&quot;org.apache.gora.examples.generated.Employee&quot;</span>
<span class="na">keyClass=</span><span class="s">&quot;java.lang.String&quot;</span>
<span class="na">document=</span><span class="s">&quot;employees&quot;</span><span
class="nt">&gt;</span>
+        <span class="nt">&lt;field</span> <span class="na">name=</span><span
class="s">&quot;name&quot;</span> <span class="na">docfield=</span><span
class="s">&quot;name&quot;</span> <span class="na">type=</span><span
class="s">&quot;string&quot;</span><span class="nt">/&gt;</span>
+        <span class="nt">&lt;field</span> <span class="na">name=</span><span
class="s">&quot;dateOfBirth&quot;</span> <span class="na">docfield=</span><span
class="s">&quot;dateOfBirth&quot;</span> <span class="na">type=</span><span
class="s">&quot;int64&quot;</span><span class="nt">/&gt;</span>
+        <span class="nt">&lt;field</span> <span class="na">name=</span><span
class="s">&quot;ssn&quot;</span> <span class="na">docfield=</span><span
class="s">&quot;ssn&quot;</span> <span class="na">type=</span><span
class="s">&quot;string&quot;</span><span class="nt">/&gt;</span>
+        <span class="nt">&lt;field</span> <span class="na">name=</span><span
class="s">&quot;salary&quot;</span> <span class="na">docfield=</span><span
class="s">&quot;salary&quot;</span> <span class="na">type=</span><span
class="s">&quot;int32&quot;</span><span class="nt">/&gt;</span>
+        <span class="nt">&lt;field</span> <span class="na">name=</span><span
class="s">&quot;boss&quot;</span> <span class="na">docfield=</span><span
class="s">&quot;boss&quot;</span> <span class="na">type=</span><span
class="s">&quot;document&quot;</span><span class="nt">/&gt;</span>
+        <span class="nt">&lt;field</span> <span class="na">name=</span><span
class="s">&quot;webpage&quot;</span> <span class="na">docfield=</span><span
class="s">&quot;webpage&quot;</span> <span class="na">type=</span><span
class="s">&quot;document&quot;</span><span class="nt">/&gt;</span>
+    <span class="nt">&lt;/class&gt;</span>
+
+<span class="nt">&lt;/gora-otd&gt;</span>
+</pre></div>
+
+
+<p>Each <b>class</b> element specifying persistent fields which values
should map to. This element contains; </p>
+<ol>
+<li>
+<p>a parameter containing the Persistent class name e.g. <b>org.apache.gora.examples.generated.Employee</b>,
</p>
+</li>
+<li>
+<p>a parameter containing the keyClass e.g. <b>java.lang.String</b> which
specifies the keys which map to the field values, </p>
+</li>
+<li>
+<p>a parameter containing the MongoDB collection e.g. <b>employees</b>
which will be used to persist each Gora object,</p>
+</li>
+<li>
+<p>finally a child element(s) <b>field</b> which represent all fields which
are to be persisted into MongoDB.
+   These need to be configured such that they receive the following;</p>
+<p>a <b>name</b> attribute e.g. (name, dateOfBirth, ssn and salary respectively)
which map to Gora field name, </p>
+<p>a <b>docfield</b> attribute containing the field's name in mapped Mongo
document, </p>
+<p>a <b>type</b> attribute which allow transformation of Gora types into
native MongoDB types.
+MongoDB use <a href="bsonspec.org">BSON</a> is a binary serialization format
to store documents
+and make remote procedure calls. </p>
+<p>Description of supported <b>type</b> values:</p>
+</li>
+</ol>
+<table>
+<thead>
+<tr>
+<th>Type value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>BINARY</td>
+<td>Store as binary data</td>
+</tr>
+<tr>
+<td>BOOLEAN</td>
+<td>Store as boolean value</td>
+</tr>
+<tr>
+<td>INT32</td>
+<td>Store as signed 32-bit integer</td>
+</tr>
+<tr>
+<td>INT64</td>
+<td>Store as signed 64-bit integer</td>
+</tr>
+<tr>
+<td>DOUBLE</td>
+<td>Store as floating point</td>
+</tr>
+<tr>
+<td>STRING</td>
+<td>Store as UTF-8 string</td>
+</tr>
+<tr>
+<td>DATE</td>
+<td>Store as UTC datetime (ISODate)</td>
+</tr>
+<tr>
+<td>LIST</td>
+<td>Store as Array</td>
+</tr>
+<tr>
+<td>DOCUMENT</td>
+<td>Store as embedded document</td>
+</tr>
+<tr>
+<td>OBJECTID</td>
+<td>Store as ObjectId (12-byte)</td>
+</tr>
+</tbody>
+</table>
+
+  </div> <!-- /container (main block) -->
+
+  <hr>
+
+  <div class="container">
+    <footer>
+      <p>Copyright © 2010-2014 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>



Mime
View raw message