gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lewi...@apache.org
Subject svn commit: r1397023 - /gora/site/publish/docs/current/
Date Thu, 11 Oct 2012 12:38:31 GMT
Author: lewismc
Date: Thu Oct 11 12:38:30 2012
New Revision: 1397023

URL: http://svn.apache.org/viewvc?rev=1397023&view=rev
Log:
GORA-39 Complete Gora-Cassandra site documentation

Added:
    gora/site/publish/docs/current/gora-accumulo.html
    gora/site/publish/docs/current/gora-accumulo.pdf   (with props)
    gora/site/publish/docs/current/gora-dynamodb.html
    gora/site/publish/docs/current/gora-dynamodb.pdf   (with props)
Modified:
    gora/site/publish/docs/current/gora-cassandra.html
    gora/site/publish/docs/current/gora-cassandra.pdf
    gora/site/publish/docs/current/gora-conf.html
    gora/site/publish/docs/current/gora-conf.pdf
    gora/site/publish/docs/current/gora-core.html
    gora/site/publish/docs/current/gora-core.pdf
    gora/site/publish/docs/current/gora-hbase.html
    gora/site/publish/docs/current/gora-hbase.pdf
    gora/site/publish/docs/current/gora-sql.html
    gora/site/publish/docs/current/gora-sql.pdf
    gora/site/publish/docs/current/index.html
    gora/site/publish/docs/current/index.pdf
    gora/site/publish/docs/current/linkmap.html
    gora/site/publish/docs/current/linkmap.pdf
    gora/site/publish/docs/current/quickstart.html
    gora/site/publish/docs/current/quickstart.pdf
    gora/site/publish/docs/current/tutorial.html
    gora/site/publish/docs/current/tutorial.pdf

Added: gora/site/publish/docs/current/gora-accumulo.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-accumulo.html?rev=1397023&view=auto
==============================================================================
--- gora/site/publish/docs/current/gora-accumulo.html (added)
+++ gora/site/publish/docs/current/gora-accumulo.html Thu Oct 11 12:38:30 2012
@@ -0,0 +1,228 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.9">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Gora Accumulo Module</title>
+<link type="text/css" href="skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
+<link type="text/css" href="skin/profile.css" rel="stylesheet">
+<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script
src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script
src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="images/favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://apache.org/">Apache</a> &gt; <a href="http://gora.apache.org/">Gora</a><script
src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://apache.org/"><img class="logoImage" alt="Apache Software Foundation"
src="http://www.apache.org/images/asf-logo.gif" title="The ASF is made up of nearly 100 top
level projects that cover a wide range of technologies. Chances are if you are looking for
a rewarding experience in Open Source, you are going to find it here."></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://gora.apache.org/"><img class="logoImage" alt="Apache Gora" src="images/gora-logo.png"
title="The Apache Gora open source framework provides an in-memory data model and persistence
for big data. Gora supports persisting to column stores, key value stores, document stores
and RDBMSs, and analyzing the data with extensive Apache Hadoop MapReduce support. "></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="gora.apache.org/" name="sitesearch" type="hidden"><input onFocus="getBlank
(this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search
the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="http://incubator.apache.org/gora/">Project</a>
+</li>
+<li>
+<a class="unselected" href="https://cwiki.apache.org/confluence/display/GORA/Index">Wiki</a>
+</li>
+<li>
+<a class="unselected" href="http://issues.apache.org/jira/browse/GORA">Issues</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs"></div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+
+             &nbsp;
+           </div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle"
style="background-image: url('skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="quickstart.html">Quick Start</a>
+</div>
+<div class="menuitem">
+<a href="tutorial.html">Gora Tutorial</a>
+</div>
+<div class="menuitem">
+<a href="gora-conf.html">Gora Configuration</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">gora-accumulo</div>
+</div>
+<div class="menuitem">
+<a href="gora-core.html">gora-core</a>
+</div>
+<div class="menuitem">
+<a href="gora-cassandra.html">gora-cassandra</a>
+</div>
+<div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
+<a href="gora-hbase.html">gora-hbase</a>
+</div>
+<div class="menuitem">
+<a href="gora-sql.html">gora-sql</a>
+</div>
+<div class="menuitem">
+<a href="https://builds.apache.org/job/gora-trunk/javadoc">Nightly API docs</a>
+</div>
+<div class="menuitem">
+<a href="apidocs-0.2.1/index.html">0.2.1 API docs</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2"></div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="gora-accumulo.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif"
class="skin"><br>
+        PDF</a>
+</div>
+<h1>Gora Accumulo Module</h1>
+<div id="front-matter">
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Overview"> Overview </a>
+</li>
+<li>
+<a href="#gora.properties"> gora.properties </a>
+</li>
+<li>
+<a href="#Gora+Accumulo+mappings"> Gora Accumulo mappings </a>
+</li>
+</ul>
+</div>
+</div>
+
+  
+<a name="Overview"></a>
+<h2 class="underlined_10"> Overview </h2>
+<div class="section">
+<p> This is the main documentation for the <b>gora-accumulo</b> module.
gora-accumulo 
+     module enables <a href="http://accumulo.apache.org/">Apache Accumulo</a>
backend support for Gora. </p>
+</div>
+
+  
+<a name="gora.properties"></a>
+<h2 class="underlined_10"> gora.properties </h2>
+<div class="section">
+<p> Coming soon </p>
+</div>
+
+
+  
+<a name="Gora+Accumulo+mappings"></a>
+<h2 class="underlined_10"> Gora Accumulo mappings </h2>
+<div class="section">
+<p> Coming soon </p>
+</div>
+
+  
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2010-2012 <a href="http://www.apache.org/">Apache Software Foundation.</a>
+</div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Added: gora/site/publish/docs/current/gora-accumulo.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-accumulo.pdf?rev=1397023&view=auto
==============================================================================
Binary file - no diff available.

Propchange: gora/site/publish/docs/current/gora-accumulo.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: gora/site/publish/docs/current/gora-cassandra.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-cassandra.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/gora-cassandra.html (original)
+++ gora/site/publish/docs/current/gora-cassandra.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menupage">
 <div class="menupagetitle">gora-cassandra</div>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">
@@ -183,7 +189,13 @@ document.write("Last Published: " + docu
 <a name="gora.properties"></a>
 <h2 class="underlined_10"> gora.properties </h2>
 <div class="section">
-<p> Coming soon </p>
+<p>To configure the <b>CassandraStore</b> one would typically set the following:<br>
+    
+<span class="codefrag">gora.cassandra.servers=localhost:9160</span> - This value
should specify the host:port 
+    for a running Cassandra server or node. In this case the server happens to be running
on 
+    localhost at port 9160 which is the default Cassandra server configuration.<br>

+    
+</p>
 </div>
 
 
@@ -191,7 +203,40 @@ document.write("Last Published: " + docu
 <a name="Gora+Cassandra+mappings"></a>
 <h2 class="underlined_10"> Gora Cassandra mappings </h2>
 <div class="section">
-<p> Coming soon </p>
+<p> Say we wished to map some Employee data and store it into the CassandraStore.</p>
+<p>
+<pre class="code">
+    &lt;gora-orm&gt;
+      &lt;keyspace name="Employee" host="localhost" cluster="Gora Cassandra Test Cluster"&gt;
+        &lt;family name="p"/&gt;
+        &lt;family name="f"/&gt;
+        &lt;family name="sc" type="super" /&gt;
+      &lt;/keyspace&gt;
+
+      &lt;class name="org.apache.gora.examples.generated.Employee" keyClass="java.lang.String"
keyspace="Employee"&gt;
+        &lt;field name="name"  family="p" qualifier="info:nm"/&gt;
+        &lt;field name="dateOfBirth"  family="p" qualifier="info:db"/&gt;
+        &lt;field name="ssn"  family="p" qualifier="info:sn"/&gt;
+        &lt;field name="salary"  family="p" qualifier="info:sl"/&gt;
+      &lt;/class&gt;
+      ...
+    &lt;/gora-orm&gt;
+    </pre>
+</p>
+<p>Here you can see that within the <span class="codefrag">keyspace</span>
section we specify the Cassandra 
+    keyspace schema name <b>Employee</b>, the host <b>localhost</b>
and the cluster name 
+    <b>Gora Cassandra Test Cluster</b>. Additionally we are required to specify
the type of 
+    column families we wish to create within Cassandra. In this case we create three columns;

+    <b>p</b>, <b>f</b> and <b>sc</b> the last of which
is further defined as a super column.</p>
+<p>Further to this, within the Cassandra mappings we are required to specify persistent
fields 
+    which values should map to. In the above example we see that within the <span class="codefrag">class</span>
element
+    the generated class name <b>org.apache.gora.examples.generated.Employee</b>
specifies the Avro generated
+    persistent class, the keyClass <b>java.lang.String</b> which specifies the
keys which map to the field 
+    values and finally the keyspace <b>Employee</b> which matches to the above
keyspace definition.</p>
+<p>Finally fields which are to be persisted into Cassandra need to be configuired such
that they 
+    receive a name (<b>name</b>, <b>dateOfBirth</b>, <b>ssn</b>
and <b>salary</b> respectively), the column family 
+    to which they belong (all <b>p</b> in this case) and additionally a qualifier,
which enables 
+    more granular control over the data to be persisted into Cassandra.</p>
 </div>
 
   

Modified: gora/site/publish/docs/current/gora-cassandra.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-cassandra.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/gora-conf.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-conf.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/gora-conf.html (original)
+++ gora/site/publish/docs/current/gora-conf.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <div class="menupagetitle">Gora Configuration</div>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">
@@ -214,27 +220,35 @@ Data store implementation in Gora distri
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">AvroStore</td> <td colspan="1" rowspan="1">org.apache.gora.avro.store.AvroStore</td>
<td colspan="1" rowspan="1">gora-core</td> <td colspan="1" rowspan="1">An
adapter DataStore for binary-compatible Avro serializations. AvroDataStore supports Binary
and JSON serializations. </td>
+<td colspan="1" rowspan="1">AvroStore</td> <td colspan="1" rowspan="1">org.apache.gora.avro.store.AvroStore</td>
<td colspan="1" rowspan="1"><a href="gora-core.html">gora-core</a></td>
<td colspan="1" rowspan="1">An adapter DataStore for binary-compatible Apache Avro serializations.
AvroDataStore supports Binary and JSON serializations. </td>
+</tr>
+  
+<tr>
+<td colspan="1" rowspan="1">DataFileAvroStore</td> <td colspan="1" rowspan="1">org.apache.gora.avro.store.DataFileAvroStore</td>
<td colspan="1" rowspan="1"><a href="gora-core.html">gora-core</a></td>
<td colspan="1" rowspan="1">DataFileAvroStore is file based store which uses Avro's
DataFile{Writer,Reader}'s as a backend. This datastore supports mapreduce.</td>
+</tr>
+  
+<tr>
+<td colspan="1" rowspan="1">AccumuloStore</td> <td colspan="1" rowspan="1">org.apache.gora.accumulo.store.AccumuloStore</td>
<td colspan="1" rowspan="1"><a href="gora-accumulo.html">gora-accumulo</a></td>
<td colspan="1" rowspan="1"> DataStore for <a href="http://accumulo.apache.org/">Apache
Accumulo</a>. </td>
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">DataFileAvroStore</td> <td colspan="1" rowspan="1">org.apache.gora.avro.store.DataFileAvroStore</td>
<td colspan="1" rowspan="1">gora-core</td> <td colspan="1" rowspan="1">DataFileAvroStore
is file based store which uses Avro's DataFile{Writer,Reader}'s as a backend. This datastore
supports mapreduce.</td>
+<td colspan="1" rowspan="1">HBaseStore</td> <td colspan="1" rowspan="1">org.apache.gora.hbase.store.HBaseStore</td>
<td colspan="1" rowspan="1"><a href="gora-hbase.html">gora-hbase</a></td>
<td colspan="1" rowspan="1"> DataStore for <a href="http://hbase.apache.org/">Apache
HBase</a>. </td>
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">HBaseStore</td> <td colspan="1" rowspan="1">org.apache.gora.hbase.store.HBaseStore</td>
<td colspan="1" rowspan="1"><a href="gora-hbase.html">gora-hbase</a></td>
<td colspan="1" rowspan="1"> DataStore for <a href="http://hbase.apache.org/">HBase</a>.
</td>
+<td colspan="1" rowspan="1">CassandraStore</td> <td colspan="1" rowspan="1">org.apache.gora.cassandra.store.CasssandraStore</td>
<td colspan="1" rowspan="1"><a href="gora-cassandra.html">gora-cassandra</a></td>
<td colspan="1" rowspan="1"> DataStore for <a href="http://cassandra.apache.org/">Apache
Cassandra</a>. </td>
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">CassandraStore</td> <td colspan="1" rowspan="1">org.apache.gora.cassandra.store.CasssandraStore</td>
<td colspan="1" rowspan="1"><a href="gora-cassandra.html">gora-cassandra</a></td>
<td colspan="1" rowspan="1"> DataStore for <a href="http://cassandra.apache.org/">Cassandra</a>.
</td>
+<td colspan="1" rowspan="1">SqlStore</td> <td colspan="1" rowspan="1">org.apache.gora.sql.store.SqlStore</td>
<td colspan="1" rowspan="1"><a href="gora-sql.html">gora-sql</a></td>
<td colspan="1" rowspan="1"> A DataStore implementation for RDBMS with a SQL interface.
SqlStore uses JDBC drivers to communicate with the DB. <a href="http://www.mysql.com/">Mysql</a>
and <a href="http://hsqldb.org/">Hsqldb</a> are supported for now.</td>
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">SqlStore</td> <td colspan="1" rowspan="1">org.apache.gora.sql.store.SqlStore</td>
<td colspan="1" rowspan="1"><a href="gora-sql.html">gora-sql</a></td>
<td colspan="1" rowspan="1"> A DataStore implementation for RDBMS with a SQL interface.
SqlStore uses JDBC drivers to communicate with the DB. Mysql and Hsqldb are supported for
now.</td>
+<td colspan="1" rowspan="1">MemStore</td> <td colspan="1" rowspan="1">org.apache.gora.memory.store.MemStore</td>
<td colspan="1" rowspan="1"><a href="gora-core.html">gora-core</a></td>
<td colspan="1" rowspan="1"> Memory based DataStore implementation for tests. </td>
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">MemStore</td> <td colspan="1" rowspan="1">org.apache.gora.memory.store.MemStore</td>
<td colspan="1" rowspan="1">gora-core</td> <td colspan="1" rowspan="1">
Memory based DataStore implementation for tests. </td>
+<td colspan="1" rowspan="1">Dynamodb</td> <td colspan="1" rowspan="1">org.apache.gora.dynamodb.store.DyanmoDBStore</td>
<td colspan="1" rowspan="1"><a href="gora-dynamodb.html">gora-dynamodb</a></td>
<td colspan="1" rowspan="1"> Webservices-based datastore implementation for <a href="http://aws.amazon.com/dynamodb/">Amazon's
DynamoDB</a>. </td>
 </tr>
 
 </table>
@@ -263,7 +277,7 @@ to all data stores. The following proper
 </tr>
   
 <tr>
-<td colspan="1" rowspan="1">gora.&lt;data_store_class&gt;.mapping.file</td>
<td colspan="1" rowspan="1">No</td> <td colspan="1" rowspan="1">gora-{hbase|cassandra|sql}-mapping.xml</td>
<td colspan="1" rowspan="1">The name of the mapping file</td>
+<td colspan="1" rowspan="1">gora.&lt;data_store_class&gt;.mapping.file</td>
<td colspan="1" rowspan="1">No</td> <td colspan="1" rowspan="1">gora-{accumulo|hbase|cassandra|sql|dynamodb}-mapping.xml</td>
<td colspan="1" rowspan="1">The name of the mapping file</td>
 </tr>
 
 </table>
@@ -273,8 +287,6 @@ to all data stores. The following proper
 </p>
 </div>
 
-  <!--TODO: Avro data store properties -->
-
   
 <a name="Data+store+specific+settings"></a>
 <h2 class="underlined_10">Data store specific settings</h2>
@@ -284,6 +296,10 @@ to all data stores. The following proper
     <ul>
       
 <li>
+<a href="gora-core.html">Gora Core Module (incl. AvroStore, DataFileAvroStore and MemStore)</a>
+</li>
+      
+<li>
 <a href="gora-hbase.html">Gora HBase Module</a>
 </li>
       
@@ -294,6 +310,14 @@ to all data stores. The following proper
 <li>
 <a href="gora-sql.html">Gora SQL Module</a>
 </li>
+      
+<li>
+<a href="gora-hbase.html">Gora Accumulo Module</a>
+</li>
+      
+<li>
+<a href="gora-dynamodb.html">Gora DynamoDB Module</a>
+</li>
     
 </ul>
     

Modified: gora/site/publish/docs/current/gora-conf.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-conf.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/gora-core.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-core.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/gora-core.html (original)
+++ gora/site/publish/docs/current/gora-core.html Thu Oct 11 12:38:30 2012
@@ -116,6 +116,9 @@ document.write("Last Published: " + docu
 <div class="menuitem">
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
+<div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
 <div class="menupage">
 <div class="menupagetitle">gora-core</div>
 </div>
@@ -123,6 +126,9 @@ document.write("Last Published: " + docu
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">
@@ -161,6 +167,12 @@ document.write("Last Published: " + docu
 <li>
 <a href="#Overview"> Overview </a>
 </li>
+<li>
+<a href="#gora.properties"> gora.properties </a>
+</li>
+<li>
+<a href="#Gora+Core+mappings"> Gora Core mappings </a>
+</li>
 </ul>
 </div>
 </div>
@@ -172,9 +184,39 @@ document.write("Last Published: " + docu
 <p> This is the main documentation for the <b>gora-core</b> module. gora-core

     holds most of the core functionality for the gora project. Every module 
     in gora depends on gora-core. Therefore most of the generic documentation 
-    about the project is gathered here. 
+    about the project is gathered here as well as the documentation for AvroStore, 
+    DataFileAvroStore and MemStore. In addition to this gora-core holds all of the 
+    core MapReduce, Persistency, Query and Base DataStore and Utility functionality
+    which is also documented here.
     </p>
 </div>
+  
+  
+<a name="gora.properties"></a>
+<h2 class="underlined_10"> gora.properties </h2>
+<div class="section">
+<p>To configure the <b>AvroStore</b> one would typically set the following:<br>
+    
+<span class="codefrag">gora.avrostore.output.path=hdfs://uri/path/to/hdfs/data/directory
| file:///uri/path/to/local/data/directory</span> - 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).<br> 
+    
+<span class="codefrag">gora.avrostore.xxx=xxx</span> - xyz</p>
+<p>To configure the <b>DataFileAvroStore</b> one would typically set the
following:<br>
+    
+<span class="codefrag">gora.datafileavrostore.xxx=xxx</span> - xyz<br>

+    
+<span class="codefrag">gora.datafileavrostore.xxx=xxx</span> - xyz</p>
+<p>To configure the <b>MemStore</b> one would typically set the following:<br>
+    
+<span class="codefrag">gora.memstore.xxx=xxx</span> - xyz</p>
+</div>
+
+
+  
+<a name="Gora+Core+mappings"></a>
+<h2 class="underlined_10"> Gora Core mappings </h2>
+<div class="section">
+<p> In the stores covered within the gora-core module, no physical mappings are required.
</p>
+</div>
 
   
   

Modified: gora/site/publish/docs/current/gora-core.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-core.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Added: gora/site/publish/docs/current/gora-dynamodb.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-dynamodb.html?rev=1397023&view=auto
==============================================================================
--- gora/site/publish/docs/current/gora-dynamodb.html (added)
+++ gora/site/publish/docs/current/gora-dynamodb.html Thu Oct 11 12:38:30 2012
@@ -0,0 +1,228 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.9">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Gora DynamoDB Module</title>
+<link type="text/css" href="skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
+<link type="text/css" href="skin/profile.css" rel="stylesheet">
+<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script
src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script
src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="images/favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+<a href="http://apache.org/">Apache</a> &gt; <a href="http://gora.apache.org/">Gora</a><script
src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+    |header
+    +-->
+<div class="header">
+<!--+
+    |start group logo
+    +-->
+<div class="grouplogo">
+<a href="http://apache.org/"><img class="logoImage" alt="Apache Software Foundation"
src="http://www.apache.org/images/asf-logo.gif" title="The ASF is made up of nearly 100 top
level projects that cover a wide range of technologies. Chances are if you are looking for
a rewarding experience in Open Source, you are going to find it here."></a>
+</div>
+<!--+
+    |end group logo
+    +-->
+<!--+
+    |start Project Logo
+    +-->
+<div class="projectlogo">
+<a href="http://gora.apache.org/"><img class="logoImage" alt="Apache Gora" src="images/gora-logo.png"
title="The Apache Gora open source framework provides an in-memory data model and persistence
for big data. Gora supports persisting to column stores, key value stores, document stores
and RDBMSs, and analyzing the data with extensive Apache Hadoop MapReduce support. "></a>
+</div>
+<!--+
+    |end Project Logo
+    +-->
+<!--+
+    |start Search
+    +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="gora.apache.org/" name="sitesearch" type="hidden"><input onFocus="getBlank
(this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search
the site with google">&nbsp; 
+                    <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+    |end search
+    +-->
+<!--+
+    |start Tabs
+    +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="http://incubator.apache.org/gora/">Project</a>
+</li>
+<li>
+<a class="unselected" href="https://cwiki.apache.org/confluence/display/GORA/Index">Wiki</a>
+</li>
+<li>
+<a class="unselected" href="http://issues.apache.org/jira/browse/GORA">Issues</a>
+</li>
+</ul>
+<!--+
+    |end Tabs
+    +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+    |start Subtabs
+    +-->
+<div id="level2tabs"></div>
+<!--+
+    |end Endtabs
+    +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<!--+
+    |breadtrail
+    +-->
+<div class="breadtrail">
+
+             &nbsp;
+           </div>
+<!--+
+    |start Menu, mainarea
+    +-->
+<!--+
+    |start Menu
+    +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle"
style="background-image: url('skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="quickstart.html">Quick Start</a>
+</div>
+<div class="menuitem">
+<a href="tutorial.html">Gora Tutorial</a>
+</div>
+<div class="menuitem">
+<a href="gora-conf.html">Gora Configuration</a>
+</div>
+<div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
+<a href="gora-core.html">gora-core</a>
+</div>
+<div class="menuitem">
+<a href="gora-cassandra.html">gora-cassandra</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">gora-dynamodb</div>
+</div>
+<div class="menuitem">
+<a href="gora-hbase.html">gora-hbase</a>
+</div>
+<div class="menuitem">
+<a href="gora-sql.html">gora-sql</a>
+</div>
+<div class="menuitem">
+<a href="https://builds.apache.org/job/gora-trunk/javadoc">Nightly API docs</a>
+</div>
+<div class="menuitem">
+<a href="apidocs-0.2.1/index.html">0.2.1 API docs</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+  |alternative credits
+  +-->
+<div id="credit2"></div>
+</div>
+<!--+
+    |end Menu
+    +-->
+<!--+
+    |start content
+    +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="gora-dynamodb.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif"
class="skin"><br>
+        PDF</a>
+</div>
+<h1>Gora DynamoDB Module</h1>
+<div id="front-matter">
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Overview"> Overview </a>
+</li>
+<li>
+<a href="#gora.properties"> gora.properties </a>
+</li>
+<li>
+<a href="#Gora+DynamoDB+mappings"> Gora DynamoDB mappings </a>
+</li>
+</ul>
+</div>
+</div>
+
+  
+<a name="Overview"></a>
+<h2 class="underlined_10"> Overview </h2>
+<div class="section">
+<p> This is the main documentation for the <b>gora-dynamodb</b> module.
gora-dynamodb 
+     module enables <a href="http://aws.amazon.com/dynamodb/">Amazon DynamoDB</a>
backend support for Gora. </p>
+</div>
+
+  
+<a name="gora.properties"></a>
+<h2 class="underlined_10"> gora.properties </h2>
+<div class="section">
+<p> Coming soon </p>
+</div>
+
+
+  
+<a name="Gora+DynamoDB+mappings"></a>
+<h2 class="underlined_10"> Gora DynamoDB mappings </h2>
+<div class="section">
+<p> Coming soon </p>
+</div>
+
+  
+</div>
+<!--+
+    |end content
+    +-->
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<!--+
+    |start bottomstrip
+    +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2010-2012 <a href="http://www.apache.org/">Apache Software Foundation.</a>
+</div>
+<!--+
+    |end bottomstrip
+    +-->
+</div>
+</body>
+</html>

Added: gora/site/publish/docs/current/gora-dynamodb.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-dynamodb.pdf?rev=1397023&view=auto
==============================================================================
Binary file - no diff available.

Propchange: gora/site/publish/docs/current/gora-dynamodb.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: gora/site/publish/docs/current/gora-hbase.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-hbase.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/gora-hbase.html (original)
+++ gora/site/publish/docs/current/gora-hbase.html Thu Oct 11 12:38:30 2012
@@ -117,11 +117,17 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
+<div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
 <div class="menupage">
 <div class="menupagetitle">gora-hbase</div>
 </div>

Modified: gora/site/publish/docs/current/gora-hbase.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-hbase.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/gora-sql.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-sql.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/gora-sql.html (original)
+++ gora/site/publish/docs/current/gora-sql.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menupage">
@@ -165,7 +171,7 @@ document.write("Last Published: " + docu
 <a href="#gora.properties"> gora.properties </a>
 </li>
 <li>
-<a href="#Gora+HBase+mappings"> Gora HBase mappings </a>
+<a href="#Gora+SQL+mappings"> Gora SQL mappings </a>
 </li>
 </ul>
 </div>
@@ -189,8 +195,8 @@ document.write("Last Published: " + docu
 
 
   
-<a name="Gora+HBase+mappings"></a>
-<h2 class="underlined_10"> Gora HBase mappings </h2>
+<a name="Gora+SQL+mappings"></a>
+<h2 class="underlined_10"> Gora SQL mappings </h2>
 <div class="section">
 <p> Coming soon </p>
 </div>

Modified: gora/site/publish/docs/current/gora-sql.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/gora-sql.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/index.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/index.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/index.html (original)
+++ gora/site/publish/docs/current/index.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">

Modified: gora/site/publish/docs/current/index.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/index.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/linkmap.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/linkmap.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/linkmap.html (original)
+++ gora/site/publish/docs/current/linkmap.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">
@@ -198,6 +204,12 @@ document.write("Last Published: " + docu
     
 <ul>
 <li>
+<a href="gora-accumulo.html">gora-accumulo</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>gora-accumulo</em>
+</li>
+</ul>
+    
+<ul>
+<li>
 <a href="gora-core.html">gora-core</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>gora-core</em>
 </li>
 </ul>
@@ -210,6 +222,12 @@ document.write("Last Published: " + docu
     
 <ul>
 <li>
+<a href="gora-dynamodb.html">gora-dynamodb</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>gora-dynamodb</em>
+</li>
+</ul>
+    
+<ul>
+<li>
 <a href="gora-hbase.html">gora-hbase</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>gora-hbase</em>
 </li>
 </ul>

Modified: gora/site/publish/docs/current/linkmap.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/linkmap.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/quickstart.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/quickstart.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/quickstart.html (original)
+++ gora/site/publish/docs/current/quickstart.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">

Modified: gora/site/publish/docs/current/quickstart.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/quickstart.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.

Modified: gora/site/publish/docs/current/tutorial.html
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/tutorial.html?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
--- gora/site/publish/docs/current/tutorial.html (original)
+++ gora/site/publish/docs/current/tutorial.html Thu Oct 11 12:38:30 2012
@@ -117,12 +117,18 @@ document.write("Last Published: " + docu
 <a href="gora-conf.html">Gora Configuration</a>
 </div>
 <div class="menuitem">
+<a href="gora-accumulo.html">gora-accumulo</a>
+</div>
+<div class="menuitem">
 <a href="gora-core.html">gora-core</a>
 </div>
 <div class="menuitem">
 <a href="gora-cassandra.html">gora-cassandra</a>
 </div>
 <div class="menuitem">
+<a href="gora-dynamodb.html">gora-dynamodb</a>
+</div>
+<div class="menuitem">
 <a href="gora-hbase.html">gora-hbase</a>
 </div>
 <div class="menuitem">

Modified: gora/site/publish/docs/current/tutorial.pdf
URL: http://svn.apache.org/viewvc/gora/site/publish/docs/current/tutorial.pdf?rev=1397023&r1=1397022&r2=1397023&view=diff
==============================================================================
Binary files - no diff available.



Mime
View raw message