blob: fd76f74bf8be886fb8eafc42c8a3c0bd219d9339 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="author" content="" />
<META http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<META name="Description" content="Apache Gora -- Gora Cassandra Module" />
<META name="Keywords" content="Apache Gora NoSQL Framework" />
<META name="Owner" content="" />
<META name="Robots" content="index, follow" />
<META name="Security" content="Public" />
<META name="Source" content="wiki template" />
<META name="DC.Rights" content="Copyright 2010-2023, The Apache Software Foundation" />
<!-- The styles -->
<link href="/resources/css/bootstrap.css" rel="stylesheet">
<style type="text/css">
body {
padding-top: 60px;
padding-bottom: 40px;
.headerlink {
visibility: hidden;
dt:hover > .headerlink, p:hover > .headerlink, td:hover > .headerlink, h1:hover > .headerlink, h2:hover > .headerlink, h3:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, h6:hover > .headerlink {
visibility: visible
} </style>
<link href="/resources/css/bootstrap-responsive.css" rel="stylesheet">
<link href="/resources/css/gora.css" rel="stylesheet">
<style type="text/css">
background: #E1E1E1;
background: -moz-linear-gradient(top, #E1E1E1 0%, #A7A7A7 100%); /* firefox */
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#E1E1E1), color-stop(100%,#A7A7A7)); /* webkit */
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#E1E1E1', endColorstr='#A7A7A7',GradientType=0 ); /* ie */
background: -o-linear-gradient(top, #E1E1E1 0%,#A7A7A7 100%); /* opera */
color: #636363;
#stpulldown .stpulldown-logo
height: 40px;
width: 300px;
margin-left: 20px;
margin-top: 5px;
background:url("") no-repeat;
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src=""></script>
<!-- Fav and touch icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="">
<link rel="apple-touch-icon-precomposed" href="">
<link rel="shortcut icon" href="/resources/img/feather-small.png">
<title>Apache Gora&trade; - Gora Cassandra Module</title>
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<a class="brand" href="/index.html"><img src="/resources/img/gora-logo.png" alt="Apache Gora" title="Apache Gora"/></a>
<div class="nav-collapse collapse">
<ul class="nav">
<li><a href="/downloads.html">Downloads</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
<ul class="dropdown-menu pull-right">
<li><a href="">Board Reporting</a></li>
<li><a href="/contribute.html">Contribute</a></li>
<li><a href="/mailing_lists.html">Mailing Lists</a></li>
<li><a href="/credits.html">People</a></li>
<li><a href="/related.html">Related Projects</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu pull-right">
<li><a href="/about.html">About</a></li>
<li><a href="/current/index.html">Current Documentation</a></li>
<li><a href="/current/api/javadoc.html">JavaDoc Documentation</a></li>
<li><a href="/current/tutorial.html">Gora Tutorial</a></li>
<li><a href="">Gora Wiki</a></li>
<li><a href="">Gora Wikipedia Entry</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu pull-right">
<li><a href="">Issue Tracking</a></li>
<li><a href="/mailing_lists.html">Mailing Lists</a></li>
<li><a href="">Nightly Builds</a></li>
<li><a href="">Sonar Analysis</a></li>
<li><a href="/version_control.html">Version Control</a></li>
<li><a href="/roadmap.html">Roadmap</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<img src="/resources/img/feather-small.png" alt="Apache" title="Apache" />
<b class="caret"></b>
<ul class="dropdown-menu pull-right">
<li><a href="">Apache Home</a></li>
<li><a href="">Apache License</a></li>
<li><a href="">Security</a></li>
<li><a href="">Support</a></li>
<li><a href="">Thanks</a></li>
<form id="search-form" class="navbar-search pull-right" action="" method="get">
<input value="" name="sitesearch" type="hidden" />
<input class="search-query" name="q" id="query" type="text" />
<script type="text/javascript" src=""></script>
</div> <!--/.nav-collapse -->
</div> <!-- /container -->
</div> <!-- /navbar-inner -->
</div> <!-- /navbar -->
<div class="container top-buffer" id="Gora_Gora Cassandra Module">
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permalink">&para;</a></h2>
<p>This is the main documentation for the gora-cassandra module which
enables <a href="">Apache Cassandra</a> backend support for Gora.</p>
<div id="toc"><ul><li><a class="toc-href" href="#goraproperties" title=""></a></li><li><a class="toc-href" href="#gora-cassandra-mappings" title="Gora Cassandra mappings">Gora Cassandra mappings</a></li></ul></div>
<h2 id="goraproperties"><a class="headerlink" href="#goraproperties" title="Permalink">&para;</a></h2>
<table class="table">
<th align="left">Property Key</th>
<th align="left">Property Value</th>
<th align="left">Required</th>
<th align="left">Description</th>
<td>Implementation of the persistent Java storage class</td>
<td>The XML mapping file to be used. If no value is used this defaults to <code>gora-cassandra-mapping.xml</code></td>
<td>This value should specify the host for a running Cassandra server or node. In this case the server happens to be running on localhost which is the default Cassandra server configuration.</td>
<td>This value should specify the cql port for a running Cassandra server or node. In this case the server happens to be running on 9042 port which is the default Cassandra server configuration.</td>
<td>Test Cluster</td>
<td>This value should specify the cassandra cluster name for a running Cassandra server or node. In this case the server has configured to run with Cassandra cluster name as 'Test Cluster' which is the default Cassandra server configuration.</td>
<td>The authentication details for passing a <b>username</b> to the CassandraHostConfigurator. This will be required if security is required for Cassandra reads and writes.</td>
<td>The authentication details for passing a <b>password</b> to the CassandraHostConfigurator. This will be required if security is required for Cassandra reads and writes.</td>
<td>The serialization type for persist into the cassandra data store. default value is Native serialization type</td>
<h2 id="gora-cassandra-mappings">Gora Cassandra mappings<a class="headerlink" href="#gora-cassandra-mappings" title="Permalink">&para;</a></h2>
<p>Say we wished to map some CassandraRecord data and store it into the CassandraStore.</p>
&lt;keyspace name="RecordKeySpace" durableWrite="false"&gt;
&lt;placementStrategy name="SimpleStrategy" replication_factor="1"/&gt;
&lt;class name="org.apache.gora.cassandra.example.generated.AvroSerialization.CassandraRecord"
table="CassandraRecord" allowFiltering="true" id="5a1c395e-b41f-11e5-9f22-ba0be0483c18"&gt;
&lt;field name="name" column="name" type="text"/&gt;
&lt;field name="dataInt" column="age" type="int"/&gt;
&lt;field name="salary" column="salary" type="bigint"/&gt;
&lt;field name="dataDouble" column="testDouble" type="double"/&gt;
&lt;field name="dataBytes" column="quotes" type="blob"/&gt;
&lt;field name="arrayInt" column="listInt" type="list(int)"/&gt;
&lt;field name="arrayString" column="listString" type="list(text)"/&gt;
&lt;field name="arrayLong" column="listLong" type="list(bigint)"/&gt;
&lt;field name="arrayDouble" column="listDouble" type="list(double)"/&gt;
&lt;field name="mapInt" column="mapInt" type="map(text,int)"/&gt;
&lt;field name="mapString" column="mapString" type="map(text,text)"/&gt;
&lt;field name="mapLong" column="mapLong" type="map(text,bigint)"/&gt;
&lt;field name="mapDouble" column="mapDouble" type="map(text,double)"/&gt;
&lt;cassandraKey name="org.apache.gora.cassandra.example.generated.AvroSerialization.CassandraKey"&gt;
&lt;field name="url" column="urlData" type="text"/&gt;
&lt;field name="timestamp" column="timestampData" type="bigint"/&gt;
&lt;key column="timestampData" order="desc"/&gt;
<p>Here you can see that we require the definition of two child elements within the
<code>gora-otd</code> mapping configuration, namely;</p>
<p>The <b>keyspace</b> element; where we specify:</p>
<p>a parameter containing the Cassandra keyspace schema name e.g. <b>RecordKeySpace</b>,</p>
<p>a parameter containing the durable write enabled property in the Cassandra keyspace e.g. <b>false</b>, More about durable write can be found <a href="">here</a>.</p>
<p>the child element <b>placementStrategy</b> containing the Cassandra placementStrategy details, a parameter containing the Cassandra placement strategy name, e.g. <b>SimpleStrategy</b>, gora-cassandra will use SimpleStrategy by default if no value for this attribute is specified. More about placement strategies can be found <a href="">here</a>.</p>
<p>a parameter containing a <b>replicationFactor</b> attribute with value integer. Again the replicationFactor value associated with the Keyspace tag
will only apply if Gora creates the Keyspace and will have no effect if this is being used against
an existing keyspace. the default value for 'replicationFactor' is '1'.</p>
<p>The <b>class</b> element specifying persistent fields which values should map to. This element contains;</p>
<p>a parameter containing the Persistent class name e.g. <b>org.apache.gora.cassandra.example.generated.AvroSerialization.CassandraRecord</b>,</p>
<p>a parameter containing the keyClass e.g. <b>org.apache.gora.cassandra.example.generated.AvroSerialization.CassandraKey</b> which specifies the keys which map to the field values,</p>
<p>a parameter containing the keyspace e.g. <b>RecordKeySpace</b> which matches to the above keyspace definition,</p>
<p>a parameter containing the table name e.g. <b>CassandraRecord</b>,</p>
<p>a parameter containing the allow filtering e.g. <b>true</b>, More about allow filtering can be found <a href="">here</a>.</p>
<p>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;</p>
<p>finally a parameter <b>name</b> e.g. (name, dateOfBirth, ssn and salary respectively) which map to Gora field name,</p>
<p>a parameter containing the column name e.g. <b>name</b>,</p>
<p>a parameter containing the data type of the column e.g. <b>text</b>,</p>
<p>an optional parameter <b>primarykey</b>, which indicates the primary key.</p>
<p>The <b>cassandraKey</b> element specifying composite key fields which is used in keyClass, This is optional, this element should be added only when composite keys are available;</p>
<p>a child element(s) <b>partitionKey</b> which represent cassandra partition key</p>
<p>a child element(s) <b>compositeKey</b> which represent cassandra composite partition key</p>
<p>a child element(s) <b>field</b> which represent partition key fields which are to be persisted into Cassandra. These need to be configured such that they receive the following;</p>
<p>a parameter <b>name</b> e.g. (name, dateOfBirth, ssn and salary respectively) which map to Gora field name,</p>
<p>a parameter containing the column name e.g. <b>name</b>,</p>
<p>a parameter containing the data type of the column <b>text</b>,</p>
<p>a child element(s) <b>clusterKey</b> which represent cassandra cluster key</p>
<p>a child element(s) <b>key</b> which represents column key fields which needs to be add clustered key.</p>
<p>a parameter containing the column name e.g. <b>name</b>,</p>
<p>a parameter containing the Order type of the column to be applied e.g. <b>desc</b>,</p>
</div> <!-- /container (main block) -->
<div class="container">
<p>Copyright © 2010-2023 The Apache Software Foundation. Licensed under <a href="">Apache License 2.0</a>.
<p>Apache Gora, Gora, Apache, the Apache feather logo, and the Apache Gora project logo are trademarks of The Apache Software Foundation.
</div> <!-- /container -->
<!-- The javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src=""; type="text/javascript"></script>
<script src="/resources/js/bootstrap.min.js"></script>
<script type="text/javascript">stLight.options({publisher: "4059fafd-3891-49f9-8c96-e4100290d8e6", doNotHash: false, doNotCopy: false, hashAddressBar: false});</script>
<link rel="stylesheet" href="/resources/css/docco.css">
<script src="//"></script>