Author: eevans
Date: Wed Mar 16 18:18:41 2011
New Revision: 1082243
URL: http://svn.apache.org/viewvc?rev=1082243&view=rev
Log:
update CQL doco for recent changes
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=1082243&r1=1082242&r2=1082243&view=diff
==============================================================================
--- cassandra/trunk/doc/cql/CQL.html (original)
+++ cassandra/trunk/doc/cql/CQL.html Wed Mar 16 18:18:41 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><ol style="list-style: none;"><li><a
href="#string_literals">String Literals</a></li><li><a
href="#Unicode">Unicode</a></li><li><a href="#Integerslongs">Integers /
longs</a></li><li><a
href="#UUIDs">UUIDs</a></li></ol></li></ol></li></ol></li></ol><h2
id="USE">USE</h2><p><i>Synopsis:</i></p><pre><code>USE <KEYSPACE>;
+<?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 <KEYSPACE>;
</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] <SELECT EXPR> FROM <COLUMN FAMILY> [USING
<CONSISTENCY>]
[WHERE <CLAUSE>] [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,4 @@ 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>bytes</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 “mostly LRU”
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 m
arkers).</td></tr><tr><td>default_validation</td><td>bytes</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>dynam
ic</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 <column_family> (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
<KEYSPACE|COLUMNFAMILY> 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 <CONSISTENCY> ...
-</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>Where
possible, the type of terms are inferred; the following term types are
supported:</p><h4 id="string_literals">String Literals</h4><p>String literals
are any value enclosed in double-quotes, (`"`). String literals are treated as
raw bytes; no interpolation is performed.</p><h4
id="Unicode">Unicode</h4><p>Unicode terms are any double-quoted string prefixed
with a lower-case <code>u</code>, for example <code>u"© 2011 The Apache
Software Foundation"</code>. Unicode terms are identical to standard
<a href="#string_literals">string literals</a>, with the exception that they
are encoded to bytes using the UTF-8 charset.</p><h4
id="Integerslongs">Integers / longs</h4><p>Integers are any term consisting
soley of unquoted numericals, longs are any otherwise valid integer term
followed by an upper case “L”, (e.g. 100L). It is an error to
specify an integer term that will not fit in 4 bytes unsigned, or a long that
will not fit in 8 bytes unsigned.</p><h4 id="UUIDs">UUIDs</h4><p>There are two
types of UUIDs supported by the CQL specification, time-based (version 1) and
randomly generated (version 4). These are specified in statements using the
<code>timeuuid(<UUID STRING>)</code> and <code>uuid(<UUID
STRING>)</code> notations respectively.</p><p>In addition to the hex-based
string representation, <code>timeuuid()</code> terms also accept arguments to
specify the data-time component. The full list of <code>timeuuid()</code>
arguments are:</p><table><
tr><th>argument</th><th>example</th><th>behavior</th></tr><tr><td>none</td><td>timeuuid()</td><td>Results
in the creation of a new UUID based on system time of the node parsing the
query.</td></tr><tr><td>now</td><td>timeuuid(“now”)</td><td>Results
in the creation of a new UUID based on system time of the node parsing the
query.</td></tr><tr><td>milliseconds since
epoch</td><td>timeuuid(1296755320376)</td><td>Creates a UUID with a time
component that is based on the supplied time-stamp.</td></tr><tr><td><a
href="http://en.wikipedia.org/wiki/8601";>iso8601
timestamp</a></td><td>timeuuid(“2011-02-01T14:00-0600”)</td><td>Creates
a UUID with a time component that is based on the supplied
time-stamp.</td></tr><tr><td><a
href="http://tools.ietf.org/html/rfc4122";>string representation
(hex)</a></td><td>timeuuid(“e9229b24-2fbe-11e0-a4de-0026c650d722”)</td><td>Reproduces
the specified version 1 UUID node-side.</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></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=1082243&r1=1082242&r2=1082243&view=diff
==============================================================================
--- cassandra/trunk/doc/cql/CQL.textile (original)
+++ cassandra/trunk/doc/cql/CQL.textile Wed Mar 16 18:18:41 2011
@@ -165,7 +165,7 @@ h2. CREATE KEYSPACE
_Synopsis:_
bc.
-CREATE KEYSPACE <NAME> WITH replication_factor = <NUM> AND strategy_class =
"<STRATEGY>"
+CREATE KEYSPACE <NAME> WITH replication_factor = <NUM> AND strategy_class =
<STRATEGY>
[AND strategy_options.<OPTION> = <VALUE> [AND strategy_options.<OPTION> =
<VALUE>]];
The @CREATE KEYSPACE@ statement creates a new top-level namespace (aka
"keyspace"). Valid names are any string constructed of alphanumeric characters
and underscores, but must begin with a letter. Properties such as replication
strategy and count are specified during creation using the following accepted
keyword arguments:
@@ -173,7 +173,7 @@ The @CREATE KEYSPACE@ statement creates
|_. keyword|_. required|_. description|
|replication_factor|yes|Numeric argument that specifies the number of replicas
for this keyspace.|
|strategy_class|yes|Class name to use for managing replica placement. Any of
the shipped strategies can be used by specifying the class name relative to
org.apache.cassandra.locator, others will need to be fully-qualified and
located on the classpath.|
-|strategy_options|no|Some strategies require additional arguments which can be
supplied by appending the option name to the @strategy_options@ keyword,
separated by a colon (@:@). For example, a strategy option of "DC1" with a
value of "1" would be specified as @strategy_options:DC1 = "1"@.|
+|strategy_options|no|Some strategies require additional arguments which can be
supplied by appending the option name to the @strategy_options@ keyword,
separated by a colon (@:@). For example, a strategy option of "DC1" with a
value of "1" would be specified as @strategy_options:DC1 = 1@.|
h2. CREATE COLUMNFAMILY
@@ -261,31 +261,25 @@ Consistency level specifications are mad
h3(#terms). Term specification
-Where possible, the type of terms are inferred; the following term types are
supported:
-
-h4(#string_literals). String Literals
-
-String literals are any value enclosed in double-quotes, (`"`). String
literals are treated as raw bytes; no interpolation is performed.
-
-h4. Unicode
-
-Unicode terms are any double-quoted string prefixed with a lower-case @u@, for
example @u"© 2011 The Apache Software Foundation"@. Unicode terms are
identical to standard "string literals":#string_literals, with the exception
that they are encoded to bytes using the UTF-8 charset.
-
-h4. Integers / longs
-
-Integers are any term consisting soley of unquoted numericals, longs are any
otherwise valid integer term followed by an upper case "L", (e.g. 100L). It is
an error to specify an integer term that will not fit in 4 bytes unsigned, or a
long that will not fit in 8 bytes unsigned.
-
-h4. UUIDs
-
-There are two types of UUIDs supported by the CQL specification, time-based
(version 1) and randomly generated (version 4). These are specified in
statements using the @timeuuid(<UUID STRING>)@ and @uuid(<UUID STRING>)@
notations respectively.
-
-In addition to the hex-based string representation, @timeuuid()@ terms also
accept arguments to specify the data-time component. The full list of
@timeuuid()@ arguments are:
-
-|_. argument|_. example|_. behavior|
-|none|timeuuid()|Results in the creation of a new UUID based on system time of
the node parsing the query.|
-|now|timeuuid("now")|Results in the creation of a new UUID based on system
time of the node parsing the query.|
-|milliseconds since epoch|timeuuid(1296755320376)|Creates a UUID with a time
component that is based on the supplied time-stamp.|
-|"iso8601
timestamp":http://en.wikipedia.org/wiki/8601|timeuuid("2011-02-01T14:00-0600")|Creates
a UUID with a time component that is based on the supplied time-stamp.|
-|"string representation
(hex)":http://tools.ietf.org/html/rfc4122|timeuuid("e9229b24-2fbe-11e0-a4de-0026c650d722")|Reproduces
the specified version 1 UUID node-side.|
-
+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:
+* Any single quoted string literal (example: @'apple'@).
+* Unquoted alpha-numeric strings that begin with a letter (example: @carrot@).
+* Unquoted numeric literals (example: @100@).
+* UUID strings in hyphen-delimited hex notation (example:
@1438fc5c-4ff6-11e0-b97f-0026c650d722@).
+
+Terms which do not conform to these rules result in an exception.
+
+How column name/value terms are interpreted is determined by the configured
type.
+
+|_. type|_. term|
+|ascii|Any string which can be decoded using ASCII charset|
+|utf8|Any string which can be decoded using UTF8 charset|
+|uuid|Standard UUID string format (hyphen-delimited hex notation)|
+|timeuuid|Standard UUID string format (hyphen-delimited hex notation)|
+|timeuuid|The string @now@, to represent a type-1 (time-based) UUID with a
date-time component based on the current time|
+|timeuuid|Numeric value representing milliseconds since epoch|
+|timeuuid|An "iso8601 timestamp":http://en.wikipedia.org/wiki/8601|
+|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)|
