gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lewi...@apache.org
Subject svn commit: r1457367 - in /gora/cms_site: README.txt trunk/content/current/gora-accumulo.md trunk/content/current/gora-cassandra.md trunk/content/current/overview.md
Date Sun, 17 Mar 2013 03:41:04 GMT
Author: lewismc
Date: Sun Mar 17 03:41:04 2013
New Revision: 1457367

URL: http://svn.apache.org/r1457367


Modified: gora/cms_site/README.txt
URL: http://svn.apache.org/viewvc/gora/cms_site/README.txt?rev=1457367&r1=1457366&r2=1457367&view=diff
--- gora/cms_site/README.txt (original)
+++ gora/cms_site/README.txt Sun Mar 17 03:41:04 2013
@@ -1,7 +1,15 @@
 This documents the transition to the Apache CMS [0] for managing, amending and deploying

-Apache Gora's project website and documentation.
+Gora's project website and documentation.
+These files are written in Markdown. The syntax is explained best by [1][2]
+If you want to change a style, those can be found in `content/styles/`
+Change the general layout by modifying the files in `templates/`.
+You can also change the behaviour by modifying the files in `lib/`.
+Documentation on this process can be found at [0]
 The essential directory structure is as follows 
@@ -17,10 +25,12 @@ The essential directory structure is as 
 All new site content is put into trunk/content.
 Users wishing to amend and publish the site can easily do so by obtaining the 
-Bookmarklet from here [1].
+Bookmarklet from here [3].
 We are always eager to make improvements to this documentation, the Gora site
 and of course the Gora code so please get in touch with us on user or dev@ lists.
 [0] http://www.apache.org/dev/cms.html
-[1] https://cms.apache.org/#bookmark
+[1] http://www.apache.org/dev/cmsref.html#markdown
+[2] http://daringfireball.net/projects/markdown/syntax
+[3] https://cms.apache.org/#bookmark

Modified: gora/cms_site/trunk/content/current/gora-accumulo.md
URL: http://svn.apache.org/viewvc/gora/cms_site/trunk/content/current/gora-accumulo.md?rev=1457367&r1=1457366&r2=1457367&view=diff
--- gora/cms_site/trunk/content/current/gora-accumulo.md (original)
+++ gora/cms_site/trunk/content/current/gora-accumulo.md Sun Mar 17 03:41:04 2013
@@ -0,0 +1,17 @@
+Title: Gora Accumulo Module
+This is the main documentation for the gora-accumulo module which
+enables [Apache Accumulo](http://accumulo.apache.org) backend support for Gora. 
+* gora.datastore.default=org.apache.gora.accumulo.store.AccumuloStore - Implementation of
the storage class 
+* gora.accumulo.mapping.file                                          - The XML mapping file
to be used 
+* gora.datastore.accumulo.mock=true                                   - coming soon
+* gora.datastore.accumulo.instance=a14                                - coming soon
+* gora.datastore.accumulo.zookeepers=localhost                        - coming soon
+* gora.datastore.accumulo.user=root                                   - coming soon
+* gora.datastore.accumulo.password=secret                             - coming soon
+Gora Accumulo mappings 
+* coming soon

Modified: gora/cms_site/trunk/content/current/gora-cassandra.md
URL: http://svn.apache.org/viewvc/gora/cms_site/trunk/content/current/gora-cassandra.md?rev=1457367&r1=1457366&r2=1457367&view=diff
--- gora/cms_site/trunk/content/current/gora-cassandra.md (original)
+++ gora/cms_site/trunk/content/current/gora-cassandra.md Sun Mar 17 03:41:04 2013
@@ -0,0 +1,44 @@
+Title: Gora Cassandra Module
+This is the main documentation for the gora-accumulo module which
+enables [Apache Cassandra](http://cassandra.apache.org) backend support for Gora. 
+* gora.datastore.default=org.apache.gora.cassandra.store.CassandraStore - Implementation
of the storage class 
+* gora.cassandra.mapping.file                                           - The XML mapping
file to be used 
+* gora.cassandra.servers=localhost:9160                                 - 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.
+Gora Cassandra mappings 
+Say we wished to map some Employee data and store it into the CassandraStore.
+    <gora-orm>
+      <keyspace name="Employee" host="localhost" cluster="Gora Cassandra Test Cluster">
+        <family name="p"/>
+        <family name="f"/>
+        <family name="sc" type="super" />
+      </keyspace>
+      <class name="org.apache.gora.examples.generated.Employee" keyClass="java.lang.String"
+        <field name="name"  family="p" qualifier="info:nm"/>
+        <field name="dateOfBirth"  family="p" qualifier="info:db"/>
+        <field name="ssn"  family="p" qualifier="info:sn"/>
+        <field name="salary"  family="p" qualifier="info:sl"/>
+      </class>
+    </gora-orm>
+Here you can see that within the keyspace section we specify the Cassandra 
+keyspace schema name Employee, the host localhost and the cluster name 
+Gora Cassandra Test Cluster. Additionally we are required to specify the type of 
+column families we wish to create within Cassandra. In this case we create three columns;

+p, f and sc the last of which is further defined as a super column. 
+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 class element
+the generated class name org.apache.gora.examples.generated.Employee specifies the Avro generated
+persistent class, the keyClass java.lang.String which specifies the keys which map to the
+values and finally the keyspace Employee which matches to the above keyspace definition.
+Finally fields which are to be persisted into Cassandra need to be configuired such that
+receive a name (name, dateOfBirth, ssn and salary respectively), the column family 
+to which they belong (all p in this case) and additionally a qualifier, which enables 
+more granular control over the data to be persisted into Cassandra.

Modified: gora/cms_site/trunk/content/current/overview.md
URL: http://svn.apache.org/viewvc/gora/cms_site/trunk/content/current/overview.md?rev=1457367&r1=1457366&r2=1457367&view=diff
--- gora/cms_site/trunk/content/current/overview.md (original)
+++ gora/cms_site/trunk/content/current/overview.md Sun Mar 17 03:41:04 2013
@@ -0,0 +1,29 @@
+Title: Gora Module Overview
+This is the main entry point for Gora documentation. Here are some pointers for further info:
+* First if you haven't already done so, make sure to check the [quick start guide](/quickstart.html).
+* Basic information about gora modules can be found below.
+* You can also take a look at the [API Documentation](javadoc/index.html) which contains
the javadoc 
+  for all of the modules combined. We are always looking for [Documentation contributions](../contribute.html).
+You can find an abstract overview of how to configure Gora [here](./gora-conf.html).
+Gora Modules
+Gora source code is organized in a modular architecture. The gora-core module 
+is the main module which contains the core of the code. All other modules depend 
+on the gora-core module. 
+Each datastore backend in Gora resides in it's own module. The documentation for 
+the specific module can be found at the module's documentation directory. 
+It is wise so start with going over the documentation for the gora-core 
+ module and then the specific data store module(s) you want to use. The 
+following modules are currently implemented in gora.
+* [gora-core](./gora-core.html): Module containing core functionality, AvroStore and DataFileAvroStore
+* [gora-accumulo](./gora-accumulo.html): Module for [Apache Accumulo](http://accumulo.apache.org)
backend and AccumuloStore implementation;
+* [gora-cassandra](./gora-cassandra.html): Module for [Apache Cassandra](http://cassandra.apacheorg)
backend and CassandraStore implementation;
+* [gora-dynamodb](./gora-dynamodb.html): Module for [Amazon DynamoDB](http://aws.amazon.com/dynamodb/)
backend and DynamoDBStore implementation;
+* [gora-hbase](./gora-hbase.html): Module for [Apache HBase](http://hbase.apache.org) backend
and HBaseStore implementation;
+* [gora-sql](./gora-sql.html): Module for [HSQLDB](http://hsqldb.org/) and [MySQL](http://www.mysql.com/)
backend and SqlStore implementation;

View raw message