Go to file
blambov 50e5802a7d Stop CommitLogTest hanging
patch by branimir; reviewed by aweisberg for CASSANDRA-8992
2015-08-11 16:12:59 -05:00
bin Added quotes to CLASSPATH and JAVA for nix scripts, CASSANDRA-9529 2015-06-08 09:29:10 -05:00
conf Fix remote debugging configuration 2015-05-05 13:24:29 -05:00
debian bump versions 2015-06-18 14:02:45 -04:00
doc Update CQL docs with auth and DCL info 2015-06-01 18:08:31 +01:00
examples Added quotes to CLASSPATH and JAVA for nix scripts, CASSANDRA-9529 2015-06-08 09:29:10 -05:00
interface Merge branch 'cassandra-1.2' into cassandra-2.0 2014-03-19 12:11:02 -05:00
lib cqlsh: Add (LOCAL_)SERIAL consistency levels 2015-05-05 14:43:56 -05:00
pylib cqlsh: Add min_threshold to DTCS autocomplete options 2015-06-26 13:29:51 -05:00
src Add tool to find why expired sstables are not getting dropped 2015-08-11 09:31:30 +02:00
test Stop CommitLogTest hanging 2015-08-11 16:12:59 -05:00
tools Add tool to find why expired sstables are not getting dropped 2015-08-11 09:31:30 +02:00
.gitignore add logs/ and data/ to .gitignore 2014-06-09 21:14:58 -04:00
.rat-excludes Version and licenses for 2.0.10 release 2014-08-08 10:54:41 +02:00
CHANGES.txt Add tool to find why expired sstables are not getting dropped 2015-08-11 09:31:30 +02:00
CONTRIBUTING.md Add CONTRIBUTING.md 2015-01-05 22:45:53 +03:00
LICENSE.txt merge with 0.6 branch (post-850) 2010-03-26 16:31:52 +00:00
NEWS.txt bump versions 2015-06-18 14:02:45 -04:00
NOTICE.txt Merge branch 'cassandra-1.2' into cassandra-2.0 2014-03-17 11:03:47 +01:00
README.asc formatting 2014-04-30 12:50:05 -05:00
build.properties.default merge from 0.8 2011-08-06 02:14:31 +00:00
build.xml bump versions 2015-06-18 14:02:45 -04:00

README.asc

Executive summary
-----------------

Cassandra is a partitioned row store.  Rows are organized into tables with a required primary key.

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.

For more information, see http://cassandra.apache.org/[the Apache Cassandra web site].

Requirements
------------
. Java >= 1.7 (OpenJDK and Oracle JVMS have been tested)
. Python 2.7 (for cqlsh)

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.

First, we'll unpack our archive:

  $ tar -zxvf apache-cassandra-$VERSION.tar.gz
  $ cd apache-cassandra-$VERSION

and create the log and data directories.  These correspond to the defaults from conf/ and may be adjusted to suit your own environment:

  $ 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

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.

  $ bin/cassandra -f

****
Note for Windows users: to install Cassandra as a service, download
http://commons.apache.org/daemon/procrun.html[Procrun], 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

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> 
----

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> 
----

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[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? 

  * Getting started: http://wiki.apache.org/cassandra/GettingStarted
  * Join us in #cassandra on irc.freenode.net and ask questions
  * Subscribe to the Users mailing list by sending a mail to
    user-subscribe@cassandra.apache.org
  * Planet Cassandra aggregates Cassandra articles and news:
    http://planetcassandra.org/