cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From eev...@apache.org
Subject svn commit: r1068055 - in /cassandra/trunk/doc/cql: CQL.html CQL.textile
Date Mon, 07 Feb 2011 19:06:17 GMT
Author: eevans
Date: Mon Feb  7 19:06:17 2011
New Revision: 1068055

URL: http://svn.apache.org/viewvc?rev=1068055&view=rev
Log:
missed doc update for utf8 term type

Patch by eevans for CASSANDRA-2027

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=1068055&r1=1068054&r2=1068055&view=diff
==============================================================================
--- cassandra/trunk/doc/cql/CQL.html (original)
+++ cassandra/trunk/doc/cql/CQL.html Mon Feb  7 19:06:17 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="#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="#StringLiterals">String Literals</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
&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="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="#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
&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 ...
@@ -29,4 +29,4 @@ UPDATE ... WHERE KEY IN (keyname1, keyna
 </code></pre><p>Accepts a single argument for the column family name, and
permanently removes all data from said column family.</p><h2 id="CREATEKEYSPACE">CREATE
KEYSPACE</h2><p><em>Synopsis:</em></p><pre><code>CREATE
KEYSPACE &lt;NAME&gt; WITH replication_factor = &lt;NUM&gt; AND strategy_class
= "&lt;STRATEGY&gt;"
     [AND strategy_options.&lt;OPTION&gt; = &lt;VALUE&gt; [AND strategy_options.&lt;OPTION&gt;
= &lt;VALUE&gt;]];
 </code></pre><p>The <code>CREATE KEYSPACE</code> statement
creates a new top-level namespace (aka &#8220;keyspace&#8221;). 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:</p><table><tr><th>keyword</th><th>required</th><th>description</th></tr><tr><td>replication_factor</td><td>yes</td><td>Numeric
argument that specifies the number of replicas for this keyspace.</td></tr><tr><td>strategy_class</td><td>yes</td><td>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.</td></tr><tr><td>strategy_options</td><td>no</td><td>Some
strategies require additional arguments which can be supplied by appending the option na
 me to the <code>strategy_options</code> keyword, separated by a colon (<code>:</code>).
 For example, a strategy option of &#8220;DC1&#8221; with a value of &#8220;1&#8221;
would be specified as <code>strategy_options:DC1 = "1"</code>.</td></tr></table><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>Where possible, the type of terms are
inferred; the following term types are supported:</p><h4 id="StringLiterals">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="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 &#8220;L&#8221;, (e.g. 100L).  It is an error to s
 pecify 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(&lt;UUID
STRING&gt;)</code> and <code>uuid(&lt;UUID STRING&gt;)</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(&#8220;now&#8221;)</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(&#8220;2011-02-01T14:00-0600&#8221;)</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(&#8220;e9229b24-2fbe-11e0-a4de-0026c650d722&#8221;)</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>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 &#8220;L&#8221;,
(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(&lt;UUID
STRING&gt;)</code> and <code>uuid(&lt;UUID STRING&gt;)</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(&#8220;now&#8221;)</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(&#8220;2011-02-01T14:00-0600&#8221;)</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(&#8220;e9229b24-2fbe-11e0-a4de-0026c650d722&#8221;)</td><td>Reproduces
the specified version 1 UUID node-side.</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=1068055&r1=1068054&r2=1068055&view=diff
==============================================================================
--- cassandra/trunk/doc/cql/CQL.textile (original)
+++ cassandra/trunk/doc/cql/CQL.textile Mon Feb  7 19:06:17 2011
@@ -195,10 +195,14 @@ h3(#terms). Term specification
 
 Where possible, the type of terms are inferred; the following term types are supported:
 
-h4. String Literals
+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.



Mime
View raw message