Author: lewismc
Date: Wed Feb 12 18:30:44 2014
New Revision: 1567712
URL: http://svn.apache.org/r1567712
Log:
CMS commit to gora by lewismc
Modified:
gora/site/trunk/content/current/gora-cassandra.md
Modified: gora/site/trunk/content/current/gora-cassandra.md
URL:
http://svn.apache.org/viewvc/gora/site/trunk/content/current/gora-cassandra.md?rev=1567712&r1=1567711&r2=1567712&view=diff
==============================================================================
--- gora/site/trunk/content/current/gora-cassandra.md (original)
+++ gora/site/trunk/content/current/gora-cassandra.md Wed Feb 12 18:30:44 2014
@@ -31,18 +31,29 @@ Say we wished to map some Employee data
Here you can see that we require the definition of two child elements within
the
<code>gora-orm</code> mapping configuration, namely;
-1. The keyspace element; where we specify:
- the Cassandra keyspace schema name e.g. <b>Employee</b>,
- the host e.g. <b>localhost</b>,
- the Cassandra cluster name e.g. <b>Gora Cassandra Test Cluster</b>,
- 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.
-2. Specification of persistent fields which values should map to;
- the Persistent class name e.g.
<b>org.apache.gora.examples.generated.Employee</b>,
- the keyClass e.g. <b>java.lang.String</b> which specifies the keys which
map to the field
-values,
- the keyspace e.g. <b>Employee</b> which matches to the above keyspace
definition,
- finally fields which are to be persisted into Cassandra need to be
configured such that they
-receive a <b>name</b> e.g. (name, dateOfBirth, ssn and salary respectively),
the column <b>family</b>
-to which they belong e.g. (all p in this case) and an additional
<b>qualifier</b>, which enables
-more granular control over the data to be persisted into Cassandra.
+
+The <b>keyspace</b> element; where we specify:
+
+1. a parameter containing the Cassandra keyspace schema name e.g.
<b>Employee</b>,
+
+2. a parameter containing the host e.g. <b>localhost</b>,
+
+3. a parameter containing the Cassandra cluster name e.g. <b>Gora Cassandra
Test Cluster</b>,
+
+4. A nested element containing the name and 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 contains an optional <b>type</b>
attribute which further defines this as a super column.
+
+The <b>class</b> element specifying persistent fields which values should map
to. This element contains;
+
+1. a parameter containing the Persistent class name e.g.
<b>org.apache.gora.examples.generated.Employee</b>,
+
+2. a parameter containing the keyClass e.g. <b>java.lang.String</b> which
specifies the keys which map to the field values,
+
+3. a parameter containing the keyspace e.g. <b>Employee</b> which matches to
the above keyspace definition,
+
+4. finally a child element(s) <b>field</b> which represent fields which are to
be persisted into Cassandra. These need to be configured such that they receive
the following;
+
+ a parameter <b>name</b> e.g. (name, dateOfBirth, ssn and salary
respectively),
+
+ a parameter containing the column <b>family</b> to which the field belongs
e.g. (all p in this case),
+
+ an optional parameter <b>qualifier</b>, which enables more granular
control over the data to be persisted into Cassandra.
