Skip to content

Commit

Permalink
Spelling corrections and misc documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Fero authored and mpenick committed Oct 28, 2015
1 parent 8e25159 commit d6d44e1
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 37 deletions.
3 changes: 1 addition & 2 deletions topics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Each I/O thread maintains a small number of connections for each node in the
Cassandra cluster and each of those connections can handle several simultaneous
requests using pipelining. Asynchronous I/O and pipelining together allow each
connection to handle several (up to 128 requests with protocol v1/v2 and 32k with
protocol v3) in-flight requests concurrently. This significantly reduces the
protocol v3/v4) in-flight requests concurrently. This significantly reduces the
number of connections required to be open to Cassandra and
allows the driver to batch requests destined for the same node.
Expand All @@ -175,7 +175,6 @@ Here are some features that are missing from the C/C++ driver, but are included
- Event registration and notification
- Callback interfaces for load balancing, authentication, reconnection and retry
- Generic SASL authentication interface
- [User Defined Type (UDT)](http://www.datastax.com/documentation/cql/3.1/cql/cql_reference/cqlRefUDType.html)
[`cass_int32_t`]: http://datastax.github.io/cpp-driver/api/cassandra.h/#cass-int32-t
[`cass_result_first_row()`]: http://datastax.github.io/cpp-driver/api/CassResult/#cass-result-first-row
6 changes: 3 additions & 3 deletions topics/basics/batches/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Batches

Batches can be used to group multiple mutations (`UPDATE`, `INSERT`, `DELETE`) together into a single statement; simple or perpared. There are three different types of batches supported by Cassandra 2.0 or later.
Batches can be used to group multiple mutations (`UPDATE`, `INSERT`, `DELETE`) together into a single statement; simple or prepared. There are three different types of batches supported by Cassandra 2.0 or later.

* `CASS_BATCH_TYPE_LOGGED` is used to make sure that multiple mutations across multiple partitions happen atomically, that is, all the included mutations will eventually succeed. However, there is a performance penalty imposed by atomcity guarantee.
* `CASS_BATCH_TYPE_UNLOGGED` is generally used to group mutations for a single partition and do not suffer from the performance penalty imposed by logged batches, but there is no atomicty guarantee for multi-partition updates.
* `CASS_BATCH_TYPE_LOGGED` is used to make sure that multiple mutations across multiple partitions happen atomically, that is, all the included mutations will eventually succeed. However, there is a performance penalty imposed by atomicity guarantee.
* `CASS_BATCH_TYPE_UNLOGGED` is generally used to group mutations for a single partition and do not suffer from the performance penalty imposed by logged batches, but there is no atomicity guarantee for multi-partition updates.
* `CASS_BATCH_TYPE_COUNTER` is used to group counters updates.

**Important**: Be careful when using batches as a [performance optimization](http://www.datastax.com/documentation/cql/3.1/cql/cql_using/useBatch.html).
Expand Down
2 changes: 0 additions & 2 deletions topics/testing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,4 @@ Here are some of the items being scheduled for future enhancements.
- Incorporate integration tests into Jenkins environment
- Remove Boost Test Framework in Favor of Google Test Framework
- Updates to CCM Bridge
- Add SSH key support (extra security over plain text password)
- Simply configuration files
- Allow files to be copied over SSH established connection
99 changes: 69 additions & 30 deletions topics/testing/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,69 +4,108 @@ created in the working directory where the integration tests are run. Below is
an example of the configuration file for use with the [CCM Cluster] VM.

```text
##
# CCM Options
###############################################################################
# This is configuration file for CCM bridge library used primarily by the #
# integration testing framework #
###############################################################################
###############################################################################
# CCM Options #
###############################################################################
##
# CCM Cassandra Deployment Version
#
# Cassandra version to deploy using CCM
# (branches and tags can be used from https://github.com/apache/cassandra)
#
CASSANDRA_VERSION=2.1.3
# Uncomment to specify Cassandra version
##
# SSH Options
# Enusre DEPLOYMENT_TYPE=ssh to enable these options
#CASSANDRA_VERSION=2.2.3
##
# SSH Host (Hostname/IP Address)
# Flag to determine if Cassandra version should be obtained from ASF git
#
# Host/IP to use when establishing ssh connection for remote CCM command
# execution
# Uncomment to specify use of ASF git
##
#USE_ASFGIT=false
##
# CCM Deployment Type (local|remote)
#
SSH_HOST=192.168.33.11
# Setting to indicate how CCM commands should be run (locally or through SSH)
#
# Uncomment to specify deployment type (defaults to local)
##
#DEPLOYMENT_TYPE=local
###############################################################################
# SSH Options #
# Enusre DEPLOYMENT_TYPE=ssh to enable these options #
###############################################################################
##
# SSH Port (Port)
#
# TCP/IP port to use when establishing ssh connection for remote CCM command
# execution
#
SSH_PORT=22
# Uncomment to specify SSH port (defaults to 22)
##
#SSH_PORT=22
##
# CCM Authentication Type (username_password|public_key)
#
# Setting to indicate how SSH connections should be authenticated
#
# Uncomment to specify authentication type (defaults to username and password)
##
#AUTHENTICATION_TYPE=username_password
##
# SSH Username (Username)
#
# Username for authenticating SSH connection
#
SSH_USERNAME=vagrant
#
# Uncomment to specify SSH username (defaults to vagrant)
##
#SSH_USERNAME=vagrant
##
# SSH Password (Password)
#
# Password for authenticating SSH connection
#
# NOTE: This password is plain text
#
SSH_PASSWORD=vagrant
# Uncomment to specify SSH password (defaults to vagrant)
##
# CPP-Driver Options
#SSH_PASSWORD=vagrant
##
# SSH Public Key
#
# Path name of the public key file
#
# IP Prefix (Single/Multiple Node Test Connections)
# Uncomment to specify public key filename
##
#SSH_PUBLIC_KEY=
##
# SSH Private Key
#
# Cassandra node IP prefix for cpp-driver connection(s) and CCM node creation
# Path name of the private key file
#
IP_PREFIX=192.168.33.1
```
(where `CASSANDRA_VERSION=2.1.3` is the latest version of Cassandra)

## Driver Downgrade Test Suite
To execute any of the tests in the `version1_downgrade` test suite, a copy of
`config.txt` above should be created called `config_v1.txt` and the
`CASSANDRA_VERSION` option must be updated to a Cassandra in the 1.x family.
# Uncomment to specify private key filename
##
#SSH_PRIVATE_KEY=
```text
CASSANDRA_VERSION=1.2.19
###############################################################################
# C/C++-Driver Options #
###############################################################################
##
# Host (Single/Multiple Node Test Connections)
#
# Cassandra node IP for cpp-driver connection(s), CCM node creation, and SSH
# remote connections
#
# NOTE: This must be in IPv4 format
#
# Uncomment to specify host/ip address
##
#HOST=127.0.0.1
```
(where `CASSANDRA_VERSION=1.2.19` is the latest version of Cassandra 1.2)

## SSL Test Suite
To execute any of the tests in the `ssl` test suite, follow the [instructions]
Expand Down

0 comments on commit d6d44e1

Please sign in to comment.