Go to file
Ben Slater 11aeeea2cb fix errors in cassandra-stress print settings output
patch by bslater reviewed by dbrosius for CASSANDRA-12473
2016-09-03 23:05:35 -04:00
bin Merge branch 'cassandra-3.9' into trunk 2016-07-29 15:31:21 +08:00
conf Add keep-alive to streaming 2016-08-31 16:03:00 -05:00
debian Update debian/changelog for 3.10 2016-08-16 18:27:39 -05:00
doc Ninja: actually commit images for IDE section of docs 2016-08-30 11:02:09 -05:00
examples Updated trigger example 2015-11-10 15:35:13 +00:00
ide Ninja, remove gen-thrift-java ant task from IntelliJ launch configs 2016-08-20 21:55:56 +10:00
interface minor javadoc fixes 2016-08-07 01:00:16 -04:00
lib Merge branch 'cassandra-3.9' into trunk 2016-08-05 11:54:28 -04:00
pylib Merge branch 'cassandra-3.0' into trunk 2016-09-01 10:22:01 +08:00
src Use weak references in compaction logger to avoid strong ref loops 2016-09-02 14:35:52 +02:00
test Merge branch 'cassandra-3.0' into trunk 2016-09-01 10:06:57 +08:00
tools fix errors in cassandra-stress print settings output 2016-09-03 23:05:35 -04:00
.gitignore Finish fixing the CQL doc 2016-06-24 17:01:37 +02:00
.rat-excludes Remove Pig support 2015-10-16 13:23:20 +01:00
CHANGES.txt Merge branch 'cassandra-3.0' into trunk 2016-09-01 17:12:43 -04: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 Add keep-alive to streaming 2016-08-31 16:03:00 -05:00
NOTICE.txt Introduce HdrHistogram and response/service/wait separation to stress tool 2016-05-27 11:59:55 -04:00
README.asc update readme 2015-05-15 14:36:56 -04:00
build.properties.default merge from 0.8 2011-08-06 02:14:31 +00:00
build.xml update jmh jars to 1.13 to quell build time RELEASE_6 warnings 2016-09-03 22:57:35 -04:00
eclipse_compiler.properties Add Static Analysis to warn on unsafe use of Autocloseable instances 2015-05-27 17:53:26 -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.8 (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

After that 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/