Modified: cassandra/site/publish/doc/latest/bugs.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/bugs.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/bugs.html (original) +++ cassandra/site/publish/doc/latest/bugs.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="index.html"/> <link rel="next" title="Contact us" href="contactus.html"/> <link rel="prev" title="Frequently Asked Questions" href="faq/index.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="index.html"/> <link rel="next" title="Contact us" href="contactus.html"/> <link rel="prev" title="Frequently Asked Questions" href="faq/index.html"/> </head> <body> @@ -59,7 +59,7 @@ - <li>Reporting bugs and contributing</li> + <li>Reporting Bugs and Contributing</li> </ul> </div> @@ -124,8 +124,9 @@ <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="faq/index.html">Frequently Asked Questions</a></li> -<li class="toctree-l1 current"><a class="current reference internal" href="#">Reporting bugs and contributing</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="contactus.html">Contact us</a></li> </ul> @@ -140,14 +141,14 @@ <div class="container"> <div class="section" id="reporting-bugs-and-contributing"> -<h1>Reporting bugs and contributing<a class="headerlink" href="#reporting-bugs-and-contributing" title="Permalink to this headline">¶</a></h1> +<h1>Reporting Bugs and Contributing<a class="headerlink" href="#reporting-bugs-and-contributing" title="Permalink to this headline">¶</a></h1> <p>If you encounter a problem with Cassandra, the first places to ask for help are the <a class="reference internal" href="contactus.html#mailing-lists"><span class="std std-ref">user mailing list</span></a> and the <code class="docutils literal"><span class="pre">#cassandra</span></code> <a class="reference internal" href="contactus.html#irc-channels"><span class="std std-ref">IRC channel</span></a>.</p> <p>If, after having asked for help, you suspect that you have found a bug in Cassandra, you should report it by opening a ticket through the <a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA";>Apache Cassandra JIRA</a>. Please provide as much details as you can on your problem, and don’t forget to indicate which version of Cassandra you are running and on which environment.</p> -<p>If you would like to contribute, please check <a class="reference external" href="https://wiki.apache.org/cassandra/HowToContribute";>the section on contributing</a> on the Cassandra wiki. Please note that the source of this -documentation is part of the Cassandra git repository and hence contributions to the documentation should follow the +<p>Further details on how to contribute can be found at our <a class="reference internal" href="development/index.html"><span class="doc">Cassandra Development</span></a> section. Please note that the source of +this documentation is part of the Cassandra git repository and hence contributions to the documentation should follow the same path.</p> </div>
Modified: cassandra/site/publish/doc/latest/configuration/cassandra_config_file.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/configuration/cassandra_config_file.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/configuration/cassandra_config_file.html (original) +++ cassandra/site/publish/doc/latest/configuration/cassandra_config_file.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="Configuring Cassandra" href="index.html"/> <link rel="next" title="Operating Cassandra" href="../operating/index.html"/> <link rel="prev" title="Configuring Cassandra" href="index.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="Configuring Cassandra" href="index.html"/> <link rel="next" title="Operating Cassandra" href="../operating/index.html"/> <link rel="prev" title="Configuring Cassandra" href="index.html"/> </head> <body> @@ -240,6 +240,7 @@ <li class="toctree-l3"><a class="reference internal" href="#cas-contention-timeout-in-ms"><code class="docutils literal"><span class="pre">cas_contention_timeout_in_ms</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#truncate-request-timeout-in-ms"><code class="docutils literal"><span class="pre">truncate_request_timeout_in_ms</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#request-timeout-in-ms"><code class="docutils literal"><span class="pre">request_timeout_in_ms</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="#slow-query-log-timeout-in-ms"><code class="docutils literal"><span class="pre">slow_query_log_timeout_in_ms</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#cross-node-timeout"><code class="docutils literal"><span class="pre">cross_node_timeout</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#streaming-socket-timeout-in-ms"><code class="docutils literal"><span class="pre">streaming_socket_timeout_in_ms</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="#phi-convict-threshold"><code class="docutils literal"><span class="pre">phi_convict_threshold</span></code></a></li> @@ -276,8 +277,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> @@ -878,6 +880,9 @@ If omitted, Cassandra will set both to 1 <div class="section" id="memtable-cleanup-threshold"> <h2><code class="docutils literal"><span class="pre">memtable_cleanup_threshold</span></code><a class="headerlink" href="#memtable-cleanup-threshold" title="Permalink to this headline">¶</a></h2> <p><em>This option is commented out by default.</em></p> +<p>memtable_cleanup_threshold is deprecated. The default calculation +is the only reasonable choice. See the comments on memtable_flush_writers +for more information.</p> <p>Ratio of occupied non-flushing memtable size to total permitted size that will trigger a flush of the largest memtable. Larger mct will mean larger flushes and hence less compaction, but also less concurrent @@ -914,13 +919,28 @@ of the commitlog volume.</p> <div class="section" id="memtable-flush-writers"> <h2><code class="docutils literal"><span class="pre">memtable_flush_writers</span></code><a class="headerlink" href="#memtable-flush-writers" title="Permalink to this headline">¶</a></h2> <p><em>This option is commented out by default.</em></p> -<p>This sets the amount of memtable flush writer threads. These will -be blocked by disk io, and each one will hold a memtable in memory -while blocked.</p> -<p>memtable_flush_writers defaults to one per data_file_directory.</p> -<p>If your data directories are backed by SSD, you can increase this, but -avoid having memtable_flush_writers * data_file_directories > number of cores</p> -<p><em>Default Value:</em> 1</p> +<p>This sets the number of memtable flush writer threads per disk +as well as the total number of memtables that can be flushed concurrently. +These are generally a combination of compute and IO bound.</p> +<p>Memtable flushing is more CPU efficient than memtable ingest and a single thread +can keep up with the ingest rate of a whole server on a single fast disk +until it temporarily becomes IO bound under contention typically with compaction. +At that point you need multiple flush threads. At some point in the future +it may become CPU bound all the time.</p> +<p>You can tell if flushing is falling behind using the MemtablePool.BlockedOnAllocation +metric which should be 0, but will be non-zero if threads are blocked waiting on flushing +to free memory.</p> +<p>memtable_flush_writers defaults to two for a single data directory. +This means that two memtables can be flushed concurrently to the single data directory. +If you have multiple data directories the default is one memtable flushing at a time +but the flush will use a thread per data directory so you will get two or more writers.</p> +<p>Two is generally enough to flush on a fast disk [array] mounted as a single data directory. +Adding more flush writers will result in smaller more frequent flushes that introduce more +compaction overhead.</p> +<p>There is a direct tradeoff between number of memtables that can be flushed concurrently +and flush size and frequency. More is not better you just need enough flush writers +to never stall waiting for flushing to free memory.</p> +<p><em>Default Value:</em> 2</p> </div> <div class="section" id="cdc-total-space-in-mb"> <h2><code class="docutils literal"><span class="pre">cdc_total_space_in_mb</span></code><a class="headerlink" href="#cdc-total-space-in-mb" title="Permalink to this headline">¶</a></h2> @@ -1360,6 +1380,13 @@ we need to flush first so we can snapsho <p>The default timeout for other, miscellaneous operations</p> <p><em>Default Value:</em> 10000</p> </div> +<div class="section" id="slow-query-log-timeout-in-ms"> +<h2><code class="docutils literal"><span class="pre">slow_query_log_timeout_in_ms</span></code><a class="headerlink" href="#slow-query-log-timeout-in-ms" title="Permalink to this headline">¶</a></h2> +<p>How long before a node logs slow queries. Select queries that take longer than +this timeout to execute, will generate an aggregated log message, so that slow queries +can be identified. Set this value to zero to disable slow query logging.</p> +<p><em>Default Value:</em> 500</p> +</div> <div class="section" id="cross-node-timeout"> <h2><code class="docutils literal"><span class="pre">cross_node_timeout</span></code><a class="headerlink" href="#cross-node-timeout" title="Permalink to this headline">¶</a></h2> <p>Enable operation timeout information exchange between nodes to accurately Modified: cassandra/site/publish/doc/latest/configuration/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/configuration/index.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/configuration/index.html (original) +++ cassandra/site/publish/doc/latest/configuration/index.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="next" title="Cassandra Configuration File" href="cassandra_config_file.html"/> <link rel="prev" title="Changes" href="../cql/changes.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="next" title="Cassandra Configuration File" href="cassandra_config_file.html"/> <link rel="prev" title="Changes" href="../cql/changes.html"/> </head> <body> @@ -127,8 +127,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/contactus.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/contactus.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/contactus.html (original) +++ cassandra/site/publish/doc/latest/contactus.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="index.html"/> <link rel="prev" title="Reporting bugs and contributing" href="bugs.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="index.html"/> <link rel="prev" title="Reporting Bugs and Contributing" href="bugs.html"/> </head> <body> @@ -124,8 +124,9 @@ <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="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="bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Contact us</a><ul> <li class="toctree-l2"><a class="reference internal" href="#mailing-lists">Mailing lists</a></li> <li class="toctree-l2"><a class="reference internal" href="#irc">IRC</a></li> @@ -179,7 +180,7 @@ following channels are available:</p> <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> - <a href="bugs.html" class="btn btn-default" role="button" title="Reporting bugs and contributing" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> + <a href="bugs.html" class="btn btn-default" role="button" title="Reporting Bugs and Contributing" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> </div> Modified: cassandra/site/publish/doc/latest/cql/appendices.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/appendices.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/appendices.html (original) +++ cassandra/site/publish/doc/latest/cql/appendices.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Changes" href="changes.html"/> <link rel="prev" title="Triggers" href="triggers.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Changes" href="changes.html"/> <link rel="prev" title="Triggers" href="triggers.html"/> </head> <body> @@ -144,8 +144,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/changes.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/changes.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/changes.html (original) +++ cassandra/site/publish/doc/latest/cql/changes.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Configuring Cassandra" href="../configuration/index.html"/> <link rel="prev" title="Appendices" href="appendices.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Configuring Cassandra" href="../configuration/index.html"/> <link rel="prev" title="Appendices" href="appendices.html"/> </head> <body> @@ -163,8 +163,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> @@ -184,8 +185,11 @@ <div class="section" id="id1"> <h2>3.4.3<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2> <ul class="simple"> +<li>Support for <code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code> (<a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA-10707";>CASSANDRA-10707</a>).</li> <li>Adds a <code class="docutils literal"><span class="pre">DEFAULT</span> <span class="pre">UNSET</span></code> option for <code class="docutils literal"><span class="pre">INSERT</span> <span class="pre">JSON</span></code> to ignore omitted columns (<a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA-11424";>CASSANDRA-11424</a>).</li> +<li>Allows <code class="docutils literal"><span class="pre">null</span></code> as a legal value for TTL on insert and update. It will be treated as equivalent to</li> </ul> +<p>inserting a 0 (<a class="reference external" href="https://issues.apache.org/jira/browse/CASSANDRA-12216";>CASSANDRA-12216</a>).</p> </div> <div class="section" id="id2"> <h2>3.4.2<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2> Modified: cassandra/site/publish/doc/latest/cql/ddl.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/ddl.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/ddl.html (original) +++ cassandra/site/publish/doc/latest/cql/ddl.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Data Manipulation" href="dml.html"/> <link rel="prev" title="Data Types" href="types.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Data Manipulation" href="dml.html"/> <link rel="prev" title="Data Types" href="types.html"/> </head> <body> @@ -151,8 +151,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> @@ -505,7 +506,7 @@ options of a table are described in the <p class="last">Since Cassandra 3.0, compact tables have the exact same layout internally than non compact ones (for the same schema obviously), and declaring a table compact <strong>only</strong> creates artificial limitations on the table definition and usage that are necessary to ensure backward compatibility with the deprecated Thrift API. And as <code class="docutils literal"><span class="pre">COMPACT</span> -<span class="pre">STORAGE</span></code> cannot, as of Cassandra 3.7, be removed, it is strongly discouraged to create new table with the +<span class="pre">STORAGE</span></code> cannot, as of Cassandra 3.10, be removed, it is strongly discouraged to create new table with the <code class="docutils literal"><span class="pre">COMPACT</span> <span class="pre">STORAGE</span></code> option.</p> </div> <p>A <em>compact</em> table is one defined with the <code class="docutils literal"><span class="pre">COMPACT</span> <span class="pre">STORAGE</span></code> option. This option is mainly targeted towards backward Modified: cassandra/site/publish/doc/latest/cql/definitions.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/definitions.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/definitions.html (original) +++ cassandra/site/publish/doc/latest/cql/definitions.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Data Types" href="types.html"/> <link rel="prev" title="The Cassandra Query Language (CQL)" href="index.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Data Types" href="types.html"/> <link rel="prev" title="The Cassandra Query Language (CQL)" href="index.html"/> </head> <body> @@ -149,8 +149,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/dml.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/dml.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/dml.html (original) +++ cassandra/site/publish/doc/latest/cql/dml.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Secondary Indexes" href="indexes.html"/> <link rel="prev" title="Data Definition" href="ddl.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Secondary Indexes" href="indexes.html"/> <link rel="prev" title="Data Definition" href="ddl.html"/> </head> <body> @@ -147,8 +147,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> @@ -172,6 +173,7 @@ <strong id="grammar-token-select_statement">select_statement</strong> ::= SELECT [ JSON | DISTINCT ] ( <a class="reference internal" href="#grammar-token-select_clause"><code class="xref docutils literal"><span class="pre">select_clause</span></code></a> | '*' ) FROM <a class="reference internal" href="ddl.html#grammar-token-table_name"><code class="xref docutils literal"><span class="pre">table_name</span></code></a> [ WHERE <a class="reference internal" href="#grammar-token-where_clause"><code class="xref docutils literal"><span class="pre">where_clause</span></code></a> ] + [ GROUP BY <a class="reference internal" href="#grammar-token-group_by_clause"><code class="xref docutils literal"><span class="pre">group_by_clause</span></code></a> ] [ ORDER BY <a class="reference internal" href="#grammar-token-ordering_clause"><code class="xref docutils literal"><span class="pre">ordering_clause</span></code></a> ] [ PER PARTITION LIMIT (<a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref docutils literal"><span class="pre">integer</span></code></a> | <a class="reference internal" href="definitions.html#grammar-token-bind_marker"><code class="xref docutils literal"><span class="pre">bind_marker</span></code></a>) ] [ LIMIT (<a class="reference internal" href="definitions.html#grammar-token-integer"><code class="xref docutils literal"><span class="pre">integer</span></code></a> | <a class="reference internal" href="definitions.html#grammar-token-bind_marker"><code class="xref docutils literal"><span class="pre">bind_marker</span></code></a>) ] @@ -187,6 +189,7 @@ '(' <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> ( ',' <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> )* ')' <a class="reference internal" href="#grammar-token-operator"><code class="xref docutils literal"><span class="pre">operator</span></code></a> <a class="reference internal" href="types.html#grammar-token-tuple_literal"><code class="xref docutils literal"><span class="pre">tuple_literal</span></code></a> TOKEN '(' <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> ( ',' <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> )* ')' <a class="reference internal" href="#grammar-token-operator"><code class="xref docutils literal"><span class="pre">operator</span></code></a> <a class="reference internal" href="definitions.html#grammar-token-term"><code class="xref docutils literal"><span class="pre">term</span></code></a> <strong id="grammar-token-operator">operator </strong> ::= '=' | '<' | '>' | '<=' | '>=' | '!=' | IN | CONTAINS | CONTAINS KEY +<strong id="grammar-token-group_by_clause">group_by_clause </strong> ::= <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> ( ',' <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> )* <strong id="grammar-token-ordering_clause">ordering_clause </strong> ::= <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> [ ASC | DESC ] ( ',' <a class="reference internal" href="ddl.html#grammar-token-column_name"><code class="xref docutils literal"><span class="pre">column_name</span></code></a> [ ASC | DESC ] )* </pre> <p>For instance:</p> @@ -336,6 +339,19 @@ in the clustering order. In particular, <code class="docutils literal"><span class="pre">CONTAINS</span></code> applies to the map values. The <code class="docutils literal"><span class="pre">CONTAINS</span> <span class="pre">KEY</span></code> operator may only be used on map columns and applies to the map keys.</p> </div> +<div class="section" id="grouping-results"> +<span id="group-by-clause"></span><h3>Grouping results<a class="headerlink" href="#grouping-results" title="Permalink to this headline">¶</a></h3> +<p>The <code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code> option allows to condense into a single row all selected rows that share the same values for a set +of columns.</p> +<p>Using the <code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code> option, it is only possible to group rows at the partition key level or at a clustering column +level. By consequence, the <code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code> option only accept as arguments primary key column names in the primary key +order. If a primary key column is restricted by an equality restriction it is not required to be present in the +<code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code> clause.</p> +<p>Aggregate functions will produce a separate value for each group. If no <code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code> clause is specified, +aggregates functions will produce a single value for all the rows.</p> +<p>If a column is selected without an aggregate function, in a statement with a <code class="docutils literal"><span class="pre">GROUP</span> <span class="pre">BY</span></code>, the first value encounter +in each group will be returned.</p> +</div> <div class="section" id="ordering-results"> <span id="ordering-clause"></span><h3>Ordering results<a class="headerlink" href="#ordering-results" title="Permalink to this headline">¶</a></h3> <p>The <code class="docutils literal"><span class="pre">ORDER</span> <span class="pre">BY</span></code> clause allows to select the order of the returned results. It takes as argument a list of column names @@ -496,7 +512,8 @@ microseconds) at the start of statement automatically removed from the database after the specified time. Note that the TTL concerns the inserted values, not the columns themselves. This means that any subsequent update of the column will also reset the TTL (to whatever TTL is specified in that update). By default, values never expire. A TTL of 0 is equivalent to no TTL. If the table has a -default_time_to_live, a TTL of 0 will remove the TTL for the inserted or updated values.</li> +default_time_to_live, a TTL of 0 will remove the TTL for the inserted or updated values. A TTL of <code class="docutils literal"><span class="pre">null</span></code> is equivalent +to inserting with a TTL of 0.</li> </ul> </div> </div> Modified: cassandra/site/publish/doc/latest/cql/functions.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/functions.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/functions.html (original) +++ cassandra/site/publish/doc/latest/cql/functions.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" 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="Security" href="security.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" 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="Security" href="security.html"/> </head> <body> @@ -144,8 +144,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/index.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/index.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/index.html (original) +++ cassandra/site/publish/doc/latest/cql/index.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="next" title="Definitions" href="definitions.html"/> <link rel="prev" title="Data Modeling" href="../data_modeling/index.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="next" title="Definitions" href="definitions.html"/> <link rel="prev" title="Data Modeling" href="../data_modeling/index.html"/> </head> <body> @@ -138,8 +138,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/indexes.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/indexes.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/indexes.html (original) +++ cassandra/site/publish/doc/latest/cql/indexes.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Materialized Views" href="mvs.html"/> <link rel="prev" title="Data Manipulation" href="dml.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Materialized Views" href="mvs.html"/> <link rel="prev" title="Data Manipulation" href="dml.html"/> </head> <body> @@ -144,8 +144,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/json.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/json.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/json.html (original) +++ cassandra/site/publish/doc/latest/cql/json.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Triggers" href="triggers.html"/> <link rel="prev" title="Functions" href="functions.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Triggers" href="triggers.html"/> <link rel="prev" title="Functions" href="functions.html"/> </head> <body> @@ -147,8 +147,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/mvs.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/mvs.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/mvs.html (original) +++ cassandra/site/publish/doc/latest/cql/mvs.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Security" href="security.html"/> <link rel="prev" title="Secondary Indexes" href="indexes.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Security" href="security.html"/> <link rel="prev" title="Secondary Indexes" href="indexes.html"/> </head> <body> @@ -145,8 +145,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/security.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/security.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/security.html (original) +++ cassandra/site/publish/doc/latest/cql/security.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Functions" href="functions.html"/> <link rel="prev" title="Materialized Views" href="mvs.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Functions" href="functions.html"/> <link rel="prev" title="Materialized Views" href="mvs.html"/> </head> <body> @@ -145,8 +145,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/triggers.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/triggers.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/triggers.html (original) +++ cassandra/site/publish/doc/latest/cql/triggers.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Appendices" href="appendices.html"/> <link rel="prev" title="JSON Support" href="json.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Appendices" href="appendices.html"/> <link rel="prev" title="JSON Support" href="json.html"/> </head> <body> @@ -144,8 +144,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Modified: cassandra/site/publish/doc/latest/cql/types.html URL: http://svn.apache.org/viewvc/cassandra/site/publish/doc/latest/cql/types.html?rev=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/cql/types.html (original) +++ cassandra/site/publish/doc/latest/cql/types.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Data Definition" href="ddl.html"/> <link rel="prev" title="Definitions" href="definitions.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="up" title="The Cassandra Query Language (CQL)" href="index.html"/> <link rel="next" title="Data Definition" href="ddl.html"/> <link rel="prev" title="Definitions" href="definitions.html"/> </head> <body> @@ -150,8 +150,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> @@ -587,7 +588,7 @@ it is used, the statement will be a no-o <li>A type is intrinsically bound to the keyspace in which it is created, and can only be used in that keyspace. At creation, if the type name is prefixed by a keyspace name, it is created in that keyspace. Otherwise, it is created in the current keyspace.</li> -<li>As of Cassandra 3.7, UDT have to be frozen in most cases, hence the <code class="docutils literal"><span class="pre">frozen<address></span></code> in the table definition +<li>As of Cassandra 3.10, UDT have to be frozen in most cases, hence the <code class="docutils literal"><span class="pre">frozen<address></span></code> in the table definition above. Please see the section on <span class="xref std std-ref">frozen</span> for more details.</li> </ul> </div> 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=1757435&r1=1757434&r2=1757435&view=diff ============================================================================== --- cassandra/site/publish/doc/latest/data_modeling/index.html (original) +++ cassandra/site/publish/doc/latest/data_modeling/index.html Tue Aug 23 20:58:08 2016 @@ -24,7 +24,7 @@ <link rel="stylesheet" href="./../../../css/sphinx.css"> - <link rel="top" title="Apache Cassandra Documentation v3.7" href="../index.html"/> <link rel="next" title="The Cassandra Query Language (CQL)" href="../cql/index.html"/> <link rel="prev" title="Guarantees" href="../architecture/guarantees.html"/> + <link rel="top" title="Apache Cassandra Documentation v3.10" href="../index.html"/> <link rel="next" title="The Cassandra Query Language (CQL)" href="../cql/index.html"/> <link rel="prev" title="Guarantees" href="../architecture/guarantees.html"/> </head> <body> @@ -124,8 +124,9 @@ <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="../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="../bugs.html">Reporting Bugs and Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> </ul> Added: 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=1757435&view=auto ============================================================================== --- cassandra/site/publish/doc/latest/development/code_style.html (added) +++ cassandra/site/publish/doc/latest/development/code_style.html Tue Aug 23 20:58:08 2016 @@ -0,0 +1,354 @@ +<!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/code_style.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 v3.10" 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"/> +</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="./">Cassandra Development</a></li> + + + + <li>Code Style</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">Cassandra Development</a><ul class="current"> +<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 current"><a class="current reference internal" href="#">Code Style</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#general-code-conventions">General Code Conventions</a></li> +<li class="toctree-l3"><a class="reference internal" href="#exception-handling">Exception handling</a></li> +<li class="toctree-l3"><a class="reference internal" href="#boilerplate">Boilerplate</a></li> +<li class="toctree-l3"><a class="reference internal" href="#multiline-statements">Multiline statements</a></li> +<li class="toctree-l3"><a class="reference internal" href="#whitespace">Whitespace</a></li> +<li class="toctree-l3"><a class="reference internal" href="#imports">Imports</a></li> +<li class="toctree-l3"><a class="reference internal" href="#format-files-for-ides">Format files for IDEs</a></li> +</ul> +</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> +</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="code-style"> +<h1>Code Style<a class="headerlink" href="#code-style" title="Permalink to this headline">¶</a></h1> +<div class="section" id="general-code-conventions"> +<h2>General Code Conventions<a class="headerlink" href="#general-code-conventions" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><ul class="simple"> +<li>The Cassandra project follows <a class="reference external" href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html";>Sun’s Java coding conventions</a> with an important exception: <code class="docutils literal"><span class="pre">{</span></code> and <code class="docutils literal"><span class="pre">}</span></code> are always placed on a new line</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="exception-handling"> +<h2>Exception handling<a class="headerlink" href="#exception-handling" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><ul class="simple"> +<li>Never ever write <code class="docutils literal"><span class="pre">catch</span> <span class="pre">(...)</span> <span class="pre">{}</span></code> or <code class="docutils literal"><span class="pre">catch</span> <span class="pre">(...)</span> <span class="pre">{</span> <span class="pre">logger.error()</span> <span class="pre">}</span></code> merely to satisfy Java’s compile-time exception checking. Always propagate the exception up or throw <code class="docutils literal"><span class="pre">RuntimeException</span></code> (or, if it “can’t happen,” <code class="docutils literal"><span class="pre">AssertionError</span></code>). This makes the exceptions visible to automated tests.</li> +<li>Avoid propagating up checked exceptions that no caller handles. Rethrow as <code class="docutils literal"><span class="pre">RuntimeException</span></code> (or <code class="docutils literal"><span class="pre">IOError</span></code>, if that is more applicable).</li> +<li>Similarly, logger.warn() is often a cop-out: is this an error or not? If it is don’t hide it behind a warn; if it isn’t, no need for the warning.</li> +<li>If you genuinely know an exception indicates an expected condition, it’s okay to ignore it BUT this must be explicitly explained in a comment.</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="boilerplate"> +<h2>Boilerplate<a class="headerlink" href="#boilerplate" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><ul class="simple"> +<li>Avoid redundant <code class="docutils literal"><span class="pre">@Override</span></code> annotations when implementing abstract or interface methods.</li> +<li>Do not implement equals or hashcode methods unless they are actually needed.</li> +<li>Prefer public final fields to private fields with getters. (But prefer encapsulating behavior in “real” methods to either.)</li> +<li>Prefer requiring initialization in the constructor to setters.</li> +<li>Avoid redundant <code class="docutils literal"><span class="pre">this</span></code> references to member fields or methods.</li> +<li>Do not extract interfaces (or abstract classes) unless you actually need multiple implementations of it.</li> +<li>Always include braces for nested levels of conditionals and loops. Only avoid braces for single level.</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="multiline-statements"> +<h2>Multiline statements<a class="headerlink" href="#multiline-statements" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><ul class="simple"> +<li>Try to keep lines under 120 characters, but use good judgement – it’s better to exceed 120 by a little, than split a line that has no natural splitting points.</li> +<li>When splitting inside a method call, use one line per parameter and align them, like this:</li> +</ul> +<div class="highlight-none"><div class="highlight"><pre><span></span>SSTableWriter writer = new SSTableWriter(cfs.getTempSSTablePath(), + columnFamilies.size(), + StorageService.getPartitioner()); +</pre></div> +</div> +<ul class="simple"> +<li>When splitting a ternary, use one line per clause, carry the operator, and align like this:</li> +</ul> +<div class="highlight-none"><div class="highlight"><pre><span></span>var = bar == null + ? doFoo() + : doBar(); +</pre></div> +</div> +</div></blockquote> +</div> +<div class="section" id="whitespace"> +<h2>Whitespace<a class="headerlink" href="#whitespace" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><ul class="simple"> +<li>Please make sure to use 4 spaces instead of the tab character for all your indentation.</li> +<li>Many lines in many files have a bunch of trailing whitespace... Please either clean these up in a separate patch, or leave them alone, so that reviewers now and anyone reading code history later doesn’t have to pay attention to whitespace diffs.</li> +</ul> +</div></blockquote> +</div> +<div class="section" id="imports"> +<h2>Imports<a class="headerlink" href="#imports" title="Permalink to this headline">¶</a></h2> +<p>Please observe the following order for your imports:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>java +[blank line] +com.google.common +org.apache.commons +org.junit +org.slf4j +[blank line] +everything else alphabetically +</pre></div> +</div> +</div> +<div class="section" id="format-files-for-ides"> +<h2>Format files for IDEs<a class="headerlink" href="#format-files-for-ides" title="Permalink to this headline">¶</a></h2> +<blockquote> +<div><ul class="simple"> +<li>IntelliJ: <a class="reference external" href="https://wiki.apache.org/cassandra/CodeStyle?action=AttachFile&do=view&target=intellij-codestyle.jar";>intellij-codestyle.jar</a></li> +<li>IntelliJ 13: <a class="reference external" href="https://gist.github.com/jdsumsion/9ab750a05c2a567c6afc";>gist for IntelliJ 13</a> (this is a work in progress, still working on javadoc, ternary style, line continuations, etc)</li> +<li>Eclipse (<a class="reference external" href="https://github.com/tjake/cassandra-style-eclipse";>https://github.com/tjake/cassandra-style-eclipse</a>)</li> +</ul> +</div></blockquote> +</div> +</div> + + + + + <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> + + <a href="how_to_review.html" class="btn btn-default pull-right " role="button" title="Review Checklist" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> + + + <a href="patches.html" class="btn btn-default" role="button" title="Contributing Code Changes" 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>
