gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r919849 - in /websites/staging/gora/trunk/content: ./ current/gora-conf.html current/gora-mongodb.html current/index.html current/overview.html
Date Tue, 19 Aug 2014 20:59:28 GMT
Author: buildbot
Date: Tue Aug 19 20:59:28 2014
New Revision: 919849

Log:
Staging update by buildbot for gora

Modified:
    websites/staging/gora/trunk/content/   (props changed)
    websites/staging/gora/trunk/content/current/gora-conf.html
    websites/staging/gora/trunk/content/current/gora-mongodb.html
    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 19 20:59:28 2014
@@ -1 +1 @@
-1618249
+1618981

Modified: websites/staging/gora/trunk/content/current/gora-conf.html
==============================================================================
--- websites/staging/gora/trunk/content/current/gora-conf.html (original)
+++ websites/staging/gora/trunk/content/current/gora-conf.html Tue Aug 19 20:59:28 2014
@@ -183,6 +183,7 @@ Data store implementation in Gora distri
   <tr><td><b>SolrStore</b></td> <td><code>org.apache.gora.solr.store.SolrStore</code></td>
<td>gora-solr</td> <td> A DataStore implementation for Apache Solr.</td></tr>
   <tr><td><b>MemStore</b></td> <td><code>org.apache.gora.memory.store.MemStore</td>
<td>gora-core</td> <td> Memory based DataStore implementation for tests.
</td></tr>
   <tr><td><b>Dynamodb</b></td> <td><code>org.apache.gora.dynamodb.store.DyanmoDBStore</td>
<td>gora-dynamodb</td> <td> Webservices-based datastore implementation for
Amazon's DynamoDB. </td></tr>
+  <tr><td><b>MongoStore</b></td> <td><code>org.apache.gora.mongodb.store.MongoStore</td>
<td>gora-mongodb</td> <td> A DataStore implementation for MongoDB document
storage. </td></tr>
 </table>
 
 <p>Some of the properties can be customized per datastore. The format of these 
@@ -209,6 +210,7 @@ own configurations. These properties are
 <li><a href="./gora-solr.html">Gora Solr Module</a></li>
 <li><a href="./gora-accumulo.html">Gora Accumulo Module</a></li>
 <li><a href="./gora-dynamodb.html">Gora DynamoDB Module</a></li>
+<li><a href="./gora-mongodb.html">Gora MongoDB Module</a></li>
 </ul>
 
   </div> <!-- /container (main block) -->

Modified: websites/staging/gora/trunk/content/current/gora-mongodb.html
==============================================================================
--- websites/staging/gora/trunk/content/current/gora-mongodb.html (original)
+++ websites/staging/gora/trunk/content/current/gora-mongodb.html Tue Aug 19 20:59:28 2014
@@ -158,6 +158,9 @@ under the License. 
 <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>
@@ -166,9 +169,161 @@ module enables <a href="http://www.mongo
 </ul>
 </div>
 <h2 id="goraproperties">gora.properties</h2>
-<p>Coming soon</p>
+<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>Coming soon </p>
+<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) -->
 

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 19 20:59:28 2014
@@ -183,7 +183,7 @@ following modules are currently implemen
 <li><a href="./gora-dynamodb.html">gora-dynamodb</a>: Module for <a
href="http://aws.amazon.com/dynamodb/">Amazon DynamoDB</a> backend and DynamoDBStore
implementation;</li>
 <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-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-mongodb.html">gora-mongodb</a>: Module for <a href="http://www.mongodb.org/">MongoDB</a>
backend and MongoDBStore 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>
 </ul>
 <p>We currently have modules under development for <a href="http://www.oracle.com/technetwork/database/database-technologies/nosqldb/overview/index.html">Oracle
NoSQL</a> and <a href="http://lucene.apache.org">Apache Lucene</a>.</p>
 

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 19 20:59:28 2014
@@ -181,6 +181,7 @@ following modules are currently implemen
 <li><a href="./gora-dynamodb.html">gora-dynamodb</a>: Module for <a
href="http://aws.amazon.com/dynamodb/">Amazon DynamoDB</a> backend and DynamoDBStore
implementation;</li>
 <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>
 </ul>
 
   </div> <!-- /container (main block) -->



Mime
View raw message