Author: lewismc
Date: Fri Jul 18 15:29:01 2014
New Revision: 1611671
URL: http://svn.apache.org/r1611671
Log:
trivial update to define structure of page
Modified:
gora/site/trunk/content/current/gora-core.md
Modified: gora/site/trunk/content/current/gora-core.md
URL:
http://svn.apache.org/viewvc/gora/site/trunk/content/current/gora-core.md?rev=1611671&r1=1611670&r2=1611671&view=diff
==============================================================================
--- gora/site/trunk/content/current/gora-core.md (original)
+++ gora/site/trunk/content/current/gora-core.md Fri Jul 18 15:29:01 2014
@@ -1,16 +1,54 @@
Title: Gora Core Module
-##Overview
-This is the main documentation for the gora-core 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 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.
+#Overview
+This is the main documentation for DataStore's contained within the
+<code>gora-core</code> module which (as it's name implies)
+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 as well as the documentation for
<code>AvroStore</code>,
+<code>DataFileAvroStore</code> and <code>MemStore</code>. In addition to this,
gora-core holds all of the
+core **MapReduce**, **Persistency**, **Query**, **DataStoreBase** and
**Utility** functionality.
[TOC]
+#AvroStore
+
+##gora.properties
+To configure the AvroStore one would typically set the following:
+* 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).
+* gora.avrostore.xxx=xxx - xyz
+
+##To configure the DataFileAvroStore one would typically set the following:
+* gora.datafileavrostore.xxx=xxx - xyz
+* gora.datafileavrostore.xxx=xxx - xyz
+
+To configure the MemStore one would typically set the following:
+* gora.memstore.xxx=xxx - xyz
+
+##Gora Core mappings
+In the stores covered within the gora-core module, no physical mappings are
required.
+
+#AvroStore
+
+##gora.properties
+To configure the AvroStore one would typically set the following:
+* 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).
+* gora.avrostore.xxx=xxx - xyz
+
+##To configure the DataFileAvroStore one would typically set the following:
+* gora.datafileavrostore.xxx=xxx - xyz
+* gora.datafileavrostore.xxx=xxx - xyz
+
+To configure the MemStore one would typically set the following:
+* gora.memstore.xxx=xxx - xyz
+
+##Gora Core mappings
+In the stores covered within the gora-core module, no physical mappings are
required.
+
+#AvroStore
+
##gora.properties
To configure the AvroStore one would typically set the following:
* 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).
