Go to file
Erick Ramirez ca2dc1bfa9 Updated the introductory section of the Installation page
Patch by Erick Ramirez; Reviewed by Jon Haddad for CASSANDRA-15466
2020-04-10 12:44:37 -07:00
.circleci Merge branch 'cassandra-3.11' into trunk 2020-03-27 12:27:11 +01:00
.jenkins Merge branch 'cassandra-3.11' into trunk 2020-03-28 11:51:08 +01:00
bin Fix cqlsh erroring out on Python 3.7 due to webbrowser module being absent 2020-04-07 16:24:22 -07:00
conf Set cross_node_timeout to true by default. 2020-01-15 16:35:44 -06:00
debian Merge branch 'cassandra-3.11' into trunk 2020-02-26 11:51:01 -06:00
doc Updated the introductory section of the Installation page 2020-04-10 12:44:37 -07:00
examples/triggers Fix trigger example on 4.0 2017-08-24 08:34:34 -07:00
ide Add compaction allocation measurement test 2020-03-11 12:50:50 -07:00
lib Update to Python driver 3.21 for cqlsh 2020-02-20 15:38:44 -08:00
pylib Use Exception.message in copyutil.py only if it exists 2020-04-09 11:44:30 -04:00
redhat Merge branch 'cassandra-3.11' into trunk 2020-03-03 22:50:35 +01:00
src Add client request size metrics 2020-04-09 17:50:53 -07:00
test Fixed race condition in MoveTest by waiting for stale endpoints to be evicted from membership before starting another test. 2020-04-10 11:30:07 -05:00
tools Remove Java Driver dependency for UDFs and UDAs / Limit the dependencies used by UDFs/UDAs 2020-02-12 09:58:43 +01:00
.gitignore Remove obsolete OldNetworkTopologyStrategy 2019-11-29 10:50:10 +01:00
.rat-excludes Remove Pig support 2015-10-16 13:23:20 +01:00
CASSANDRA-14092.txt Merge branch 'cassandra-2.2' into cassandra-3.0 2018-02-10 14:57:53 -02:00
CHANGES.txt Update docs describing when a CHANGES.txt entry is necessary 2020-04-10 21:13:33 +02:00
CONTRIBUTING.md Remove comment from CONTRIBUTING.md regarding closing GitHub PRs. 2019-01-09 14:17:19 +00:00
LICENSE.txt merge with 0.6 branch (post-850) 2010-03-26 16:31:52 +00:00
NEWS.txt Republished 3.11.6 NEWS.txt, CHANGES.txt 2020-04-01 12:29:03 -07:00
NOTICE.txt Remove Java Driver dependency for UDFs and UDAs / Limit the dependencies used by UDFs/UDAs 2020-02-12 09:58:43 +01:00
README.asc Update README.asc 2020-03-30 14:16:00 -07:00
TESTING.md Ninja trivial typo in TESTING 2018-06-20 21:28:09 -07:00
build.properties.default Switch http to https URLs in build.xml 2019-05-22 15:03:43 -04:00
build.xml Add AssertJ test dependency. 2020-04-02 14:20:11 -05: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 the https://s.apache.org/slack-invite[ASF Slack] 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.
  * Visit the http://cassandra.apache.org/doc/latest/development/index.html[development section] of the Cassandra website for more information on how to contribute.