Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Mirror of Apache Cassandra (incubating)
Java Python GAP Shell Thrift PowerShell Other
Branch: trunk
Pull request Compare This branch is 845 commits behind apache:trunk.
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin Merge branch 'cassandra-2.2' into cassandra-3.0
conf Disable scripted UDFs by default
debian fix debian tools install
doc Revert "Revert "Materialized Views""
examples Remove deprecated legacy Hadoop code
ide/idea Add generate-idea-files target to build.xml
interface Swap all references to 3.0 with 2.2
lib Fix cqlsh DESCRIBE column order
pylib Merge branch 'cassandra-2.2' into cassandra-3.0
src Merge branch 'cassandra-3.0' into trunk
test Merge branch 'cassandra-3.0' into trunk
tools Merge branch 'cassandra-2.2' into trunk
.gitignore add doc/cql3/CQL.html to .gitignore
.rat-excludes Update versions and licenses for 2.1 RC3 release
CHANGES.txt remove extra line Add
LICENSE.txt merge with 0.6 branch (post-850)
NEWS.txt Merge branch 'cassandra-2.2' into cassandra-3.0
NOTICE.txt Bytecode inspection for Java-UDFs
README.asc update readme Followup commit to fix maven deps on boundary's NBHM for CASSANDRA-7128
build.xml ScrubTest should generate out-of-order SSTable on the fly Add Static Analysis to warn on unsafe use of Autocloseable instances Storage engine refactor, a.k.a CASSANDRA-8099


Executive summary

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

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.

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 the Apache Cassandra web site.


  1. Java >= 1.8 (OpenJDK and Oracle JVMS have been tested)

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

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

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

Something went wrong with that request. Please try again.