You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by jb...@apache.org on 2014/04/30 19:50:29 UTC
[03/10] git commit: wip
wip
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/50466aa4
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/50466aa4
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/50466aa4
Branch: refs/heads/cassandra-2.1
Commit: 50466aa490fc9d6324329696bcc56da9f7109d77
Parents: a8852ea
Author: Jonathan Ellis <jb...@apache.org>
Authored: Wed Apr 30 12:43:20 2014 -0500
Committer: Jonathan Ellis <jb...@apache.org>
Committed: Wed Apr 30 12:43:20 2014 -0500
----------------------------------------------------------------------
README.asc | 109 +++++++++++++++++++++++++++-----------------------------
1 file changed, 53 insertions(+), 56 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cassandra/blob/50466aa4/README.asc
----------------------------------------------------------------------
diff --git a/README.asc b/README.asc
index 320fdf8..1fd7cf7 100644
--- a/README.asc
+++ b/README.asc
@@ -1,22 +1,18 @@
+Executive summary
+-----------------
+Cassandra is a partitioned row store. Rows are organized into tables with a required primary key.
-Cassandra is a highly scalable, eventually consistent, distributed, structured
-key-value store.
+http://wiki.apache.org/cassandra/Partitioners[Partitioning] means that Cassandra can distribute your data across multiple machines in an application-transparent matter. Cassandra will automatically repartition as machines are added and removed from the cluster.
+http://wiki.apache.org/cassandra/DataModel[Row store] means that like relational databases, Cassandra organizes data by rows and columns. The Cassandra Query Language (CQL) is a close relative of SQL.
-Project description
--------------------
-
-Cassandra brings together the distributed systems technologies from Dynamo
-and the data model from Google's BigTable. Like Dynamo, Cassandra is
-eventually consistent. Like BigTable, Cassandra provides a ColumnFamily-based
-data model richer than typical key/value systems.
-
-For more information see http://cassandra.apache.org/
+For more information, see http://cassandra.apache.org/[the Apache Cassandra web site].
Requirements
------------
- * Java >= 1.7 (OpenJDK and Sun have been tested)
+. Java >= 1.7 (OpenJDK and Oracle JVMS have been tested)
+. Python 2.7 (for cqlsh)
Getting started
---------------
@@ -24,73 +20,74 @@ Getting started
This short guide will walk you through getting a basic one node cluster up
and running, and demonstrate some simple reads and writes.
- * tar -zxvf apache-cassandra-$VERSION.tar.gz
- * cd apache-cassandra-$VERSION
- * sudo mkdir -p /var/log/cassandra
- * sudo chown -R `whoami` /var/log/cassandra
- * sudo mkdir -p /var/lib/cassandra
- * sudo chown -R `whoami` /var/lib/cassandra
+First, we'll unpack our archive:
-Note: The sample configuration files in conf/ determine the file-system
-locations Cassandra uses for logging and data storage. You are free to
-change these to suit your own environment and adjust the path names
-used here accordingly.
+ $ tar -zxvf apache-cassandra-$VERSION.tar.gz
+ $ cd apache-cassandra-$VERSION
-Now that we're ready, let's start it up!
+and create the log and data directories. These correspond to the defaults from conf/ and may be adjusted to suit your own environment:
- * bin/cassandra -f
+ $ sudo mkdir -p /var/log/cassandra
+ $ sudo chown -R `whoami` /var/log/cassandra
+ $ sudo mkdir -p /var/lib/cassandra
+ $ sudo chown -R `whoami` /var/lib/cassandra
-Unix: Running the startup script with the -f argument will cause
-Cassandra to remain in the foreground and log to standard out.
+Finally, we start the server. Running the startup script with the -f argument will cause
+Cassandra to remain in the foreground and log to standard out; it can be stopped with ctrl-C.
-Windows: bin\cassandra.bat runs in the foreground by default. To
-install Cassandra as a Windows service, download Procrun from
-http://commons.apache.org/daemon/procrun.html, set the PRUNSRV
-environment variable to the full path of prunsrv (e.g.,
+ $ bin/cassandra -f
+
+****
+Note for Windows users: to install Cassandra as a service, download
+Procrun from http://commons.apache.org/daemon/procrun.html, set the
+PRUNSRV environment variable to the full path of prunsrv (e.g.,
C:\procrun\prunsrv.exe), and run "bin\cassandra.bat install".
Similarly, "uninstall" will remove the service.
+****
Now let's try to read and write some data using the Cassandra Query Language:
- * bin/cqlsh
+ $ bin/cqlsh
The command line client is interactive so if everything worked you should
-be sitting in front of a prompt...
-
- Connected to Test Cluster at localhost:9160.
- [cqlsh 2.2.0 | Cassandra 1.2.0 | CQL spec 3.0.0 | Thrift protocol 19.35.0]
- Use HELP for help.
- cqlsh>
+be sitting in front of a prompt:
+----
+Connected to Test Cluster at localhost:9160.
+[cqlsh 2.2.0 | Cassandra 1.2.0 | CQL spec 3.0.0 | Thrift protocol 19.35.0]
+Use HELP for help.
+cqlsh>
+----
As the banner says, you can use 'help;' or '?' to see what CQL has to
offer, and 'quit;' or 'exit;' when you've had enough fun. But lets try
something slightly more interesting:
- cqlsh> CREATE SCHEMA schema1
- WITH replication = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };
- cqlsh> USE schema1;
- cqlsh:Schema1> CREATE TABLE users (
- user_id varchar PRIMARY KEY,
- first varchar,
- last varchar,
- age int
- );
- cqlsh:Schema1> INSERT INTO users (user_id, first, last, age)
- VALUES ('jsmith', 'John', 'Smith', 42);
- cqlsh:Schema1> SELECT * FROM users;
- user_id | age | first | last
- ---------+-----+-------+-------
- jsmith | 42 | john | smith
-
- cqlsh:Schema1>
+----
+cqlsh> CREATE SCHEMA schema1
+ WITH replication = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };
+cqlsh> USE schema1;
+cqlsh:Schema1> CREATE TABLE users (
+ user_id varchar PRIMARY KEY,
+ first varchar,
+ last varchar,
+ age int
+ );
+cqlsh:Schema1> INSERT INTO users (user_id, first, last, age)
+ VALUES ('jsmith', 'John', 'Smith', 42);
+cqlsh:Schema1> SELECT * FROM users;
+ user_id | age | first | last
+---------+-----+-------+-------
+ jsmith | 42 | john | smith
+ cqlsh:Schema1>
+----
If your session looks similar to what's above, congrats, your single node
cluster is operational!
For more on what commands are supported by CQL, see
-https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile. A
-reasonable way to think of it is as, "SQL minus joins and subqueries."
+https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile[the CQL reference]. A
+reasonable way to think of it is as, "SQL minus joins and subqueries, plus collections."
Wondering where to go from here?