Go to file
Mick Semb Wever c2148980ce
Remove read_repair table option from docs, and restore read_repair_chance docs
patch by Milan Krisko; reviewed by Mick Semb Wever for CASSANDRA-17727
2022-07-16 12:57:38 +02:00
.build Merge branch 'cassandra-3.0' into cassandra-3.11 2022-06-21 09:46:26 -05:00
.circleci Merge branch 'cassandra-3.0' into cassandra-3.11 2022-05-09 21:37:02 -04:00
.jenkins Merge branch 'cassandra-3.0' into cassandra-3.11 2022-06-19 16:39:32 +02:00
bin Merge branch 'cassandra-3.0' into cassandra-3.11 2021-07-16 07:56:34 -05:00
conf Merge branch 'cassandra-3.0' into cassandra-3.11 2021-12-09 10:26:00 -05:00
debian Prepare debian changelog for 3.11.13, bump version to 3.11.14 2022-05-14 01:28:32 +02:00
doc Remove read_repair table option from docs, and restore read_repair_chance docs 2022-07-16 12:57:38 +02:00
examples example/triggers build fail. 2016-11-14 10:13:06 +01:00
ide Merge branch 'cassandra-3.0' into cassandra-3.11 2021-10-21 07:38:48 -05:00
interface minor javadoc fixes 2016-08-07 01:00:16 -04:00
pylib CQLSH unicode control character list is too liberal 2022-06-14 06:57:16 +02:00
redhat Add procps-ng RPM dependency 2022-04-13 07:02:03 -05:00
src Only use statically defined subcolumns when determining column definition for supercolumn cell 2022-07-11 16:46:12 +02:00
test Only use statically defined subcolumns when determining column definition for supercolumn cell 2022-07-11 16:46:12 +02:00
tools Merge branch 'cassandra-3.0' into cassandra-3.11 2021-04-27 09:20:25 +01:00
.gitignore Migrate documentation to AsciiDoc 2022-01-05 22:03:02 +01:00
CASSANDRA-14092.txt Merge branch 'cassandra-2.2' into cassandra-3.0 2018-02-10 14:57:53 -02:00
CHANGES.txt Only use statically defined subcolumns when determining column definition for supercolumn cell 2022-07-11 16:46:12 +02:00
CONTRIBUTING.md Update links in CONTRIBUTING.md 2021-04-22 08:31:39 -05:00
LICENSE.txt merge with 0.6 branch (post-850) 2010-03-26 16:31:52 +00:00
NEWS.txt Merge branch 'cassandra-3.0' into cassandra-3.11 2022-02-18 11:14:29 +01:00
NOTICE.txt Bump copyright to 2009-2022 2022-01-23 13:01:58 +01:00
README.asc Merge branch 'cassandra-3.0' into cassandra-3.11 2021-04-26 08:46:56 -05:00
build.properties.default Switch http to https URLs in build.xml 2019-05-22 15:03:43 -04:00
build.xml Prepare debian changelog for 3.11.13, bump version to 3.11.14 2022-05-14 01:28:32 +02: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.

https://cwiki.apache.org/confluence/display/CASSANDRA2/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.

https://cwiki.apache.org/confluence/display/CASSANDRA2/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 KEYSPACE 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.