Go to file
Brandon Williams 6bb585bf5d Warn when cqlsh does not match the server version it was built with
Patch by brandonwilliams; reviewed by bereng for CASSANDRA-18745
2023-08-18 10:08:52 -05:00
.build Warn when cqlsh does not match the server version it was built with 2023-08-18 10:08:52 -05:00
.circleci Fix dtest-jar 2023-07-28 14:31:17 -04:00
.jenkins Merge branch 'cassandra-2.2' into cassandra-3.0 2022-06-19 16:38:43 +02:00
bin Warn when cqlsh does not match the server version it was built with 2023-08-18 10:08:52 -05:00
conf Add support for AWS Ec2 IMDSv2 2023-06-28 16:08:39 +02:00
debian remove dh_python use from Debian packaging 2023-06-01 15:00:03 -05:00
doc Fix writetime and ttl functions forbidden for collections instead of multicell columns 2022-06-27 15:09:35 +01:00
examples Updated trigger example 2015-11-10 15:35:13 +00:00
ide Add to the IntelliJ Git Window issue navigation links to Cassandra's Jira 2023-01-09 09:37:53 +01:00
interface Swap all references to 3.0 with 2.2 2015-05-14 17:16:54 +03:00
pylib Upgrade Cython, minimum required now is 0.27.2 2022-11-10 14:34:55 +01:00
redhat Fix Requires for Java for RPM package 2023-08-15 13:49:58 +02:00
src Add speculative retries to tablestats 2023-08-18 05:07:08 -05:00
test Add support for AWS Ec2 IMDSv2 2023-06-28 16:08:39 +02:00
tools Pass down all contact points to driver for cassandra-stress 2023-05-19 15:05:32 +02:00
.gitignore Expand build.dir property in rat targets 2023-01-23 14:45:39 +01:00
CASSANDRA-14092.txt Merge branch 'cassandra-2.2' into cassandra-3.0 2018-02-10 14:57:53 -02:00
CHANGES.txt Warn when cqlsh does not match the server version it was built with 2023-08-18 10:08:52 -05: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 Add support for AWS Ec2 IMDSv2 2023-06-28 16:08:39 +02:00
NOTICE.txt Removing trailing year from copyright. 2023-02-22 10:23:47 -06:00
README.asc Update README links 2021-04-26 08:46:20 -05:00
build.properties.default Switch http to https URLs in build.xml 2019-05-22 15:03:43 -04:00
build.xml Warn when cqlsh does not match the server version it was built with 2023-08-18 10:08:52 -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

Executive summary
-----------------

Cassandra is a 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.

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
https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile[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?

  * Getting started: http://wiki.apache.org/cassandra/GettingStarted
  * 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
  * Planet Cassandra aggregates Cassandra articles and news:
    http://planetcassandra.org/