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 2014/07/18 18:07:01 UTC

svn commit: r916684 - in /websites/staging/gora/trunk/content: ./ current/gora-core.html

Author: buildbot
Date: Fri Jul 18 16:07:01 2014
New Revision: 916684

Log:
Staging update by buildbot for gora

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

Propchange: websites/staging/gora/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jul 18 16:07:01 2014
@@ -1 +1 @@
-1611671
+1611683

Modified: websites/staging/gora/trunk/content/current/gora-core.html
==============================================================================
--- websites/staging/gora/trunk/content/current/gora-core.html (original)
+++ websites/staging/gora/trunk/content/current/gora-core.html Fri Jul 18 16:07:01 2014
@@ -168,66 +168,123 @@ core <strong>MapReduce</strong>, <strong
 <ul>
 <li><a href="#overview">Overview</a></li>
 <li><a href="#avrostore">AvroStore</a><ul>
+<li><a href="#description">Description</a></li>
 <li><a href="#goraproperties">gora.properties</a></li>
-<li><a href="#to-configure-the-datafileavrostore-one-would-typically-set-the-following">To configure the DataFileAvroStore one would typically set the following:</a></li>
-<li><a href="#gora-core-mappings">Gora Core mappings</a></li>
+<li><a href="#avrostore-xml-mappings">AvroStore XML mappings</a></li>
 </ul>
 </li>
-<li><a href="#avrostore_1">AvroStore</a><ul>
+<li><a href="#datafileavrostore">DataFileAvroStore</a><ul>
+<li><a href="#description_1">Description</a></li>
 <li><a href="#goraproperties_1">gora.properties</a></li>
-<li><a href="#to-configure-the-datafileavrostore-one-would-typically-set-the-following_1">To configure the DataFileAvroStore one would typically set the following:</a></li>
-<li><a href="#gora-core-mappings_1">Gora Core mappings</a></li>
+<li><a href="#gora-core-mappings">Gora Core mappings</a></li>
 </ul>
 </li>
-<li><a href="#avrostore_2">AvroStore</a><ul>
+<li><a href="#memstore">MemStore</a><ul>
 <li><a href="#goraproperties_2">gora.properties</a></li>
-<li><a href="#to-configure-the-datafileavrostore-one-would-typically-set-the-following_2">To configure the DataFileAvroStore one would typically set the following:</a></li>
-<li><a href="#gora-core-mappings_2">Gora Core mappings</a></li>
+<li><a href="#memstore-xml-mappings">MemStore XML mappings</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <h1 id="avrostore">AvroStore</h1>
+<h2 id="description">Description</h2>
+<p>AvroStore can be used for binary-compatible Avro serializations. It supports Binary and JSON serializations.</p>
 <h2 id="goraproperties">gora.properties</h2>
 <p>To configure the AvroStore one would typically set the following:
-<em> gora.avrostore.output.path=hdfs://uri/path/to/hdfs/data/directory || file:///uri/path/to/local/data/directory - This value should point to the hdfs data directory (if running Gora in a distributed Hadoop environment) or to some location on the local file system (if running Gora locally). 
-</em> gora.avrostore.xxx=xxx - xyz</p>
-<h2 id="to-configure-the-datafileavrostore-one-would-typically-set-the-following">To configure the DataFileAvroStore one would typically set the following:</h2>
-<ul>
-<li>gora.datafileavrostore.xxx=xxx - xyz </li>
-<li>gora.datafileavrostore.xxx=xxx - xyz</li>
-</ul>
-<p>To configure the MemStore one would typically set the following:
-* gora.memstore.xxx=xxx - xyz</p>
-<h2 id="gora-core-mappings">Gora Core mappings</h2>
+ * <code>g</code>= - 
+ * <code></code>= -<br />
+ * <code></code>=</p>
+<table class="table">
+  <thead>
+   <tr>
+    <th align="left">Property Key</th>
+    <th align="left">Property Value</th> 
+    <th align="left">Required</th>
+    <th align="left">Description</th>
+   </tr>
+  </thead>
+  <tbody>
+   <tr>
+    <td>gora.datastore.default=</td>
+    <td>org.apache.gora.avro.store.AvroStore</td>
+    <td>Yes</td>
+    <td>Implementation of the persistent Java storage class</td>
+   </tr>
+   <tr>
+    <td>gora.avrostore.input.path=</td>
+    <td>*hdfs://uri/path/to/hdfs/input/path* || *file:///uri/path/to/local/input/path*</td>
+    <td>Yes</td>
+    <td>This value should point to the input directory on hdfs (if running Gora in a distributed Hadoop environment) or to some location input directory on the local file system (if running Gora locally).</td>
+   </tr>
+   <tr>
+    <td>gora.avrostore.output.path=</td>
+    <td>*hdfs://uri/path/to/hdfs/output/path* || *file:///uri/path/to/local/output/path*</td>
+    <td>Yes</td>
+    <td>This value should point to the output directory on hdfs (if running Gora in a distributed Hadoop environment) or to some location output location on the local file system (if running Gora locally).</td>
+   </tr>
+   <tr>
+    <td>gora.avrostore.codec.type=</td>
+    <td>BINARY || JSON</td>
+    <td>No</td>
+    <td>The property key specifying avro encoder/decoder type to use. Can take values <code>BINARY</code> or <code>JSON</code> but resolves to BINARY is one is not supplied.</td>
+   </tr>
+  </tboday>
+</table>
+
+<h2 id="avrostore-xml-mappings">AvroStore XML mappings</h2>
 <p>In the stores covered within the gora-core module, no physical mappings are required.</p>
-<h1 id="avrostore_1">AvroStore</h1>
+<h1 id="datafileavrostore">DataFileAvroStore</h1>
+<h2 id="description_1">Description</h2>
+<p>DataFileAvroStore is file based store which extends <codeAvroStore</code> to use Avro's <code>DataFile{Writer,Reader}</code>'s as a backend. 
+This datastore supports MapReduce.</p>
 <h2 id="goraproperties_1">gora.properties</h2>
-<p>To configure the AvroStore one would typically set the following:
-<em> gora.avrostore.output.path=hdfs://uri/path/to/hdfs/data/directory || file:///uri/path/to/local/data/directory - This value should point to the hdfs data directory (if running Gora in a distributed Hadoop environment) or to some location on the local file system (if running Gora locally). 
-</em> gora.avrostore.xxx=xxx - xyz</p>
-<h2 id="to-configure-the-datafileavrostore-one-would-typically-set-the-following_1">To configure the DataFileAvroStore one would typically set the following:</h2>
-<ul>
-<li>gora.datafileavrostore.xxx=xxx - xyz </li>
-<li>gora.datafileavrostore.xxx=xxx - xyz</li>
-</ul>
-<p>To configure the MemStore one would typically set the following:
-* gora.memstore.xxx=xxx - xyz</p>
-<h2 id="gora-core-mappings_1">Gora Core mappings</h2>
+<p>DataFileAvroStore would be configured exactly the same as in AvroStore above with the following exception
+<table class="table">
+  <thead>
+   <tr>
+    <th align="left">Property Key</th>
+    <th align="left">Property Value</th> 
+    <th align="left">Required</th>
+    <th align="left">Description</th>
+   </tr>
+  </thead>
+  <tbody>
+   <tr>
+    <td>gora.datastore.default=</td>
+    <td>org.apache.gora.avro.store.DataFileAvroStore</td>
+    <td>Yes</td>
+    <td>Implementation of the persistent Java storage class</td>
+   </tr>
+  </tboday>
+</table></p>
+<h2 id="gora-core-mappings">Gora Core mappings</h2>
 <p>In the stores covered within the gora-core module, no physical mappings are required.</p>
-<h1 id="avrostore_2">AvroStore</h1>
+<h1 id="memstore">MemStore</h1>
+<p>Essentially this store is a ConcurrentSkipListMap in which operations run as follows
+ * put(K key, T Object) - expect average log(n)
+ * get(K key, String [] fields) - expect average log(n)
+ * delete(K key) - expect average log(n)</p>
 <h2 id="goraproperties_2">gora.properties</h2>
-<p>To configure the AvroStore one would typically set the following:
-<em> gora.avrostore.output.path=hdfs://uri/path/to/hdfs/data/directory || file:///uri/path/to/local/data/directory - This value should point to the hdfs data directory (if running Gora in a distributed Hadoop environment) or to some location on the local file system (if running Gora locally). 
-</em> gora.avrostore.xxx=xxx - xyz</p>
-<h2 id="to-configure-the-datafileavrostore-one-would-typically-set-the-following_2">To configure the DataFileAvroStore one would typically set the following:</h2>
-<ul>
-<li>gora.datafileavrostore.xxx=xxx - xyz </li>
-<li>gora.datafileavrostore.xxx=xxx - xyz</li>
-</ul>
-<p>To configure the MemStore one would typically set the following:
-* gora.memstore.xxx=xxx - xyz</p>
-<h2 id="gora-core-mappings_2">Gora Core mappings</h2>
+<p>MemStore would be configured exactly the same as in AvroStore above with the following exception
+<table class="table">
+  <thead>
+   <tr>
+    <th align="left">Property Key</th>
+    <th align="left">Property Value</th> 
+    <th align="left">Required</th>
+    <th align="left">Description</th>
+   </tr>
+  </thead>
+  <tbody>
+   <tr>
+    <td>gora.datastore.default=</td>
+    <td>org.apache.gora.memory.store.MemStore</td>
+    <td>Yes</td>
+    <td>Implementation of the Java class used to hold data in memory</td>
+   </tr>
+  </tboday>
+</table></p>
+<h2 id="memstore-xml-mappings">MemStore XML mappings</h2>
 <p>In the stores covered within the gora-core module, no physical mappings are required.</p>
 
   </div> <!-- /container (main block) -->