Added: cassandra/site/publish/doc/latest/cql/operators.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/operators.html?rev=1795259&view=auto ============================================================================== --- cassandra/site/publish/doc/latest/cql/operators.html (added) +++ cassandra/site/publish/doc/latest/cql/operators.html Tue May 16 02:01:22 2017 @@ -0,0 +1,451 @@ +<!DOCTYPE html> +<html> + + + + + + + + + + +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. +"> + <meta name="keywords" content="cassandra, apache, apache cassandra, distributed storage, key value store, scalability, bigtable, dynamo" /> + <meta name="robots" content="index,follow" /> + <meta name="language" content="en" /> + + <title>Documentation</title> + + <link rel="canonical" href="http://cassandra.apache.org/doc/latest/cql/operators.html";> + + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"; integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> + <link rel="stylesheet" href="./../../../css/style.css"> + + <link rel="stylesheet" href="./../../../css/sphinx.css"> + + + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="JSON Support" href="json.html"/> <link rel="prev" title="Functions" href="functions.html"/> +</head> + + <body> + <!-- breadcrumbs --> +<div class="topnav"> + <div class="container breadcrumb-container"> + <ul class="breadcrumb"> + <li> + <div class="dropdown"> + <img class="asf-logo" src="./../../../img/asf_feather.png" /> + <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + <li><a href="http://www.apache.org";>Apache Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + </li> + + + <li><a href="./../../../">Apache Cassandra</a></li> + + + + + <li><a href="./../../../doc">Documentation</a></li> + + + + + <li><a href="./">The Cassandra Query Language (CQL)</a></li> + + + + <li>Arithmetic Operators</li> + + </ul> + </div> + + <!-- navbar --> + <nav class="navbar navbar-default navbar-static-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#cassandra-menu" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="./../../../"><img src="./../../../img/cassandra_logo.png" alt="Apache Cassandra logo" /></a> + </div><!-- /.navbar-header --> + + <div id="cassandra-menu" class="collapse navbar-collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="./../../../">Home</a></li> + <li><a href="./../../../download/">Download</a></li> + <li><a href="./../../../doc/">Documentation</a></li> + <li><a href="./../../../community/">Community</a></li> + </ul> + </div><!-- /#cassandra-menu --> + + + </div> + </nav><!-- /.navbar --> +</div><!-- /.topnav --> + + <div class="container-fluid"> + <div class="row"> + <div class="col-md-2"> + <div class="doc-navigation"> + <div class="doc-menu" role="navigation"> + <div class="navbar-header"> + <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse sidebar-navbar-collapse"> + <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> + <div class="form-group"> + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> + </form> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">The Cassandra Query Language (CQL)</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="definitions.html">Definitions</a></li> +<li class="toctree-l2"><a class="reference internal" href="types.html">Data Types</a></li> +<li class="toctree-l2"><a class="reference internal" href="ddl.html">Data Definition</a></li> +<li class="toctree-l2"><a class="reference internal" href="dml.html">Data Manipulation</a></li> +<li class="toctree-l2"><a class="reference internal" href="indexes.html">Secondary Indexes</a></li> +<li class="toctree-l2"><a class="reference internal" href="mvs.html">Materialized Views</a></li> +<li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li> +<li class="toctree-l2"><a class="reference internal" href="functions.html">Functions</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Arithmetic Operators</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#id2">Number Arithmetic</a></li> +<li class="toctree-l3"><a class="reference internal" href="#id4">Datetime Arithmetic</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="json.html">JSON Support</a></li> +<li class="toctree-l2"><a class="reference internal" href="triggers.html">Triggers</a></li> +<li class="toctree-l2"><a class="reference internal" href="appendices.html">Appendices</a></li> +<li class="toctree-l2"><a class="reference internal" href="changes.html">Changes</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> +</ul> + + + + </div><!--/.nav-collapse --> + </div> + </div> + </div> + <div class="col-md-8"> + <div class="content doc-content"> + <div class="container"> + + <div class="section" id="datetime-arithmetic"> +<span id="number-arithmetic"></span><span id="arithmetic-operators"></span><span id="id1"></span><h1>Arithmetic Operators<a class="headerlink" href="#datetime-arithmetic" title="Permalink to this headline">¶</a></h1> +<p>CQL supports the following operators:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="13%" /> +<col width="87%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Operator</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>- (unary)</td> +<td>Negates operand</td> +</tr> +<tr class="row-odd"><td>+</td> +<td>Addition</td> +</tr> +<tr class="row-even"><td>-</td> +<td>Substraction</td> +</tr> +<tr class="row-odd"><td>*</td> +<td>Multiplication</td> +</tr> +<tr class="row-even"><td>/</td> +<td>Division</td> +</tr> +<tr class="row-odd"><td>%</td> +<td>Returns the remainder of a division</td> +</tr> +</tbody> +</table> +<div class="section" id="id2"> +<span id="id3"></span><h2>Number Arithmetic<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> +<p>All arithmetic operations are supported on numeric types or counters.</p> +<p>The return type of the operation will be based on the operand types:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="13%" /> +<col width="11%" /> +<col width="10%" /> +<col width="10%" /> +<col width="10%" /> +<col width="10%" /> +<col width="10%" /> +<col width="10%" /> +<col width="10%" /> +<col width="10%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">left/right</th> +<th class="head">tinyint</th> +<th class="head">smallint</th> +<th class="head">int</th> +<th class="head">bigint</th> +<th class="head">counter</th> +<th class="head">float</th> +<th class="head">double</th> +<th class="head">varint</th> +<th class="head">decimal</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><strong>tinyint</strong></td> +<td>tinyint</td> +<td>smallint</td> +<td>int</td> +<td>bigint</td> +<td>bigint</td> +<td>float</td> +<td>double</td> +<td>varint</td> +<td>decimal</td> +</tr> +<tr class="row-odd"><td><strong>smallint</strong></td> +<td>smallint</td> +<td>smallint</td> +<td>int</td> +<td>bigint</td> +<td>bigint</td> +<td>float</td> +<td>double</td> +<td>varint</td> +<td>decimal</td> +</tr> +<tr class="row-even"><td><strong>int</strong></td> +<td>int</td> +<td>int</td> +<td>int</td> +<td>bigint</td> +<td>bigint</td> +<td>float</td> +<td>double</td> +<td>varint</td> +<td>decimal</td> +</tr> +<tr class="row-odd"><td><strong>bigint</strong></td> +<td>bigint</td> +<td>bigint</td> +<td>bigint</td> +<td>bigint</td> +<td>bigint</td> +<td>double</td> +<td>double</td> +<td>varint</td> +<td>decimal</td> +</tr> +<tr class="row-even"><td><strong>counter</strong></td> +<td>bigint</td> +<td>bigint</td> +<td>bigint</td> +<td>bigint</td> +<td>bigint</td> +<td>double</td> +<td>double</td> +<td>varint</td> +<td>decimal</td> +</tr> +<tr class="row-odd"><td><strong>float</strong></td> +<td>float</td> +<td>float</td> +<td>float</td> +<td>double</td> +<td>double</td> +<td>float</td> +<td>double</td> +<td>decimal</td> +<td>decimal</td> +</tr> +<tr class="row-even"><td><strong>double</strong></td> +<td>double</td> +<td>double</td> +<td>double</td> +<td>double</td> +<td>double</td> +<td>double</td> +<td>double</td> +<td>decimal</td> +<td>decimal</td> +</tr> +<tr class="row-odd"><td><strong>varint</strong></td> +<td>varint</td> +<td>varint</td> +<td>varint</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +</tr> +<tr class="row-even"><td><strong>decimal</strong></td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +<td>decimal</td> +</tr> +</tbody> +</table> +<p><code class="docutils literal"><span class="pre">*</span></code>, <code class="docutils literal"><span class="pre">/</span></code> and <code class="docutils literal"><span class="pre">%</span></code> operators have a higher precedence level than <code class="docutils literal"><span class="pre">+</span></code> and <code class="docutils literal"><span class="pre">-</span></code> operator. By consequence, +they will be evaluated before. If two operator in an expression have the same precedence level, they will be evaluated +left to right based on their position in the expression.</p> +</div> +<div class="section" id="id4"> +<span id="id5"></span><h2>Datetime Arithmetic<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2> +<p>A <code class="docutils literal"><span class="pre">duration</span></code> can be added (+) or substracted (-) from a <code class="docutils literal"><span class="pre">timestamp</span></code> or a <code class="docutils literal"><span class="pre">date</span></code> to create a new +<code class="docutils literal"><span class="pre">timestamp</span></code> or <code class="docutils literal"><span class="pre">date</span></code>. So for instance:</p> +<div class="highlight-cql"><div class="highlight"><pre><span class="k">SELECT</span> <span class="o">*</span> <span class="k">FROM</span> <span class="n">myTable</span> <span class="k">WHERE</span> <span class="n">t</span> <span class="o">=</span> <span class="s1">'2017-01-01'</span> <span class="o">-</span> <span class="mf">2</span><span class="n">d</span> +</pre></div> +</div> +<p>will select all the records with a value of <code class="docutils literal"><span class="pre">t</span></code> which is in the last 2 days of 2016.</p> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="json.html" class="btn btn-default pull-right " role="button" title="JSON Support" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="functions.html" class="btn btn-default" role="button" title="Functions" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + + </div> + + </div> + </div> + </div> + <div class="col-md-2"> + </div> + </div> +</div> + + <footer> + <div class="container"> + <div class="col-md-4 social-blk"> + <span class="social"> + <a href="https://twitter.com/cassandra"; + class="twitter-follow-button" + data-show-count="false" data-size="large">Follow @cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + <a href="https://twitter.com/intent/tweet?button_hashtag=cassandra"; + class="twitter-hashtag-button" + data-size="large" + data-related="ApacheCassandra">Tweet #cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + </span> + </div> + + <div class="col-md-8 trademark"> + <p>© 2016 <a href="http://apache.org";>The Apache Software Foundation</a>. + Apache, the Apache feather logo, and Apache Cassandra are trademarks of The Apache Software Foundation. + <p> + </div> + </div><!-- /.container --> +</footer> + +<!-- Javascript. Placed here so pages load faster --> +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> +<script src="./../../../js/underscore-min.js"></script> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"; integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> + + +<script src="./../../../js/doctools.js"></script> +<script src="./../../../js/searchtools.js"></script> + + <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: "", VERSION: "", COLLAPSE_INDEX: false, FILE_SUFFIX: ".html", HAS_SOURCE: false, SOURCELINK_SUFFIX: "" }; </script> + +<script type="text/javascript"> +$(function() { + // Stick the #nav to the top of the window + var nav = $('.doc-navigation'); + var navHomeY = nav.offset().top; + var isFixed = false; + var $w = $(window); + $w.scroll(function() { + var scrollTop = $w.scrollTop(); + var shouldBeFixed = $w.width() > 991 && scrollTop >= navHomeY - 10; + if (shouldBeFixed && !isFixed) { + nav.css({ + position: 'fixed', + top: 0, + left: nav.offset().left, + width: nav.width(), + }); + nav.addClass('fixed-navigation'); + isFixed = true; + } + else if (!shouldBeFixed && isFixed) + { + nav.css({ + position: 'static' + }); + nav.removeClass('fixed-navigation'); + isFixed = false; + } + }); +}); +</script> + + +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; : "http://www.";); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); + + try { + var pageTracker = _gat._getTracker("UA-11583863-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> + + + </body> +</html>
Modified: cassandra/site/publish/doc/latest/cql/security.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/security.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/security.html (original) +++ cassandra/site/publish/doc/latest/cql/security.html Tue May 16 02:01:22 2017 @@ -141,6 +141,7 @@ </ul> </li> <li class="toctree-l2"><a class="reference internal" href="functions.html">Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="operators.html">Arithmetic Operators</a></li> <li class="toctree-l2"><a class="reference internal" href="json.html">JSON Support</a></li> <li class="toctree-l2"><a class="reference internal" href="triggers.html">Triggers</a></li> <li class="toctree-l2"><a class="reference internal" href="appendices.html">Appendices</a></li> @@ -151,7 +152,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/cql/triggers.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/triggers.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/triggers.html (original) +++ cassandra/site/publish/doc/latest/cql/triggers.html Tue May 16 02:01:22 2017 @@ -136,6 +136,7 @@ <li class="toctree-l2"><a class="reference internal" href="mvs.html">Materialized Views</a></li> <li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li> <li class="toctree-l2"><a class="reference internal" href="functions.html">Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="operators.html">Arithmetic Operators</a></li> <li class="toctree-l2"><a class="reference internal" href="json.html">JSON Support</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">Triggers</a><ul> <li class="toctree-l3"><a class="reference internal" href="#create-trigger">CREATE TRIGGER</a></li> @@ -150,7 +151,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/cql/types.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/types.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/types.html (original) +++ cassandra/site/publish/doc/latest/cql/types.html Tue May 16 02:01:22 2017 @@ -134,6 +134,7 @@ <li class="toctree-l3"><a class="reference internal" href="#working-with-timestamps">Working with timestamps</a></li> <li class="toctree-l3"><a class="reference internal" href="#working-with-dates">Working with dates</a></li> <li class="toctree-l3"><a class="reference internal" href="#working-with-times">Working with times</a></li> +<li class="toctree-l3"><a class="reference internal" href="#working-with-durations">Working with durations</a></li> <li class="toctree-l3"><a class="reference internal" href="#collections">Collections</a></li> <li class="toctree-l3"><a class="reference internal" href="#user-defined-types">User-Defined Types</a></li> <li class="toctree-l3"><a class="reference internal" href="#tuples">Tuples</a></li> @@ -146,6 +147,7 @@ <li class="toctree-l2"><a class="reference internal" href="mvs.html">Materialized Views</a></li> <li class="toctree-l2"><a class="reference internal" href="security.html">Security</a></li> <li class="toctree-l2"><a class="reference internal" href="functions.html">Functions</a></li> +<li class="toctree-l2"><a class="reference internal" href="operators.html">Arithmetic Operators</a></li> <li class="toctree-l2"><a class="reference internal" href="json.html">JSON Support</a></li> <li class="toctree-l2"><a class="reference internal" href="triggers.html">Triggers</a></li> <li class="toctree-l2"><a class="reference internal" href="appendices.html">Appendices</a></li> @@ -156,7 +158,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> @@ -192,6 +194,7 @@ types</span></a>:</p> | DATE | DECIMAL | DOUBLE + | DURATION | FLOAT | INET | INT @@ -254,58 +257,62 @@ types</span></a>:</p> <a class="reference internal" href="definitions.html#grammar-token-float"><code class="xref std std-token docutils literal"><span class="pre">float</span></code></a></td> <td>64-bit IEEE-754 floating point</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">float</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">duration</span></code></td> +<td><code class="xref std std-token docutils literal"><span class="pre">duration</span></code>,</td> +<td>A duration with nanosecond precision. See <a class="reference internal" href="#durations"><span class="std std-ref">Working with durations</span></a> below for details</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">float</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a>, <a class="reference internal" href="definitions.html#grammar-token-float"><code class="xref std std-token docutils literal"><span class="pre">float</span></code></a></td> <td>32-bit IEEE-754 floating point</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">inet</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">inet</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-string"><code class="xref std std-token docutils literal"><span class="pre">string</span></code></a></td> <td>An IP address, either IPv4 (4 bytes long) or IPv6 (16 bytes long). Note that there is no <code class="docutils literal"><span class="pre">inet</span></code> constant, IP address should be input as strings</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">int</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">int</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a></td> <td>32-bit signed int</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">smallint</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">smallint</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a></td> <td>16-bit signed int</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">text</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">text</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-string"><code class="xref std std-token docutils literal"><span class="pre">string</span></code></a></td> <td>UTF8 encoded string</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">time</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">time</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a>, <a class="reference internal" href="definitions.html#grammar-token-string"><code class="xref std std-token docutils literal"><span class="pre">string</span></code></a></td> <td>A time (with no corresponding date value) with nanosecond precision. See <a class="reference internal" href="#times"><span class="std std-ref">Working with times</span></a> below for details</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a>, <a class="reference internal" href="definitions.html#grammar-token-string"><code class="xref std std-token docutils literal"><span class="pre">string</span></code></a></td> <td>A timestamp (date and time) with millisecond precision. See <a class="reference internal" href="#timestamps"><span class="std std-ref">Working with timestamps</span></a> below for details</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">timeuuid</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">timeuuid</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-uuid"><code class="xref std std-token docutils literal"><span class="pre">uuid</span></code></a></td> <td>Version 1 <a class="reference external" href="https://en.wikipedia.org/wiki/Universally_unique_identifier";>UUID</a>, generally used as a âconflict-freeâ timestamp. Also see <a class="reference internal" href="functions.html#timeuuid-functions"><span class="std std-ref">Timeuuid functions</span></a></td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">tinyint</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tinyint</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a></td> <td>8-bit signed int</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">uuid</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">uuid</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-uuid"><code class="xref std std-token docutils literal"><span class="pre">uuid</span></code></a></td> <td>A <a class="reference external" href="https://en.wikipedia.org/wiki/Universally_unique_identifier";>UUID</a> (of any version)</td> </tr> -<tr class="row-even"><td><code class="docutils literal"><span class="pre">varchar</span></code></td> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">varchar</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-string"><code class="xref std std-token docutils literal"><span class="pre">string</span></code></a></td> <td>UTF8 encoded string</td> </tr> -<tr class="row-odd"><td><code class="docutils literal"><span class="pre">varint</span></code></td> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">varint</span></code></td> <td><a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref std std-token docutils literal"><span class="pre">integer</span></code></a></td> <td>Arbitrary-precision integer</td> </tr> @@ -377,6 +384,50 @@ time:</p> <li><code class="docutils literal"><span class="pre">'08:12:54.123456789'</span></code></li> </ul> </div> +<div class="section" id="working-with-durations"> +<span id="durations"></span><h2>Working with durations<a class="headerlink" href="#working-with-durations" title="Permalink to this headline">¶</a></h2> +<p>Values of the <code class="docutils literal"><span class="pre">duration</span></code> type are encoded as 3 signed integer of variable lengths. The first integer represents the +number of months, the second the number of days and the third the number of nanoseconds. This is due to the fact that +the number of days in a month can change, and a day can have 23 or 25 hours depending on the daylight saving. +Internally, the number of months and days are decoded as 32 bits integers whereas the number of nanoseconds is decoded +as a 64 bits integer.</p> +<p>A duration can be input as:</p> +<blockquote> +<div><ol class="arabic"> +<li><p class="first"><code class="docutils literal"><span class="pre">(quantity</span> <span class="pre">unit)+</span></code> like <code class="docutils literal"><span class="pre">12h30m</span></code> where the unit can be:</p> +<blockquote> +<div><ul class="simple"> +<li><code class="docutils literal"><span class="pre">y</span></code>: years (12 months)</li> +<li><code class="docutils literal"><span class="pre">mo</span></code>: months (1 month)</li> +<li><code class="docutils literal"><span class="pre">w</span></code>: weeks (7 days)</li> +<li><code class="docutils literal"><span class="pre">d</span></code>: days (1 day)</li> +<li><code class="docutils literal"><span class="pre">h</span></code>: hours (3,600,000,000,000 nanoseconds)</li> +<li><code class="docutils literal"><span class="pre">m</span></code>: minutes (60,000,000,000 nanoseconds)</li> +<li><code class="docutils literal"><span class="pre">s</span></code>: seconds (1,000,000,000 nanoseconds)</li> +<li><code class="docutils literal"><span class="pre">ms</span></code>: milliseconds (1,000,000 nanoseconds)</li> +<li><code class="docutils literal"><span class="pre">us</span></code> or <code class="docutils literal"><span class="pre">µs</span></code> : microseconds (1000 nanoseconds)</li> +<li><code class="docutils literal"><span class="pre">ns</span></code>: nanoseconds (1 nanosecond)</li> +</ul> +</div></blockquote> +</li> +<li><p class="first">ISO 8601 format: <code class="docutils literal"><span class="pre">P[n]Y[n]M[n]DT[n]H[n]M[n]S</span> <span class="pre">or</span> <span class="pre">P[n]W</span></code></p> +</li> +<li><p class="first">ISO 8601 alternative format: <code class="docutils literal"><span class="pre">P[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]</span></code></p> +</li> +</ol> +</div></blockquote> +<p>For example:</p> +<div class="highlight-cql"><div class="highlight"><pre><span class="k">INSERT</span> <span class="k">INTO</span> <span class="n">RiderResults</span> <span class="p">(</span><span class="n">rider</span><span class="p">,</span> <span class="n">race</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="k">VALUES</span> <span class="p">(</span><span class="s1">'Christopher Froome'</span><span class="p">,</span> <span class="s1">'Tour de France'</span><span class="p">,</span> <span class="mf">89</span><span class="n">h4m48s</span><span class="p">);</span> +<span class="k">INSERT</span> <span class="k">INTO</span> <span class="n">RiderResults</span> <span class="p">(</span><span class="n">rider</span><span class="p">,</span> <span class="n">race</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="k">VALUES</span> <span class="p">(</span><span class="s1">'BARDET Romain'</span><span class="p">,</span> <span class="s1">'Tour de France'</span><span class="p">,</span> <span class="n">PT89H8M53S</span><span class="p">);</span> +<span class="k">INSERT</span> <span class="k">INTO</span> <span class="n">RiderResults</span> <span class="p">(</span><span class="n">rider</span><span class="p">,</span> <span class="n">race</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="k">VALUES</span> <span class="p">(</span><span class="s1">'QUINTANA Nairo'</span><span class="p">,</span> <span class="s1">'Tour de France'</span><span class="p">,</span> <span class="n">P0000</span><span class="o">-</span><span class="mf">00</span><span class="o">-</span><span class="mf">00</span><span class="n">T89</span><span class="p">:</span><span class="mf">09</span><span class="p">:</span><span class="mf">09</span><span class="p">);</span> +</pre></div> +</div> +<p id="duration-limitation">Duration columns cannot be used in a table’s <code class="docutils literal"><span class="pre">PRIMARY</span> <span class="pre">KEY</span></code>. This limitation is due to the fact that +durations cannot be ordered. It is effectively not possible to know if <code class="docutils literal"><span class="pre">1mo</span></code> is greater than <code class="docutils literal"><span class="pre">29d</span></code> without a date +context.</p> +<p>A <code class="docutils literal"><span class="pre">1d</span></code> duration is not equals to a <code class="docutils literal"><span class="pre">24h</span></code> one as the duration type has been created to be able to support daylight +saving.</p> +</div> <div class="section" id="collections"> <span id="id4"></span><h2>Collections<a class="headerlink" href="#collections" title="Permalink to this headline">¶</a></h2> <p>CQL supports 3 kind of collections: <a class="reference internal" href="#maps"><span class="std std-ref">Maps</span></a>, <a class="reference internal" href="#sets"><span class="std std-ref">Sets</span></a> and <a class="reference internal" href="#lists"><span class="std std-ref">Lists</span></a>. The types of those collections is defined @@ -632,14 +683,11 @@ For instance, one could insert into the <p>An existing user-defined type can be modified using an <code class="docutils literal"><span class="pre">ALTER</span> <span class="pre">TYPE</span></code> statement:</p> <pre> <strong id="grammar-token-alter_type_statement">alter_type_statement </strong> ::= ALTER TYPE <a class="reference internal" href="#grammar-token-udt_name"><code class="xref docutils literal"><span class="pre">udt_name</span></code></a> <a class="reference internal" href="#grammar-token-alter_type_modification"><code class="xref docutils literal"><span class="pre">alter_type_modification</span></code></a> -<strong id="grammar-token-alter_type_modification">alter_type_modification</strong> ::= ALTER <a class="reference internal" href="definitions.html#grammar-token-identifier"><code class="xref docutils literal"><span class="pre">identifier</span></code></a> TYPE <a class="reference internal" href="#grammar-token-cql_type"><code class="xref docutils literal"><span class="pre">cql_type</span></code></a> - | ADD <a class="reference internal" href="#grammar-token-field_definition"><code class="xref docutils literal"><span class="pre">field_definition</span></code></a> +<strong id="grammar-token-alter_type_modification">alter_type_modification</strong> ::= ADD <a class="reference internal" href="#grammar-token-field_definition"><code class="xref docutils literal"><span class="pre">field_definition</span></code></a> | RENAME <a class="reference internal" href="definitions.html#grammar-token-identifier"><code class="xref docutils literal"><span class="pre">identifier</span></code></a> TO <a class="reference internal" href="definitions.html#grammar-token-identifier"><code class="xref docutils literal"><span class="pre">identifier</span></code></a> ( <a class="reference internal" href="definitions.html#grammar-token-identifier"><code class="xref docutils literal"><span class="pre">identifier</span></code></a> TO <a class="reference internal" href="definitions.html#grammar-token-identifier"><code class="xref docutils literal"><span class="pre">identifier</span></code></a> )* </pre> <p>You can:</p> <ul class="simple"> -<li>modify the type of particular field (<code class="docutils literal"><span class="pre">ALTER</span> <span class="pre">TYPE</span> <span class="pre">address</span> <span class="pre">ALTER</span> <span class="pre">zip</span> <span class="pre">TYPE</span> <span class="pre">bigint</span></code>). The restrictions for such change -are the same than when <a class="reference internal" href="ddl.html#alter-table-statement"><span class="std std-ref">altering the type of column</span></a>.</li> <li>add a new field to the type (<code class="docutils literal"><span class="pre">ALTER</span> <span class="pre">TYPE</span> <span class="pre">address</span> <span class="pre">ADD</span> <span class="pre">country</span> <span class="pre">text</span></code>). That new field will be <code class="docutils literal"><span class="pre">null</span></code> for any values of the type created before the addition.</li> <li>rename the fields of the type (<code class="docutils literal"><span class="pre">ALTER</span> <span class="pre">TYPE</span> <span class="pre">address</span> <span class="pre">RENAME</span> <span class="pre">zip</span> <span class="pre">TO</span> <span class="pre">zipcode</span></code>).</li> Modified: cassandra/site/publish/doc/latest/data_modeling/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/data_modeling/index.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/data_modeling/index.html (original) +++ cassandra/site/publish/doc/latest/data_modeling/index.html Tue May 16 02:01:22 2017 @@ -130,7 +130,7 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Cassandra Development</a></li> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> Modified: cassandra/site/publish/doc/latest/development/code_style.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/code_style.html?rev=1795259&r1=1795258&r2=1795259&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/development/code_style.html (original) +++ cassandra/site/publish/doc/latest/development/code_style.html Tue May 16 02:01:22 2017 @@ -30,7 +30,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Cassandra Development" href="index.html"/> <link rel="next" title="Review Checklist" href="how_to_review.html"/> <link rel="prev" title="Contributing Code Changes" href="patches.html"/> + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Review Checklist" href="how_to_review.html"/> <link rel="prev" title="Contributing Code Changes" href="patches.html"/> </head> <body> @@ -63,7 +63,7 @@ - <li><a href="./">Cassandra Development</a></li> + <li><a href="./">Contributing to Cassandra</a></li> @@ -132,7 +132,8 @@ <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> -<li class="toctree-l1 current"><a class="reference internal" href="index.html">Cassandra Development</a><ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> @@ -148,6 +149,7 @@ </li> <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> Added: cassandra/site/publish/doc/latest/development/documentation.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/documentation.html?rev=1795259&view=auto ============================================================================== --- cassandra/site/publish/doc/latest/development/documentation.html (added) +++ cassandra/site/publish/doc/latest/development/documentation.html Tue May 16 02:01:22 2017 @@ -0,0 +1,340 @@ +<!DOCTYPE html> +<html> + + + + + + + + + + +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. +"> + <meta name="keywords" content="cassandra, apache, apache cassandra, distributed storage, key value store, scalability, bigtable, dynamo" /> + <meta name="robots" content="index,follow" /> + <meta name="language" content="en" /> + + <title>Documentation</title> + + <link rel="canonical" href="http://cassandra.apache.org/doc/latest/development/documentation.html";> + + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"; integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> + <link rel="stylesheet" href="./../../../css/style.css"> + + <link rel="stylesheet" href="./../../../css/sphinx.css"> + + + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Frequently Asked Questions" href="../faq/index.html"/> <link rel="prev" title="How-to Commit" href="how_to_commit.html"/> +</head> + + <body> + <!-- breadcrumbs --> +<div class="topnav"> + <div class="container breadcrumb-container"> + <ul class="breadcrumb"> + <li> + <div class="dropdown"> + <img class="asf-logo" src="./../../../img/asf_feather.png" /> + <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + <li><a href="http://www.apache.org";>Apache Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + </li> + + + <li><a href="./../../../">Apache Cassandra</a></li> + + + + + <li><a href="./../../../doc">Documentation</a></li> + + + + + <li><a href="./">Contributing to Cassandra</a></li> + + + + <li>Working on Documentation</li> + + </ul> + </div> + + <!-- navbar --> + <nav class="navbar navbar-default navbar-static-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#cassandra-menu" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="./../../../"><img src="./../../../img/cassandra_logo.png" alt="Apache Cassandra logo" /></a> + </div><!-- /.navbar-header --> + + <div id="cassandra-menu" class="collapse navbar-collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="./../../../">Home</a></li> + <li><a href="./../../../download/">Download</a></li> + <li><a href="./../../../doc/">Documentation</a></li> + <li><a href="./../../../community/">Community</a></li> + </ul> + </div><!-- /#cassandra-menu --> + + + </div> + </nav><!-- /.navbar --> +</div><!-- /.topnav --> + + <div class="container-fluid"> + <div class="row"> + <div class="col-md-2"> + <div class="doc-navigation"> + <div class="doc-menu" role="navigation"> + <div class="navbar-header"> + <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse sidebar-navbar-collapse"> + <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> + <div class="form-group"> + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> + </form> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> +<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> +<li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> +<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> +<li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Working on Documentation</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#how-cassandra-is-documented">How Cassandra is documented</a></li> +<li class="toctree-l3"><a class="reference internal" href="#github-based-work-flow">GitHub based work flow</a></li> +<li class="toctree-l3"><a class="reference internal" href="#jira-based-work-flow">Jira based work flow</a></li> +<li class="toctree-l3"><a class="reference internal" href="#working-on-documents-locally-using-sphinx">Working on documents locally using Sphinx</a></li> +<li class="toctree-l3"><a class="reference internal" href="#notes-for-committers">Notes for committers</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> +</ul> + + + + </div><!--/.nav-collapse --> + </div> + </div> + </div> + <div class="col-md-8"> + <div class="content doc-content"> + <div class="container"> + + <div class="section" id="working-on-documentation"> +<h1>Working on Documentation<a class="headerlink" href="#working-on-documentation" title="Permalink to this headline">¶</a></h1> +<div class="section" id="how-cassandra-is-documented"> +<h2>How Cassandra is documented<a class="headerlink" href="#how-cassandra-is-documented" title="Permalink to this headline">¶</a></h2> +<p>The official Cassandra documentation lives in the project’s git repository. We use a static site generator, <a class="reference external" href="http://www.sphinx-doc.org/";>Sphinx</a>, to create pages hosted at <a class="reference external" href="https://cassandra.apache.org/doc/latest/";>cassandra.apache.org</a>. You’ll also find developer centric content about Cassandra internals in our retired <a class="reference external" href="https://wiki.apache.org/cassandra";>wiki</a> (not covered by this guide).</p> +<p>Using a static site generator often requires to use a markup language instead of visual editors (which some people would call good news). Sphinx, the tool-set we use to generate our documentation, uses <a class="reference external" href="http://www.sphinx-doc.org/en/stable/rest.html";>reStructuredText</a> for that. Markup languages allow you to format text by making use of certain syntax elements. Your document structure will also have to follow specific conventions. Feel free to take a look at <a class="reference external" href="..">existing documents</a> to get a better idea how we use reStructuredText to write our documents.</p> +<p>So how do you actually start making contributions?</p> +</div> +<div class="section" id="github-based-work-flow"> +<h2>GitHub based work flow<a class="headerlink" href="#github-based-work-flow" title="Permalink to this headline">¶</a></h2> +<p><em>Recommended for shorter documents and minor changes on existing content (e.g. fixing typos or updating descriptions)</em></p> +<p>Follow these steps to contribute using GitHub. It’s assumed that you’re logged in with an existing account.</p> +<ol class="arabic simple"> +<li>Fork the GitHub mirror of the <a class="reference external" href="https://github.com/apache/cassandra";>Cassandra repository</a></li> +</ol> +<img alt="../_images/docs_fork.png" src="../_images/docs_fork.png" /> +<ol class="arabic simple" start="2"> +<li>Create a new branch that you can use to make your edits. It’s recommended to have a separate branch for each of your working projects. It will also make it easier to create a pull request later to when you decide youâre ready to contribute your work.</li> +</ol> +<img alt="../_images/docs_create_branch.png" src="../_images/docs_create_branch.png" /> +<ol class="arabic simple" start="3"> +<li>Navigate to document sources <code class="docutils literal"><span class="pre">doc/source</span></code> to find the <code class="docutils literal"><span class="pre">.rst</span></code> file to edit. The URL of the document should correspond to the directory structure. New files can be created using the “Create new file” button:</li> +</ol> +<img alt="../_images/docs_create_file.png" src="../_images/docs_create_file.png" /> +<ol class="arabic simple" start="4"> +<li>At this point you should be able to edit the file using the GitHub web editor. Start by naming your file and add some content. Have a look at other existing <code class="docutils literal"><span class="pre">.rst</span></code> files to get a better idea what format elements to use.</li> +</ol> +<img alt="../_images/docs_editor.png" src="../_images/docs_editor.png" /> +<p>Make sure to preview added content before committing any changes.</p> +<img alt="../_images/docs_preview.png" src="../_images/docs_preview.png" /> +<ol class="arabic simple" start="5"> +<li>Commit your work when you’re done. Make sure to add a short description of all your edits since the last time you committed before.</li> +</ol> +<img alt="../_images/docs_commit.png" src="../_images/docs_commit.png" /> +<ol class="arabic simple" start="6"> +<li>Finally if you decide that you’re done working on your branch, it’s time to create a pull request!</li> +</ol> +<img alt="../_images/docs_pr.png" src="../_images/docs_pr.png" /> +<p>Afterwards the GitHub Cassandra mirror will list your pull request and you’re done. Congratulations! Please give us some time to look at your suggested changes before we get back to you.</p> +</div> +<div class="section" id="jira-based-work-flow"> +<h2>Jira based work flow<a class="headerlink" href="#jira-based-work-flow" title="Permalink to this headline">¶</a></h2> +<p><em>Recommended for major changes</em></p> +<p>Significant changes to the documentation are best managed through our Jira issue tracker. Please follow the same <a class="reference external" href="https://cassandra.apache.org/doc/latest/development/patches.html";>contribution guides</a> as for regular code contributions. Creating high quality content takes a lot of effort. Itâs therefor always a good idea to create a ticket before you start and explain what youâre planing to do. This will create the opportunity for other contributors and committers to comment on your ideas and work so far. Eventually your patch gets a formal review before it is committed.</p> +</div> +<div class="section" id="working-on-documents-locally-using-sphinx"> +<h2>Working on documents locally using Sphinx<a class="headerlink" href="#working-on-documents-locally-using-sphinx" title="Permalink to this headline">¶</a></h2> +<p><em>Recommended for advanced editing</em></p> +<p>Using the GitHub web interface should allow you to use most common layout elements including images. More advanced formatting options and navigation elements depend on Sphinx to render correctly. Therefor itâs a good idea to setup Sphinx locally for any serious editing. Please follow the instructions in the Cassandra source directory at <code class="docutils literal"><span class="pre">doc/README.md</span></code>. Setup is very easy (at least on OSX and Linux).</p> +</div> +<div class="section" id="notes-for-committers"> +<h2>Notes for committers<a class="headerlink" href="#notes-for-committers" title="Permalink to this headline">¶</a></h2> +<p>Please feel free to get involved and merge pull requests created on the GitHub mirror if you’re a committer. As this is a read-only repository, you won’t be able to merge a PR directly on GitHub. You’ll have to commit the changes against the Apache repository with a comment that will close the PR when the committ syncs with GitHub.</p> +<p>You may use a git work flow like this:</p> +<div class="highlight-default"><div class="highlight"><pre><span class="n">git</span> <span class="n">remote</span> <span class="n">add</span> <span class="n">github</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">cassandra</span><span class="o">.</span><span class="n">git</span> +<span class="n">git</span> <span class="n">fetch</span> <span class="n">github</span> <span class="n">pull</span><span class="o">/<</span><span class="n">PR</span><span class="o">-</span><span class="n">ID</span><span class="o">>/</span><span class="n">head</span><span class="p">:</span><span class="o"><</span><span class="n">PR</span><span class="o">-</span><span class="n">ID</span><span class="o">></span> +<span class="n">git</span> <span class="n">checkout</span> <span class="o"><</span><span class="n">PR</span><span class="o">-</span><span class="n">ID</span><span class="o">></span> +</pre></div> +</div> +<p>Now either rebase or squash the commit, e.g. for squashing:</p> +<div class="highlight-default"><div class="highlight"><pre><span class="n">git</span> <span class="n">reset</span> <span class="o">--</span><span class="n">soft</span> <span class="n">origin</span><span class="o">/</span><span class="n">trunk</span> +<span class="n">git</span> <span class="n">commit</span> <span class="o">--</span><span class="n">author</span> <span class="o"><</span><span class="n">PR</span> <span class="n">Author</span><span class="o">></span> +</pre></div> +</div> +<p>Make sure to add a proper commit message including a “Closes #<PR-ID>” text to automatically close the PR.</p> +<div class="section" id="publishing"> +<h3>Publishing<a class="headerlink" href="#publishing" title="Permalink to this headline">¶</a></h3> +<p>Details for building and publishing of the site at cassandra.apache.org can be found <a class="reference external" href="https://svn.apache.org/repos/asf/cassandra/site/src/README";>here</a>.</p> +</div> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="../faq/index.html" class="btn btn-default pull-right " role="button" title="Frequently Asked Questions" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="how_to_commit.html" class="btn btn-default" role="button" title="How-to Commit" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + + </div> + + </div> + </div> + </div> + <div class="col-md-2"> + </div> + </div> +</div> + + <footer> + <div class="container"> + <div class="col-md-4 social-blk"> + <span class="social"> + <a href="https://twitter.com/cassandra"; + class="twitter-follow-button" + data-show-count="false" data-size="large">Follow @cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + <a href="https://twitter.com/intent/tweet?button_hashtag=cassandra"; + class="twitter-hashtag-button" + data-size="large" + data-related="ApacheCassandra">Tweet #cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + </span> + </div> + + <div class="col-md-8 trademark"> + <p>© 2016 <a href="http://apache.org";>The Apache Software Foundation</a>. + Apache, the Apache feather logo, and Apache Cassandra are trademarks of The Apache Software Foundation. + <p> + </div> + </div><!-- /.container --> +</footer> + +<!-- Javascript. Placed here so pages load faster --> +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> +<script src="./../../../js/underscore-min.js"></script> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"; integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> + + +<script src="./../../../js/doctools.js"></script> +<script src="./../../../js/searchtools.js"></script> + + <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: "", VERSION: "", COLLAPSE_INDEX: false, FILE_SUFFIX: ".html", HAS_SOURCE: false, SOURCELINK_SUFFIX: "" }; </script> + +<script type="text/javascript"> +$(function() { + // Stick the #nav to the top of the window + var nav = $('.doc-navigation'); + var navHomeY = nav.offset().top; + var isFixed = false; + var $w = $(window); + $w.scroll(function() { + var scrollTop = $w.scrollTop(); + var shouldBeFixed = $w.width() > 991 && scrollTop >= navHomeY - 10; + if (shouldBeFixed && !isFixed) { + nav.css({ + position: 'fixed', + top: 0, + left: nav.offset().left, + width: nav.width(), + }); + nav.addClass('fixed-navigation'); + isFixed = true; + } + else if (!shouldBeFixed && isFixed) + { + nav.css({ + position: 'static' + }); + nav.removeClass('fixed-navigation'); + isFixed = false; + } + }); +}); +</script> + + +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; : "http://www.";); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); + + try { + var pageTracker = _gat._getTracker("UA-11583863-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> + + + </body> +</html> Added: cassandra/site/publish/doc/latest/development/gettingstarted.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/development/gettingstarted.html?rev=1795259&view=auto ============================================================================== --- cassandra/site/publish/doc/latest/development/gettingstarted.html (added) +++ cassandra/site/publish/doc/latest/development/gettingstarted.html Tue May 16 02:01:22 2017 @@ -0,0 +1,308 @@ +<!DOCTYPE html> +<html> + + + + + + + + + + +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content="The Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. +"> + <meta name="keywords" content="cassandra, apache, apache cassandra, distributed storage, key value store, scalability, bigtable, dynamo" /> + <meta name="robots" content="index,follow" /> + <meta name="language" content="en" /> + + <title>Documentation</title> + + <link rel="canonical" href="http://cassandra.apache.org/doc/latest/development/gettingstarted.html";> + + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"; integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous"> + <link rel="stylesheet" href="./../../../css/style.css"> + + <link rel="stylesheet" href="./../../../css/sphinx.css"> + + + <link rel="top" title="Apache Cassandra Documentation v4.0" href="../index.html"/> <link rel="up" title="Contributing to Cassandra" href="index.html"/> <link rel="next" title="Building and IDE Integration" href="ide.html"/> <link rel="prev" title="Contributing to Cassandra" href="index.html"/> +</head> + + <body> + <!-- breadcrumbs --> +<div class="topnav"> + <div class="container breadcrumb-container"> + <ul class="breadcrumb"> + <li> + <div class="dropdown"> + <img class="asf-logo" src="./../../../img/asf_feather.png" /> + <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"> + <li><a href="http://www.apache.org";>Apache Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + </li> + + + <li><a href="./../../../">Apache Cassandra</a></li> + + + + + <li><a href="./../../../doc">Documentation</a></li> + + + + + <li><a href="./">Contributing to Cassandra</a></li> + + + + <li>Getting Started</li> + + </ul> + </div> + + <!-- navbar --> + <nav class="navbar navbar-default navbar-static-top" role="navigation"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#cassandra-menu" aria-expanded="false"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="./../../../"><img src="./../../../img/cassandra_logo.png" alt="Apache Cassandra logo" /></a> + </div><!-- /.navbar-header --> + + <div id="cassandra-menu" class="collapse navbar-collapse"> + <ul class="nav navbar-nav navbar-right"> + <li><a href="./../../../">Home</a></li> + <li><a href="./../../../download/">Download</a></li> + <li><a href="./../../../doc/">Documentation</a></li> + <li><a href="./../../../community/">Community</a></li> + </ul> + </div><!-- /#cassandra-menu --> + + + </div> + </nav><!-- /.navbar --> +</div><!-- /.topnav --> + + <div class="container-fluid"> + <div class="row"> + <div class="col-md-2"> + <div class="doc-navigation"> + <div class="doc-menu" role="navigation"> + <div class="navbar-header"> + <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse sidebar-navbar-collapse"> + <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> + <div class="form-group"> + <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </div> + </form> + + + + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> +<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> +<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> +<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Cassandra</a><ul class="current"> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Getting Started</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#initial-contributions">Initial Contributions</a></li> +<li class="toctree-l3"><a class="reference internal" href="#updating-documentation">Updating documentation</a></li> +<li class="toctree-l3"><a class="reference internal" href="#answering-questions-on-the-user-list">Answering questions on the user list</a></li> +<li class="toctree-l3"><a class="reference internal" href="#reviewing-and-testing-a-submitted-patch">Reviewing and testing a submitted patch</a></li> +<li class="toctree-l3"><a class="reference internal" href="#investigate-and-or-fix-a-reported-bug">Investigate and/or fix a reported bug</a></li> +<li class="toctree-l3"><a class="reference internal" href="#create-unit-tests-and-dtests">Create unit tests and Dtests</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> +<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> +<li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> +<li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> +<li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> +<li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs and Contributing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> +</ul> + + + + </div><!--/.nav-collapse --> + </div> + </div> + </div> + <div class="col-md-8"> + <div class="content doc-content"> + <div class="container"> + + <div class="section" id="getting-started"> +<span id="gettingstarted"></span><h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1> +<div class="section" id="initial-contributions"> +<h2>Initial Contributions<a class="headerlink" href="#initial-contributions" title="Permalink to this headline">¶</a></h2> +<dl class="docutils"> +<dt>Writing a new feature is just one way to contribute to the Cassandra project. In fact, making sure that supporting tasks, such as QA, documentation and helping users, keep up with the development of new features is an ongoing challenge for the project (and most open source projects). So, before firing up your IDE to create that new feature, we’d suggest you consider some of the following activities as a way of introducing yourself to the project and getting to know how things work.</dt> +<dd><ul class="first last simple"> +<li>Add to or update the documentation</li> +<li>Answer questions on the user list</li> +<li>Review and test a submitted patch</li> +<li>Investigate and fix a reported bug</li> +<li>Create unit tests and d-tests</li> +</ul> +</dd> +</dl> +</div> +<div class="section" id="updating-documentation"> +<h2>Updating documentation<a class="headerlink" href="#updating-documentation" title="Permalink to this headline">¶</a></h2> +<p>The Cassandra documentation is maintained in the Cassandra source repository along with the Cassandra code base. To submit changes to the documentation, follow the standard process for submitting a patch (<a class="reference internal" href="patches.html#patches"><span class="std std-ref">Contributing Code Changes</span></a>).</p> +</div> +<div class="section" id="answering-questions-on-the-user-list"> +<h2>Answering questions on the user list<a class="headerlink" href="#answering-questions-on-the-user-list" title="Permalink to this headline">¶</a></h2> +<p>Subscribe to the user list, look out for some questions you know the answer to and reply with an answer. Simple as that! +See the <a class="reference external" href="http://cassandra.apache.org/community/";>community</a> page for details on how to subscribe to the mailing list.</p> +</div> +<div class="section" id="reviewing-and-testing-a-submitted-patch"> +<h2>Reviewing and testing a submitted patch<a class="headerlink" href="#reviewing-and-testing-a-submitted-patch" title="Permalink to this headline">¶</a></h2> +<p>Reviewing patches is not the sole domain of committers, if others have reviewed a patch it can reduce the load on the committers allowing them to write more great features or review more patches. Follow the instructions in <span class="xref std std-ref">_development_how_to_review</span> or create a build with the patch and test it with your own workload. Add a comment to the JIRA ticket to let others know what you have done and the results of your work. (For example, “I tested this performance enhacement on our application’s standard production load test and found a 3% improvement.”)</p> +</div> +<div class="section" id="investigate-and-or-fix-a-reported-bug"> +<h2>Investigate and/or fix a reported bug<a class="headerlink" href="#investigate-and-or-fix-a-reported-bug" title="Permalink to this headline">¶</a></h2> +<p>Often, the hardest work in fixing a bug is reproducing it. Even if you don’t have the knowledge to produce a fix, figuring out a way to reliable reproduce an issues can be a massive contribution to getting a bug fixed. Document your method of reproduction in a JIRA comment or, better yet, produce an automated test that reproduces the issue and attach it to the ticket. If you go as far as producing a fix, follow the process for submitting a patch (<a class="reference internal" href="patches.html#patches"><span class="std std-ref">Contributing Code Changes</span></a>).</p> +</div> +<div class="section" id="create-unit-tests-and-dtests"> +<h2>Create unit tests and Dtests<a class="headerlink" href="#create-unit-tests-and-dtests" title="Permalink to this headline">¶</a></h2> +<p>Test coverage in Cassandra is improving but, as with most code bases, it could benefit from more automated test coverage. Before starting work in an area, consider reviewing and enhancing the existing test coverage. This will both improve your knowledge of the code before you start on an enhancement and reduce the chances of your change in introducing new issues. See <a class="reference internal" href="testing.html#testing"><span class="std std-ref">Testing</span></a> and <a class="reference internal" href="patches.html#patches"><span class="std std-ref">Contributing Code Changes</span></a> for more detail.</p> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="ide.html" class="btn btn-default pull-right " role="button" title="Building and IDE Integration" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="index.html" class="btn btn-default" role="button" title="Contributing to Cassandra" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + + </div> + + </div> + </div> + </div> + <div class="col-md-2"> + </div> + </div> +</div> + + <footer> + <div class="container"> + <div class="col-md-4 social-blk"> + <span class="social"> + <a href="https://twitter.com/cassandra"; + class="twitter-follow-button" + data-show-count="false" data-size="large">Follow @cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + <a href="https://twitter.com/intent/tweet?button_hashtag=cassandra"; + class="twitter-hashtag-button" + data-size="large" + data-related="ApacheCassandra">Tweet #cassandra</a> + <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> + </span> + </div> + + <div class="col-md-8 trademark"> + <p>© 2016 <a href="http://apache.org";>The Apache Software Foundation</a>. + Apache, the Apache feather logo, and Apache Cassandra are trademarks of The Apache Software Foundation. + <p> + </div> + </div><!-- /.container --> +</footer> + +<!-- Javascript. Placed here so pages load faster --> +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> +<script src="./../../../js/underscore-min.js"></script> +<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"; integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script> + + +<script src="./../../../js/doctools.js"></script> +<script src="./../../../js/searchtools.js"></script> + + <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: "", VERSION: "", COLLAPSE_INDEX: false, FILE_SUFFIX: ".html", HAS_SOURCE: false, SOURCELINK_SUFFIX: "" }; </script> + +<script type="text/javascript"> +$(function() { + // Stick the #nav to the top of the window + var nav = $('.doc-navigation'); + var navHomeY = nav.offset().top; + var isFixed = false; + var $w = $(window); + $w.scroll(function() { + var scrollTop = $w.scrollTop(); + var shouldBeFixed = $w.width() > 991 && scrollTop >= navHomeY - 10; + if (shouldBeFixed && !isFixed) { + nav.css({ + position: 'fixed', + top: 0, + left: nav.offset().left, + width: nav.width(), + }); + nav.addClass('fixed-navigation'); + isFixed = true; + } + else if (!shouldBeFixed && isFixed) + { + nav.css({ + position: 'static' + }); + nav.removeClass('fixed-navigation'); + isFixed = false; + } + }); +}); +</script> + + +<script type="text/javascript"> + var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; : "http://www.";); + document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); + + try { + var pageTracker = _gat._getTracker("UA-11583863-1"); + pageTracker._trackPageview(); + } catch(err) {} +</script> + + + </body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
