Go to file
Jonathan Ellis f2ecfb5cb1 s/cassandra/apache-cassandra-incubating/. patch by johano; reviewed by jbellis for CASSANDRA-191
git-svn-id: https://svn.apache.org/repos/asf/incubator/cassandra/branches/cassandra-0.3@779747 13f79535-47bb-0310-9956-ffa450edef68
2009-05-28 19:53:52 +00:00
bin enable assertions by default. patch by jbellis 2009-05-13 22:31:52 +00:00
conf add license header to source files missing one. patch by johano; reviewed by jbellis for CASSANDRA-175 2009-05-14 14:33:41 +00:00
interface use `block` flag instead of separate _blocking methods. throw exception on error instead of returning bool for success. patch by jbellis; reviewed by Eric Evans for CASSANDRA-131 2009-05-05 14:54:05 +00:00
lib r/m activation.jar for CASSANDRA-186 2009-05-18 20:50:22 +00:00
src/java/org/apache/cassandra OneCompactionTest is failing occasionally because 500 keys per CFS is actually triggering an automatic compaction (since test flush threshold is only 20) and we were doing a non-threadsafe doCompaction for convenience: the failure occurs when our manual compaction begins mid-run of an automatic one, and the automatic deletes the original sstable file first. Fix by (a) dropping the number of keys so that OneCompactionTest lives up to its name (more are tested in "CompactionsTest") and (b) making the compactions call threadsafe by refactoring to allow a threshold parameter to MCM.submit. 2009-05-20 14:40:27 +00:00
test OneCompactionTest is failing occasionally because 500 keys per CFS is actually triggering an automatic compaction (since test flush threshold is only 20) and we were doing a non-threadsafe doCompaction for convenience: the failure occurs when our manual compaction begins mid-run of an automatic one, and the automatic deletes the original sstable file first. Fix by (a) dropping the number of keys so that OneCompactionTest lives up to its name (more are tested in "CompactionsTest") and (b) making the compactions call threadsafe by refactoring to allow a threshold parameter to MCM.submit. 2009-05-20 14:40:27 +00:00
LICENSE.txt add license, readme files. patch by johano; reviewed by jbellis for #108 2009-04-25 18:52:40 +00:00
NOTICE.txt add NOTICE.txt. patch by johano; reviewed by jbellis for CASSANDRA-127 2009-05-01 18:04:32 +00:00
README.txt add cli wrapper and Getting Started section to readme. patch by johano and Eric Evans; reviewed by jbellis for CASSANDRA-117 2009-05-01 16:05:13 +00:00
build.xml s/cassandra/apache-cassandra-incubating/. patch by johano; reviewed by jbellis for CASSANDRA-191 2009-05-28 19:53:52 +00:00

README.txt

Cassandra is a highly scalable, eventually consistent, distributed, structured 
key-value store. 


Project description
-------------------

Cassandra brings together the distributed systems technologies from Dynamo 
and the data model from Google's BigTable. Like Dynamo, Cassandra is 
eventually consistent. Like BigTable, Cassandra provides a ColumnFamily-based
data model richer than typical key/value systems.

For more information see http://incubator.apache.org/cassandra


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.

  * tar -zxvf cassandra-$VERSION.tgz
  * cd cassandra-$VERSION
  * sudo mkdir -p /var/cassandra/logs
  * sudo chown `whoami` -R /var/cassandra

Note: The sample configuration files in conf/ determine the file-system 
locations Cassandra uses for logging and data storage. You are free to
change these to suit your own environment and adjust the path names
used here accordingly.

Now that we're ready, let's start it up!

  * bin/cassandra -f

Running the startup script with the -f argument will cause Cassandra to
remain in the foreground and log to standard out.

Now let's try to read and write some data using the command line client.

  * bin/cassandra-cli --host localhost --port 9160

The command line client is interactive so if everything worked you should
be sitting in front of a prompt...

  Connected to localhost/9160
  Welcome to cassandra CLI.
  
  Type 'help' or '?' for help. Type 'quit' or 'exit' to quit.
  cassandra>

As the banner says, you can use 'help' or '?' to see what the CLI has to
offer, and 'quit' or 'exit' when you've had enough fun. But lets try
something slightly more interesting...

  cassandra> set Table1.Standard1['jsmith']['first'] = 'John'
  Statement processed.
  cassandra> set Table1.Standard1['jsmith']['last'] = 'Smith' 
  Statement processed.
  cassandra> set Table1.Standard1['jsmith']['age'] = '42'
  Statement processed.
  cassandra> get Table1.Standard1['jsmith']
  COLUMN_TIMESTAMP = 1241129773658; COLUMN_VALUE = 42; COLUMN_KEY = age;
  COLUMN_TIMESTAMP = 1241129537336; COLUMN_VALUE = Smith; COLUMN_KEY = last; 
  COLUMN_TIMESTAMP = 1241129520503; COLUMN_VALUE = John; COLUMN_KEY = first; 
  Statement processed.
  cassandra>

If your session looks similar to what's above, congrats, your single node
cluster is operational! But what exactly was all of that? Let's break it
down into pieces and see.

  set Table1.Standard1['jsmith']['first'] = 'John'
       \         \         \        \          \
        \         \         \_ key   \          \_ value
         \         \                  \_ column
          \_ table  \_ column family

Data stored in Cassandra is associated with a column family (Standard1), 
which in turn is associated with a table (Table1). In the example above,
we set the value 'John' in the 'first' column for key 'jsmith'.

For more information on the Cassandra data model be sure to checkout 
http://cwiki.apache.org/confluence/display/CSDR/Data+Model

Wondering where to go from here? 

  * The wiki (http://cwiki.apache.org/confluence/display/CSDR) is the 
    best source for additional information.
  * Join us in #cassandra on irc.freenode.net and ask questions.
  * Subscribe to the Users mailing list by sending a mail to
    cassandra-user-subscribe@incubator.apache.org