Go to file
Ben Slater 57f5e36713 Documentation updates per CASSANDRA-12906
Patch by Ben Slater; reviewed by Nate McCall
2017-02-28 12:18:48 +13:00
bin Merge branch 'cassandra-3.11' into trunk 2017-02-15 18:00:24 -06:00
conf Merge branch 'cassandra-3.11' into trunk 2017-02-14 15:14:15 -05:00
debian Add 4.0 to debian/changelog 2017-02-15 18:21:42 -06:00
doc Documentation updates per CASSANDRA-12906 2017-02-28 12:18:48 +13:00
examples/triggers Make TableMetadata immutable, optimize Schema 2017-01-27 22:17:46 +00:00
ide Thrift removal 2016-12-13 10:27:12 +01:00
lib Merge branch 'cassandra-3.11' into trunk 2017-02-09 21:13:14 +01:00
pylib ninja: add default min_compress_ratio to cqlshlib tests, follow-up to CASSANDRA-10520 2017-02-27 10:55:39 +08:00
redhat Merge branch 'cassandra-3.X' into trunk 2017-01-04 10:00:43 -06:00
src Avoid synchronized on prepareForRepair in ActiveRepairService 2017-02-24 17:08:01 +01:00
test Merge branch 'cassandra-3.0' into trunk 2017-02-23 15:21:47 +01:00
tools Merge branch 'cassandra-3.11' into trunk 2017-02-10 21:23:41 -08:00
.gitignore Automate Nodetool Documentation 2016-10-07 16:52:18 +11:00
.rat-excludes Remove Pig support 2015-10-16 13:23:20 +01:00
CHANGES.txt Avoid synchronized on prepareForRepair in ActiveRepairService 2017-02-24 17:08:01 +01: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 Merge branch 'cassandra-3.11' into trunk 2017-02-15 10:53:21 -02:00
NOTICE.txt Thrift removal 2016-12-13 10:27:12 +01:00
README.asc minor fixups to the README file 2016-09-04 00:11:28 -04:00
build.properties.default merge from 0.8 2011-08-06 02:14:31 +00:00
build.xml Merge branch 'cassandra-3.11' into trunk 2017-02-14 23:26:55 +00: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

Apache Cassandra
-----------------

Apache Cassandra is a highly-scalable 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. For a more-complete guide, please see the Apache Cassandra website's http://cassandra.apache.org/doc/latest/getting_started/[Getting Started Guide].

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
http://cassandra.apache.org/doc/latest/cql/[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?

  * 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
  * Visit the http://cassandra.apache.org/community/[community section] of the Cassandra website for more information on getting involved.