Skip to content

Commit a9b6bb5

Browse files
committed
Refinements to README, changing datastax.github.io refs to docs.ds, among other things.
1 parent efdc717 commit a9b6bb5

File tree

6 files changed

+48
-33
lines changed

6 files changed

+48
-33
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ Breaking Changes:
8585
* Unavailable errors are retried on the next host in the load balancing plan by default.
8686
* Statement execution no longer retried on timeouts, unless `:idempotent => true` has been specified when executing.
8787

88+
# 2.1.7
89+
Bug Fixes:
90+
* [RUBY-255](https://datastax-oss.atlassian.net/browse/RUBY-255) ControlConnection.peer_ip ignores peers that are missing critical information in system.peers.
91+
8892
# 2.1.6
8993
Bug Fixes:
9094

@@ -105,7 +109,6 @@ Bug Fixes:
105109

106110
Features:
107111

108-
* [RUBY-119](https://datastax-oss.atlassian.net/browse/RUBY-119) Use `require 'datastax/cassandra'` to avoid namespace conflicts
109112
* [RUBY-90](https://datastax-oss.atlassian.net/browse/RUBY-90) Add support for disabling nagle algorithm (tcp nodelay), enabled by default.
110113
* [RUBY-70](https://datastax-oss.atlassian.net/browse/RUBY-70) Add support for client-side timestamps, disabled by default.
111114
* [RUBY-114](https://datastax-oss.atlassian.net/browse/RUBY-114) Add support for serial consistency in batch requests.
@@ -118,6 +121,7 @@ Bug Fixes:
118121
* [RUBY-97](https://datastax-oss.atlassian.net/browse/RUBY-97) Allow disabling of the initial population of schema metadata
119122
* [RUBY-95](https://datastax-oss.atlassian.net/browse/RUBY-95) Speed up generation of large token maps
120123
* [RUBY-116](https://datastax-oss.atlassian.net/browse/RUBY-116) fix thread leak on connection error
124+
* [RUBY-119](https://datastax-oss.atlassian.net/browse/RUBY-119) Use `require 'datastax/cassandra'` to avoid namespace conflicts
121125

122126
Breaking Changes:
123127

README.md

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
# Datastax Ruby Driver for Apache Cassandra
22

3-
*If you're reading this on GitHub, please note that this is the readme for the development version and that some features described here might not yet have been released. You can [find the documentation for the latest version through ruby driver docs](http://docs.datastax.com/en/latest-ruby-driver/ruby-driver/whatsNew.html) or via the release tags, [e.g. v3.0.3](https://github.com/datastax/ruby-driver/tree/v3.0.3).*
3+
*If you're reading this on GitHub, please note that this is the readme for the development version and that some
4+
features described here might not yet have been released. You can view the documentation for the latest released
5+
version [here](http://docs.datastax.com/en/developer/ruby-driver/latest).*
46

57
[![Build Status](https://travis-ci.org/datastax/ruby-driver.svg?branch=master)](https://travis-ci.org/datastax/ruby-driver)
68

79
A Ruby client driver for Apache Cassandra. This driver works exclusively with
810
the Cassandra Query Language version 3 (CQL3) and Cassandra's native protocol.
911

1012
- Code: https://github.com/datastax/ruby-driver
11-
- Docs: http://docs.datastax.com/en/latest-ruby-driver/ruby-driver/whatsNew.html
13+
- Docs: http://docs.datastax.com/en/developer/ruby-driver
1214
- Jira: https://datastax-oss.atlassian.net/browse/RUBY
1315
- Mailing List: https://groups.google.com/a/lists.datastax.com/forum/#!forum/ruby-driver-user
1416
- IRC: #datastax-drivers on [irc.freenode.net](http://freenode.net>)
15-
- Twitter: Follow the latest news about DataStax Drivers - [@avalanche123](http://twitter.com/avalanche123), [@stamhankar999](http://twitter.com/stamhankar999), [@al3xandru](https://twitter.com/al3xandru)
17+
- Twitter: Follow the latest news about DataStax Drivers - [@stamhankar999](http://twitter.com/stamhankar999), [@avalanche123](http://twitter.com/avalanche123), [@al3xandru](https://twitter.com/al3xandru)
1618

1719
This driver is based on [the cql-rb gem](https://github.com/iconara/cql-rb) by [Theo Hultberg](https://github.com/iconara) and we added support for:
1820

19-
* [Asynchronous execution](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/asynchronous_io/)
20-
* One-off, [prepared](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/basics/prepared_statements/) and [batch statements](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/basics/batch_statements/)
21-
* Automatic peer discovery and cluster metadata with [support for change notifications](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/state_listeners/)
22-
* Various [load-balancing](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/load_balancing/), [retry](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/retry_policies/) and [reconnection](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/reconnection/) policies with [ability to write your own](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/load_balancing/implementing_a_policy/)
23-
* [SSL encryption](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/security/ssl_encryption/)
24-
* [Flexible and robust error handling](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/error_handling/)
25-
* [Per-request execution information and tracing](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/debugging/)
26-
* [Configurable address resolution](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/address_resolution/)
21+
* [Asynchronous execution](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/asynchronous_io/)
22+
* One-off, [prepared](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/basics/prepared_statements/) and [batch statements](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/basics/batch_statements/)
23+
* Automatic peer discovery and cluster metadata with [support for change notifications](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/state_listeners/)
24+
* Various [load-balancing](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/load_balancing/), [retry](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/retry_policies/) and [reconnection](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/reconnection/) policies with [ability to write your own](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/load_balancing/implementing_a_policy/)
25+
* [SSL encryption](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/security/ssl_encryption/)
26+
* [Flexible and robust error handling](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/error_handling/)
27+
* [Per-request execution information and tracing](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/debugging/)
28+
* [Configurable address resolution](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/address_resolution/)
2729

2830
[Check out the slides from Ruby Driver Explained](https://speakerdeck.com/avalanche123/ruby-driver-explained) for a detailed overview of the Ruby Driver architecture.
2931

@@ -36,10 +38,14 @@ This driver works exclusively with the Cassandra Query Language v3 (CQL3) and Ca
3638
* Ruby (MRI) 2.2, 2.3
3739
* JRuby 1.7
3840

39-
__Note__: JRuby 1.6 is not officially supported, although 1.6.8 should work. Similarly,
40-
MRI 2.0 and 2.1 are not officially supported, but they should work. 1.9.3 is deprecated
41+
__Note__: JRuby 1.6 is not officially supported, although 1.6.8 should work. Rubinius is not supported.
42+
MRI 2.0, 2.1, and JRuby 9k are not officially supported, but they should work. 1.9.3 is deprecated
4143
and is likely to break in the release following 3.0.
4244

45+
## Feedback Requested
46+
47+
*Help us focus our efforts!* [Provide your input](http://goo.gl/forms/pCs8PTpHLf) on the Ruby Driver Platform and Runtime Survey (we kept it short).
48+
4349
## Quick start
4450

4551
```ruby
@@ -51,10 +57,10 @@ cluster.each_host do |host| # automatically discovers all peers
5157
puts "Host #{host.ip}: id=#{host.id} datacenter=#{host.datacenter} rack=#{host.rack}"
5258
end
5359

54-
keyspace = 'system'
60+
keyspace = 'system_schema'
5561
session = cluster.connect(keyspace) # create session, optionally scoped to a keyspace, to execute queries
5662

57-
future = session.execute_async('SELECT keyspace_name, table_name FROM system_schema.tables') # fully asynchronous api
63+
future = session.execute_async('SELECT keyspace_name, table_name FROM tables') # fully asynchronous api
5864
future.on_success do |rows|
5965
rows.each do |row|
6066
puts "The keyspace #{row['keyspace_name']} has a table called #{row['table_name']}"
@@ -67,9 +73,9 @@ __Note__: The host you specify is just a seed node, the driver will automaticall
6773

6874
Read more:
6975

70-
* [`Cassandra.cluster` options](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/api/cassandra/#cluster-class_method)
71-
* [`Session#execute_async` options](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/api/cassandra/session/#execute_async-instance_method)
72-
* [Usage documentation](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features)
76+
* [`Cassandra.cluster` options](http://docs.datastax.com/en/developer/ruby-driver/3.0/api/cassandra/#cluster-class_method)
77+
* [`Session#execute_async` options](http://docs.datastax.com/en/developer/ruby-driver/3.0/api/cassandra/session/#execute_async-instance_method)
78+
* [Usage documentation](http://docs.datastax.com/en/developer/ruby-driver/3.0/features)
7379

7480
## Installation
7581

@@ -85,12 +91,15 @@ Install via Gemfile
8591
gem 'cassandra-driver'
8692
```
8793

88-
__Note__: if you want to use compression you should also install [snappy](http://rubygems.org/gems/snappy) or [lz4-ruby](http://rubygems.org/gems/lz4-ruby). [Read more about compression.](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/#compression)
94+
__Note__: if you want to use compression you should also install [snappy](http://rubygems.org/gems/snappy) or [lz4-ruby](http://rubygems.org/gems/lz4-ruby). [Read more about compression.](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/#compression)
8995

9096

9197
## Upgrading from cql-rb
9298

93-
Some of the new features added to the driver have unfortunately led to changes in the original cql-rb API. In the examples directory, you can find [an example of how to wrap the ruby driver to achieve almost complete interface parity with cql-rb](https://github.com/datastax/ruby-driver/blob/v3.0.3/examples/cql-rb-wrapper.rb) to assist you with gradual upgrade.
99+
Some of the new features added to the driver have unfortunately led to changes in the original cql-rb API.
100+
In the examples directory, you can find [an example of how to wrap the ruby driver to achieve almost complete
101+
interface parity with cql-rb](https://github.com/datastax/ruby-driver/blob/v3.0.3/examples/cql-rb-wrapper.rb)
102+
to assist you with gradual upgrade.
94103

95104
## What's new in v3.0
96105

@@ -150,10 +159,6 @@ batch.add(query, arguments: {p1: 'val1'})
150159
* [[RUBY-161](https://datastax-oss.atlassian.net/browse/RUBY-161)] Protocol version negotiation in mixed version clusters should not fall back to v1 unless it is truly warranted.
151160
* [[RUBY-214](https://datastax-oss.atlassian.net/browse/RUBY-214)] Ensure client timestamps have microsecond precision in JRuby. Previously, some row updates would get lost in high transaction environments.
152161

153-
## Feedback Requested
154-
155-
*Help us focus our efforts!* [Provide your input](http://goo.gl/forms/pCs8PTpHLf) on the Ruby Driver Platform and Runtime Survey (we kept it short).
156-
157162
## Code examples
158163

159164
The DataStax Ruby Driver uses the awesome [Cucumber Framework](http://cukes.info/) for
@@ -212,7 +217,7 @@ the release.
212217
* Because the driver reactor is using `IO.select`, the maximum number of tcp connections allowed is 1024.
213218
* Because the driver uses `IO#write_nonblock`, Windows is not supported.
214219

215-
Please [refer to the usage documentation for more information on common pitfalls](http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/features/)
220+
Please [refer to the usage documentation for more information on common pitfalls](http://docs.datastax.com/en/developer/ruby-driver/3.0/features/)
216221

217222
## Contributing
218223

@@ -226,7 +231,7 @@ that are common across all other DataStax drivers for Apache Cassandra.
226231

227232
The development effort to provide an up to date, high performance, fully featured Ruby
228233
Driver for Apache Cassandra will continue on this project, while
229-
[cql-rb](https://github.com/iconara/cql-rb/) will be discontinued.
234+
[cql-rb](https://github.com/iconara/cql-rb/) has been discontinued.
230235

231236
## Copyright
232237

@@ -242,4 +247,4 @@ License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
242247
either express or implied. See the License for the specific language governing permissions
243248
and limitations under the License.
244249

245-
[1]: http://docs.datastax.com/en/developer/ruby-driver/3.0/supplemental/api
250+
[1]: http://docs.datastax.com/en/developer/ruby-driver/3.0/api

features/debugging/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
# Debugging
1+
# Debugging
2+
3+
Execution info can be used to dig into details on how requests executed. If request tracing is enabled, the
4+
trace info will be available in the exection info.
5+
6+
In addition, configuring the logger for the cluster object will result in extra debug output emitted that can help
7+
track down issues.

features/load_balancing/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,3 @@ Here is a high level diagram of how a load balancing policy is used during query
2828
|<-----------------| | |
2929
| | |
3030
```
31-
32-
[Check out the Ruby Driver - Load Balancing Screencast](https://academy.datastax.com/demos/datastax-ruby-driver-load-balancing-policies) for a quick and in-depth guide to load balancing with the Ruby Driver.

features/state_listeners/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# State Listeners
1+
# State Listeners
2+
3+
You can define listeners for schema change events as well as cluster membership changes.

lib/cassandra/execution/options.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class Options
5454
#
5555
# @see https://github.com/apache/cassandra/blob/cassandra-3.4/doc/native_protocol_v4.spec#L125-L131 Description
5656
# of custom payload in Cassandra native protocol v4.
57-
# @see http://docs.datastax.com/en/developer/java-driver/3.0/supplemental/manual/custom_payloads/?local=true&nav=toc#enabling-custom-payloads-on-c-nodes
57+
# @see http://docs.datastax.com/en/developer/java-driver/3.0/manual/custom_payloads/#enabling-custom-payloads-on-c-nodes
5858
# Enabling custom payloads on Cassandra nodes.
5959
#
6060
# @example Sending a custom payload

0 commit comments

Comments
 (0)