Go to file
Michael Shuler cb090791c3 Use portable stderr for java error in startup 2017-02-15 17:49:39 -06:00
bin Use portable stderr for java error in startup 2017-02-15 17:49:39 -06:00
conf update cassandra.yaml comments post-CASSANDRA-10243 2016-07-26 10:54:31 -05:00
debian Bump version to 2.1.17 2016-10-10 17:09:10 -05:00
doc Update CQL doc for CASSANDRA-6839 (non equal conditions in LWT) 2016-03-17 10:18:32 +01:00
examples merge from 2.0 2015-06-08 09:34:16 -05:00
ide/idea Add generate-idea-files target to build.xml 2015-04-07 18:12:16 +02:00
interface Backport MultiSliceRequest 2014-05-28 12:50:35 -04:00
lib Upgrade netty to 4.0.44 to fix memory leak with client encryption 2017-02-09 20:36:07 +01:00
pylib cqlsh copy-from: sort user type fields in csv 2016-12-22 10:23:57 +08:00
redhat Add redhat RPM build directory 2016-12-06 17:26:04 -06:00
src Fix Thread Leak in OutboundTcpConnection 2017-02-11 07:47:29 -08:00
test Fix paging for DISTINCT queries on partition keys and static columns 2017-01-11 21:05:37 +01:00
tools CASSANDRA-10828: Allow usage of multiplier in start value of population sequence 2016-05-18 09:09:06 -04:00
.gitignore Add conf/hotspot_compiler to .gitignore 2014-07-03 21:49:05 +03:00
.rat-excludes Version and licenses for 2.0.10 release 2014-08-08 10:54:41 +02:00
CHANGES.txt Use portable stderr for java error in startup 2017-02-15 17:49:39 -06: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 Treat IN values as a set instead of a list 2016-09-27 11:51:41 -05:00
NOTICE.txt Merge branch 'cassandra-2.0' into cassandra-2.1 2014-03-17 11:08:47 +01:00
README.asc Ninja - remove section to create directories below /var 2015-05-07 16:18:02 +02:00
build.properties.default Followup commit to fix maven deps on boundary's NBHM for CASSANDRA-7128 2014-05-14 09:02:45 -04:00
build.xml Upgrade netty to 4.0.44 to fix memory leak with client encryption 2017-02-09 20:36:07 +01: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

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/