cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From eev...@apache.org
Subject svn commit: r1084437 - in /cassandra/trunk/doc/cql: CQL.html CQL.textile
Date Wed, 23 Mar 2011 01:09:47 GMT
Author: eevans
Date: Wed Mar 23 01:09:46 2011
New Revision: 1084437

URL: http://svn.apache.org/viewvc?rev=1084437&view=rev
Log:
bump CQL doc version to 1.0

Patch by eevans

Modified:
    cassandra/trunk/doc/cql/CQL.html
    cassandra/trunk/doc/cql/CQL.textile

Modified: cassandra/trunk/doc/cql/CQL.html
URL: http://svn.apache.org/viewvc/cassandra/trunk/doc/cql/CQL.html?rev=1084437&r1=1084436&r2=1084437&view=diff
==============================================================================
--- cassandra/trunk/doc/cql/CQL.html (original)
+++ cassandra/trunk/doc/cql/CQL.html Wed Mar 23 01:09:46 2011
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML
1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html
xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html;
charset=utf-8"/></head><body><h1 id="CassandraQueryLanguageCQLv0.99.1">Cassandra
Query Language (CQL) v0.99.1</h1><h2 id="TableofContents">Table of Contents</h2><ol
style="list-style: none;"><li><a href="#CassandraQueryLanguageCQLv0.99.1">Cassandra
Query Language (CQL) v0.99.1</a><ol style="list-style: none;"><li><a
href="#TableofContents">Table of Contents</a></li><li><a href="#USE">USE</a></li><li><a
href="#SELECT">SELECT</a><ol style="list-style: none;"><li><a href="#SpecifyingColumns">Specifying
Columns</a></li><li><a href="#ColumnFamily">Column Family</a></li><li><a
href="#ConsistencyLevel">Consistency Level</a></li><li><a href="#Filteringrows">Filtering
rows</a></li><li><a href="#Limits">Limits</a></li></ol></li>
 <li><a href="#UPDATE">UPDATE</a><ol style="list-style: none;"><li><a
href="#ColumnFamily2">Column Family</a></li><li><a href="#ConsistencyLevel2">Consistency
Level</a></li><li><a href="#SpecifyingColumnsandRow">Specifying Columns
and Row</a></li></ol></li><li><a href="#DELETE">DELETE</a><ol
style="list-style: none;"><li><a href="#SpecifyingColumns2">Specifying Columns</a></li><li><a
href="#ColumnFamily3">Column Family</a></li><li><a href="#ConsistencyLevel3">Consistency
Level</a></li><li><a href="#deleterows">Specifying Rows</a></li></ol></li><li><a
href="#TRUNCATE">TRUNCATE</a></li><li><a href="#CREATEKEYSPACE">CREATE
KEYSPACE</a></li><li><a href="#CREATECOLUMNFAMILY">CREATE COLUMNFAMILY</a><ol
style="list-style: none;"><li><a href="#columntypes">Specifying Column Type
(optional)</a></li><li><a href="#ColumnFamilyOptionsoptional">Column
Family Options (optional)</a></li></ol></li><li><a href="#CREATEINDEX">CREATE
INDEX</a></li><li><a href="#DROP">DROP</a></li><li><a
href="#
 CommonIdioms">Common Idioms</a><ol style="list-style: none;"><li><a
href="#consistency">Specifying Consistency</a></li><li><a href="#terms">Term
specification</a></li></ol></li></ol></li></ol><h2
id="USE">USE</h2><p><i>Synopsis:</i></p><pre><code>USE
&lt;KEYSPACE&gt;;
+<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML
1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html
xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html;
charset=utf-8"/></head><body><h1 id="CassandraQueryLanguageCQLv1.0.0">Cassandra
Query Language (CQL) v1.0.0</h1><h2 id="TableofContents">Table of Contents</h2><ol
style="list-style: none;"><li><a href="#CassandraQueryLanguageCQLv1.0.0">Cassandra
Query Language (CQL) v1.0.0</a><ol style="list-style: none;"><li><a href="#TableofContents">Table
of Contents</a></li><li><a href="#USE">USE</a></li><li><a
href="#SELECT">SELECT</a><ol style="list-style: none;"><li><a href="#SpecifyingColumns">Specifying
Columns</a></li><li><a href="#ColumnFamily">Column Family</a></li><li><a
href="#ConsistencyLevel">Consistency Level</a></li><li><a href="#Filteringrows">Filtering
rows</a></li><li><a href="#Limits">Limits</a></li></ol></li><li>
 <a href="#UPDATE">UPDATE</a><ol style="list-style: none;"><li><a
href="#ColumnFamily2">Column Family</a></li><li><a href="#ConsistencyLevel2">Consistency
Level</a></li><li><a href="#SpecifyingColumnsandRow">Specifying Columns
and Row</a></li></ol></li><li><a href="#DELETE">DELETE</a><ol
style="list-style: none;"><li><a href="#SpecifyingColumns2">Specifying Columns</a></li><li><a
href="#ColumnFamily3">Column Family</a></li><li><a href="#ConsistencyLevel3">Consistency
Level</a></li><li><a href="#deleterows">Specifying Rows</a></li></ol></li><li><a
href="#TRUNCATE">TRUNCATE</a></li><li><a href="#CREATEKEYSPACE">CREATE
KEYSPACE</a></li><li><a href="#CREATECOLUMNFAMILY">CREATE COLUMNFAMILY</a><ol
style="list-style: none;"><li><a href="#columntypes">Specifying Column Type
(optional)</a></li><li><a href="#ColumnFamilyOptionsoptional">Column
Family Options (optional)</a></li></ol></li><li><a href="#CREATEINDEX">CREATE
INDEX</a></li><li><a href="#DROP">DROP</a></li><li><a
href="#Comm
 onIdioms">Common Idioms</a><ol style="list-style: none;"><li><a href="#consistency">Specifying
Consistency</a></li><li><a href="#terms">Term specification</a></li></ol></li></ol></li><li><a
href="#Versioning">Versioning</a></li><li><a href="#Changes">Changes</a></li></ol><h2
id="USE">USE</h2><p><i>Synopsis:</i></p><pre><code>USE
&lt;KEYSPACE&gt;;
 </code></pre><p>A <code>USE</code> statement consists of the
<code>USE</code> keyword, followed by a valid keyspace name.  Its purpose is to
assign the per-connection, current working keyspace.  All subsequent keyspace-specific actions
will be performed in the context of the supplied value.</p><h2 id="SELECT">SELECT</h2><p><i>Synopsis:</i></p><pre><code>SELECT
[FIRST N] [REVERSED] &lt;SELECT EXPR&gt; FROM &lt;COLUMN FAMILY&gt; [USING
&lt;CONSISTENCY&gt;]
         [WHERE &lt;CLAUSE&gt;] [LIMIT N];
 </code></pre><p>A <code>SELECT</code> is used to read one or
more records from a Cassandra column family. It returns a result-set of rows, where each row
consists of a key and a collection of columns corresponding to the query.</p><h3
id="SpecifyingColumns">Specifying Columns</h3><pre><code>SELECT [FIRST
N] [REVERSED] name1, name2, name3 FROM ...
@@ -35,4 +35,6 @@ UPDATE ... WHERE KEY IN (keyname1, keyna
 </code></pre><p>A number of optional keyword arguments can be supplied
to control the configuration of a new column family.</p><table><tr><th>keyword</th><th>default</th><th>description</th></tr><tr><td>comparator</td><td>utf8</td><td>Determines
sorting and validation of column names. Valid values are identical to the types listed in
<a href="#columntypes">Specifying Column Type</a> above.</td></tr><tr><td>comment</td><td>none</td><td>A
free-form, human-readable comment.</td></tr><tr><td>row_cache_size</td><td>0</td><td>Number
of rows whose entire contents to cache in memory.</td></tr><tr><td>key_cache_size</td><td>200000</td><td>Number
of keys per SSTable whose locations are kept in memory in &#8220;mostly LRU&#8221;
order.</td></tr><tr><td>read_repair_chance</td><td>1.0</td><td>The
probability with which read repairs should be invoked on non-quorum reads.</td></tr><tr><td>gc_grace_seconds</td><td>864000</td><td>Time
to wait before garbage collecting tombstones (deletion ma
 rkers).</td></tr><tr><td>default_validation</td><td>utf8</td><td>Determines
validation of column values. Valid values are identical to the types listed in <a href="#columntypes">Specifying
Column Type</a> above.</td></tr><tr><td>min_compaction_threshold</td><td>4</td><td>Minimum
number of SSTables needed to start a minor compaction.</td></tr><tr><td>max_compaction_threshold</td><td>32</td><td>Maximum
number of SSTables allowed before a minor compaction is forced.</td></tr><tr><td>row_cache_save_period_in_seconds</td><td>0</td><td>Number
of seconds between saving row caches.</td></tr><tr><td>key_cache_save_period_in_seconds</td><td>14400</td><td>Number
of seconds between saving key caches.</td></tr><tr><td>memtable_flush_after_mins</td><td>60</td><td>Maximum
time to leave a dirty table unflushed.</td></tr><tr><td>memtable_throughput_in_mb</td><td>dynamic</td><td>Maximum
size of the memtable before it is flushed.</td></tr><tr><td>memtable_operations_in_millions</td><td>dynamic
 </td><td>Number of operations in millions before the memtable is flushed.</td></tr><tr><td>replicate_on_write</td><td>false</td><td></td></tr></table><h2
id="CREATEINDEX">CREATE INDEX</h2><p><em>Synopsis:</em></p><pre><code>CREATE
INDEX [index_name] ON &lt;column_family&gt; (column_name);
 </code></pre><p>A <code>CREATE INDEX</code> statement is used
to create a new, automatic secondary index for the named column.</p><h2 id="DROP">DROP</h2><p><em>Synopsis:</em></p><pre><code>DROP
&lt;KEYSPACE|COLUMNFAMILY&gt; namespace;
 </code></pre><p><code>DROP</code> statements result in the
immediate, irreversible removal of keyspace and column family namespaces.</p><h2
id="CommonIdioms">Common Idioms</h2><h3 id="consistency">Specifying Consistency</h3><pre><code>...
USING &lt;CONSISTENCY&gt; ...
-</code></pre><p>Consistency level specifications are made up the keyword
<code>USING</code>, followed by a consistency level identifier. Valid consistency
levels are as follows:</p><ul><li><code>CONSISTENCY ZERO</code></li><li><code>CONSISTENCY
ONE</code> (default)</li><li><code>CONSISTENCY QUORUM</code></li><li><code>CONSISTENCY
ALL</code></li><li><code>CONSISTENCY DCQUORUM</code></li><li><code>CONSISTENCY
DCQUORUMSYNC</code></li></ul><h3 id="terms">Term specification</h3><p>Terms
are used in statements to specify things such as keyspaces, column families, indexes, column
names and values, and keyword arguments.  The rules governing term specification are as follows:</p><ul><li>Any
single quoted string literal (example: <code>'apple'</code>).</li><li>Unquoted
alpha-numeric strings that begin with a letter (example: <code>carrot</code>).</li><li>Unquoted
numeric literals (example: <code>100</code>).</li><li>UUID strings
in hyphen-delimited hex notation (example: <code>1438fc
 5c-4ff6-11e0-b97f-0026c650d722</code>). </li></ul><p>Terms which
do not conform to these rules result in an exception.</p><p>How column name/value
terms are interpreted is determined by the configured type.</p><table><tr><th>type</th><th>term</th></tr><tr><td>ascii</td><td>Any
string which can be decoded using ASCII charset</td></tr><tr><td>utf8</td><td>Any
string which can be decoded using UTF8 charset</td></tr><tr><td>uuid</td><td>Standard
UUID string format (hyphen-delimited hex notation)</td></tr><tr><td>timeuuid</td><td>Standard
UUID string format (hyphen-delimited hex notation)</td></tr><tr><td>timeuuid</td><td>The
string <code>now</code>, to represent a type-1 (time-based) UUID with a date-time
component based on the current time</td></tr><tr><td>timeuuid</td><td>Numeric
value representing milliseconds since epoch</td></tr><tr><td>timeuuid</td><td>An
<a href="http://en.wikipedia.org/wiki/8601">iso8601 timestamp</a></td></tr><tr><td>long</td><td>Numeric
value capable o
 f fitting in 8 bytes</td></tr><tr><td>int</td><td>Numeric
value of arbitrary size</td></tr><tr><td>bytes</td><td>Hex-encoded
strings (converted directly to the corresponding bytes)</td></tr></table></body></html>
\ No newline at end of file
+</code></pre><p>Consistency level specifications are made up the keyword
<code>USING</code>, followed by a consistency level identifier. Valid consistency
levels are as follows:</p><ul><li><code>CONSISTENCY ZERO</code></li><li><code>CONSISTENCY
ONE</code> (default)</li><li><code>CONSISTENCY QUORUM</code></li><li><code>CONSISTENCY
ALL</code></li><li><code>CONSISTENCY DCQUORUM</code></li><li><code>CONSISTENCY
DCQUORUMSYNC</code></li></ul><h3 id="terms">Term specification</h3><p>Terms
are used in statements to specify things such as keyspaces, column families, indexes, column
names and values, and keyword arguments.  The rules governing term specification are as follows:</p><ul><li>Any
single quoted string literal (example: <code>'apple'</code>).</li><li>Unquoted
alpha-numeric strings that begin with a letter (example: <code>carrot</code>).</li><li>Unquoted
numeric literals (example: <code>100</code>).</li><li>UUID strings
in hyphen-delimited hex notation (example: <code>1438fc
 5c-4ff6-11e0-b97f-0026c650d722</code>). </li></ul><p>Terms which
do not conform to these rules result in an exception.</p><p>How column name/value
terms are interpreted is determined by the configured type.</p><table><tr><th>type</th><th>term</th></tr><tr><td>ascii</td><td>Any
string which can be decoded using ASCII charset</td></tr><tr><td>utf8</td><td>Any
string which can be decoded using UTF8 charset</td></tr><tr><td>uuid</td><td>Standard
UUID string format (hyphen-delimited hex notation)</td></tr><tr><td>timeuuid</td><td>Standard
UUID string format (hyphen-delimited hex notation)</td></tr><tr><td>timeuuid</td><td>The
string <code>now</code>, to represent a type-1 (time-based) UUID with a date-time
component based on the current time</td></tr><tr><td>timeuuid</td><td>Numeric
value representing milliseconds since epoch</td></tr><tr><td>timeuuid</td><td>An
<a href="http://en.wikipedia.org/wiki/8601">iso8601 timestamp</a></td></tr><tr><td>long</td><td>Numeric
value capable o
 f fitting in 8 bytes</td></tr><tr><td>int</td><td>Numeric
value of arbitrary size</td></tr><tr><td>bytes</td><td>Hex-encoded
strings (converted directly to the corresponding bytes)</td></tr></table><h1
id="Versioning">Versioning</h1><p>Versioning of the CQL language adheres to
the <a href="http://semver.org">Semantic Versioning</a> guidelines.  Versions
take the form X.Y.Z where X, Y, and Z are integer values representing major, minor, and patch
level respectively.  There is no correlation between Cassandra release versions and the CQL
language version.</p><table><tr><th>version</th><th>description</th></tr><tr><td>Patch</td><td>The
patch version is incremented when bugs are fixed.</td></tr><tr><td>Minor</td><td>Minor
version increments occur when new, but backward compatible, functionality is introduced.</td></tr><tr><td>Major</td><td>The
major version <em>must</em> be bumped when backward incompatible changes are introduced.
 This should rarely (if ever) occur.</td></tr></
 table><h1 id="Changes">Changes</h1><pre>Tue, 22 Mar 2011 18:10:28 -0700
- Eric Evans &lt;eevans@rackspace.com&gt;
+ * Initial version, 1.0.0
+</pre></body></html>
\ No newline at end of file

Modified: cassandra/trunk/doc/cql/CQL.textile
URL: http://svn.apache.org/viewvc/cassandra/trunk/doc/cql/CQL.textile?rev=1084437&r1=1084436&r2=1084437&view=diff
==============================================================================
--- cassandra/trunk/doc/cql/CQL.textile (original)
+++ cassandra/trunk/doc/cql/CQL.textile Wed Mar 23 01:09:46 2011
@@ -1,4 +1,4 @@
-h1. Cassandra Query Language (CQL) v0.99.1
+h1. Cassandra Query Language (CQL) v1.0.0
 
 h2. Table of Contents
 
@@ -283,3 +283,18 @@ How column name/value terms are interpre
 |long|Numeric value capable of fitting in 8 bytes|
 |int|Numeric value of arbitrary size|
 |bytes|Hex-encoded strings (converted directly to the corresponding bytes)|
+
+h1. Versioning
+
+Versioning of the CQL language adheres to the "Semantic Versioning":http://semver.org guidelines.
 Versions take the form X.Y.Z where X, Y, and Z are integer values representing major, minor,
and patch level respectively.  There is no correlation between Cassandra release versions
and the CQL language version.
+
+|_. version|_. description|
+|Patch|The patch version is incremented when bugs are fixed.|
+|Minor|Minor version increments occur when new, but backward compatible, functionality is
introduced.|
+|Major|The major version _must_ be bumped when backward incompatible changes are introduced.
 This should rarely (if ever) occur.|
+
+h1. Changes
+
+pre. 
+Tue, 22 Mar 2011 18:10:28 -0700 - Eric Evans <eevans@rackspace.com>
+ * Initial version, 1.0.0



Mime
View raw message