Merge branch 'master' into 3.0.1

Author: stamhankar999

CHANGELOG.md

@@ -1,19 +1,40 @@
 # master
 Features:
+
+Bug Fixes:
+
+
+# 3.0.0 GA
+Features:
+* Increased default request timeout (the `timeout` option to `Cassandra.cluster`), from 10 seconds to 12 seconds 
+  because C* defaults to a 10 second timeout internally. The extra two seconds is buffer so that the client can
+  report the timeout in the server. This is also consistent with the Java driver.
+* Expand :client_timestamps cluster configuration option to allow user to specify his own generator for client timestamps.
+
+Bug Fixes:
+* [RUBY-207](https://datastax-oss.atlassian.net/browse/RUBY-207) Get NoMethodError when handling a write-timeout error using a downgrading consistency retry policy.
+* [RUBY-214](https://datastax-oss.atlassian.net/browse/RUBY-214) Client timestamps in JRuby are not fine-grained enough, causing timestamp collisions and lost rows in C*.
+
+Breaking Changes:
+* The Datacenter-aware load balancing policy (Cassandra::LoadBalancing::Policies::DCAwareRoundRobin) defaults to using
+  nodes in the local DC only. In prior releases, the policy would fall back to remote nodes after exhausting local nodes.
+  Specify a positive value (or nil for unlimited) for `max_remote_hosts_to_use` when initializing the policy to allow remote node use. 
+
+# 3.0.0 rc2
+Features:
 * Add protocol_version configuration option to allow the user to force the protocol version to use for communication with nodes.
 * Expose listen_address and broadcast_address in `Cassandra::Host` if available.
 * Add support for materialized views in the schema metadata.
 * Add support for Cassandra indexes in the schema metadata.
 * Add or expose the id, options, keyspace, partition_key, clustering_columns, and clustering_order attributes to table and view schema objects.
 * Add crc_check_chance and extensions attributes to ColumnContainer options.
+* Make cluster configuration options list publicly available. (Thanks, Evan Prothro!)
 
 Bug Fixes:
-* [RUBY-161] Protocol version negotiation in mixed version clusters should not fall back to v1 unless it is truly warranted.    
-* [RUBY-180] Column ordering is not deterministic in Table metadata.
-* [RUBY-185] Internal columns in static-compact and dense tables should be ignored.
-* [RUBY-186] Custom type column metadata should be parsed properly for C* 3.x schemas. 
-
-Breaking Changes:
+* [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.    
+* [RUBY-180](https://datastax-oss.atlassian.net/browse/RUBY-180) Column ordering is not deterministic in Table metadata.
+* [RUBY-185](https://datastax-oss.atlassian.net/browse/RUBY-185) Internal columns in static-compact and dense tables should be ignored.
+* [RUBY-186](https://datastax-oss.atlassian.net/browse/RUBY-186) Custom type column metadata should be parsed properly for C* 3.x schemas. 
 
 # 3.0.0 rc1
 
@@ -22,9 +43,9 @@ Features:
 * Add Cassandra::Logger class to make it easy for users to enable debug logging in the client.
 
 Bug Fixes:
-* [RUBY-154] Improve batch request performance, which had regressed in 3.0.0 beta1.
-* [RUBY-155] Request timeout timer should not include request queuing time.
-* [RUBY-156] Do not drop response frames that follow a frame containing a warning.
+* [RUBY-154](https://datastax-oss.atlassian.net/browse/RUBY-154) Improve batch request performance, which had regressed in 3.0.0 beta1.
+* [RUBY-155](https://datastax-oss.atlassian.net/browse/RUBY-155) Request timeout timer should not include request queuing time.
+* [RUBY-156](https://datastax-oss.atlassian.net/browse/RUBY-156) Do not drop response frames that follow a frame containing a warning.
 
 # 3.0.0 beta1
 
@@ -44,10 +65,10 @@ Features:
 
 Bug Fixes:
 
-* [RUBY-143] Retry querying system table for metadata of new hosts when prior attempts fail, ultimately enabling use of new hosts.
-* [RUBY-150] Fixed a protocol decoding error that occurred when multiple messages are available in a stream.
-* [RUBY-151] Decode incomplete UDTs properly.
-* [RUBY-120] Tuples and UDTs can be used in sets and hash keys.
+* [RUBY-143](https://datastax-oss.atlassian.net/browse/RUBY-143) Retry querying system table for metadata of new hosts when prior attempts fail, ultimately enabling use of new hosts.
+* [RUBY-150](https://datastax-oss.atlassian.net/browse/RUBY-150) Fixed a protocol decoding error that occurred when multiple messages are available in a stream.
+* [RUBY-151](https://datastax-oss.atlassian.net/browse/RUBY-151) Decode incomplete UDTs properly.
+* [RUBY-120](https://datastax-oss.atlassian.net/browse/RUBY-120) Tuples and UDTs can be used in sets and hash keys.
 
 Breaking Changes:
 
@@ -57,6 +78,12 @@ Breaking Changes:
 * Unavailable errors are retried on the next host in the load balancing plan by default.
 * Statement execution no longer retried on timeouts, unless `:idempotent => true` has been specified when executing.
 
+# 2.1.6
+Bug Fixes:
+
+* [RUBY-202](https://datastax-oss.atlassian.net/browse/RUBY-202) Allow password authenticator to be used for LDAP authentication. This is actually a backport of
+     RUBY-169 for the 3.0.0 release.
+
 # 2.1.5
 
 Features:
@@ -65,25 +92,25 @@ Features:
 
 Bug Fixes:
 
-* [RUBY-128] Fix decoding of large values in maps, sets and lists.
+* [RUBY-128](https://datastax-oss.atlassian.net/browse/RUBY-128) Fix decoding of large values in maps, sets and lists.
 
 # 2.1.4
 
 Features:
 
-* [RUBY-119] Use `require 'datastax/cassandra'` to avoid namespace conflicts
-* [RUBY-90] Add support for disabling nagle algorithm (tcp nodelay), enabled by default.
-* [RUBY-70] Add support for client-side timestamps, disabled by default.
-* [RUBY-114] Add support for serial consistency in batch requests.
+* [RUBY-119](https://datastax-oss.atlassian.net/browse/RUBY-119) Use `require 'datastax/cassandra'` to avoid namespace conflicts
+* [RUBY-90](https://datastax-oss.atlassian.net/browse/RUBY-90) Add support for disabling nagle algorithm (tcp nodelay), enabled by default.
+* [RUBY-70](https://datastax-oss.atlassian.net/browse/RUBY-70) Add support for client-side timestamps, disabled by default.
+* [RUBY-114](https://datastax-oss.atlassian.net/browse/RUBY-114) Add support for serial consistency in batch requests.
 
 Bug Fixes:
 
-* [RUBY-103] Don't regenerate schema metadata for the same replication
+* [RUBY-103](https://datastax-oss.atlassian.net/browse/RUBY-103) Don't regenerate schema metadata for the same replication
   strategies and options
-* [RUBY-102] Allow custom types in schema metadata
-* [RUBY-97] Allow disabling of the initial population of schema metadata
-* [RUBY-95] Speed up generation of large token maps
-* [RUBY-116] fix thread leak on connection error
+* [RUBY-102](https://datastax-oss.atlassian.net/browse/RUBY-102) Allow custom types in schema metadata
+* [RUBY-97](https://datastax-oss.atlassian.net/browse/RUBY-97) Allow disabling of the initial population of schema metadata
+* [RUBY-95](https://datastax-oss.atlassian.net/browse/RUBY-95) Speed up generation of large token maps
+* [RUBY-116](https://datastax-oss.atlassian.net/browse/RUBY-116) fix thread leak on connection error
 
 Breaking Changes:
 
@@ -102,7 +129,7 @@ Release removing accidental debug code from 2.1.1.
 
 Bug Fixes:
 
-* [RUBY-98] Use of undefined class variable in `Table#create_partition_key`
+* [RUBY-98](https://datastax-oss.atlassian.net/browse/RUBY-98) Use of undefined class variable in `Table#create_partition_key`
 
 # 2.1.0
 
@@ -120,13 +147,13 @@ Breaking Changes:
 
 Bug Fixes:
 
-* [RUBY-93] Reconnection can overflow the stack
+* [RUBY-93](https://datastax-oss.atlassian.net/browse/RUBY-93) Reconnection can overflow the stack
 
 # 2.0.1
 
 Bug Fixes:
 
-* [RUBY-87] Decoder corrupts incomplete response buffer
+* [RUBY-87](https://datastax-oss.atlassian.net/browse/RUBY-87) Decoder corrupts incomplete response buffer
 
 # 2.0.0
 

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cassandra-driver (3.0.1)
+    cassandra-driver (3.0.1.beta.1)
       ione (~> 1.2)
 
 GEM

README.md

@@ -1,6 +1,6 @@
 # Datastax Ruby Driver for Apache Cassandra
 
-*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 latest version through ruby driver docs](http://datastax.github.io/ruby-driver/) or via the release tags, [e.g. v1.0.0-beta.3](https://github.com/datastax/ruby-driver/tree/v1.0.0-beta.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 latest version through ruby driver docs](http://datastax.github.io/ruby-driver/) or via the release tags, [e.g. v3.0.0](https://github.com/datastax/ruby-driver/tree/v3.0.0).*
 
 [![Build Status](https://travis-ci.org/datastax/ruby-driver.svg?branch=master)](https://travis-ci.org/datastax/ruby-driver)
 
@@ -31,8 +31,8 @@ This driver is based on [the cql-rb gem](https://github.com/iconara/cql-rb) by [
 
 This driver works exclusively with the Cassandra Query Language v3 (CQL3) and Cassandra's native protocol. The current version works with:
 
-* Apache Cassandra versions 1.2, 2.0, 2.1, and 3.x
-* DataStax Enterprise 4.0, 4.5, 4.6, 4.7, and 4.8
+* Apache Cassandra versions 1.2, 2.0, 2.1, 2.2, and 3.x
+* DataStax Enterprise 4.0 and above.
 * Ruby (MRI) 2.2, 2.3
 * JRuby 1.7
 
@@ -96,28 +96,33 @@ Some of the new features added to the driver have unfortunately led to changes i
 
 ### Features:
 
-* Apache Cassandra native protocol v4
-* Add support for smallint, tinyint, date (Cassandra::Date) and time (Cassandra::Time) data types.
+* Add support for Apache Cassandra native protocol v4
+* Add support for smallint, tinyint, date (`Cassandra::Date`) and time (`Cassandra::Time`) data types.
 * Include schema metadata for User Defined Functions and User Defined Aggregates.
+* Augment the `Cassandra::Table` object to expose many more attributes: `id`, `options`, `keyspace`, `partition_key`, `clustering_columns`, and `clustering_order`. This makes it significantly easier to write administration scripts that report various attributes of your schema, which may help to highlight areas for improvement.
 * Include client ip addresses in request traces, only on Cassandra 3.x.
-* Add new retry policy decision Cassandra::Retry::Policy#try_next_host.
-* Support specifying statement idempotence with the new :idempotent option when executing.
-* Support sending custom payloads when preparing or executing statements using the new :payload option.
-* Expose custom payloads received with responses on server exceptions and Cassandra::Execution::Info instances.
-* Expose server warnings on server exceptions and Cassandra::Execution::Info instances.
-* Add connections_per_local_node, connections_per_remote_node, requests_per_connection cluster configuration options to tune parallel query execution and resource usage.
-* Add Cassandra::Logger class to make it easy for users to enable debug logging in the client.
-* Add protocol_version configuration option to allow the user to force the protocol version to use for communication with nodes.
-* Add support for materialized views in the schema metadata.
-
-### Breaking Changes:
-
-* Cassandra::Future#join is now an alias to Cassandra::Future#get and will raise an error if the future is resolved with one.
+* Add new retry policy decision `Cassandra::Retry::Policy#try_next_host`.
+* Support specifying statement idempotence with the new `idempotent` option when executing.
+* Support sending custom payloads when preparing or executing statements using the new `payload` option.
+* Expose custom payloads received with responses on server exceptions and `Cassandra::Execution::Info` instances.
+* Expose server warnings on server exceptions and `Cassandra::Execution::Info` instances.
+* Add `connections_per_local_node`, `connections_per_remote_node`, `requests_per_connection` cluster configuration options to tune parallel query execution and resource usage.
+* Add `Cassandra::Logger` class to make it easy for users to enable debug logging in the client.
+* Add `protocol_version` configuration option to allow the user to force the protocol version to use for communication with nodes.
+* Add support for materialized views and indexes in the schema metadata.
+* Support the `ReadError`, `WriteError`, and `FunctionCallError` Cassandra error responses introduced in Cassandra 2.2.
+* Add support for unset variables in bound statements.
+* Support DSE security (`DseAuthenticator`, configured for LDAP).
+* Add a timeout option to `Cassandra::Future#get`.
+
+### Breaking Changes from 2.x:
+
+* `Cassandra::Future#join` is now an alias to Cassandra::Future#get and will raise an error if the future is resolved with one.
 * Default consistency level is now LOCAL_ONE.
 * Enable tcp no-delay by default.
 * Unavailable errors are retried on the next host in the load balancing plan by default.
-* Statement execution no longer retried on timeouts, unless :idempotent => true has been specified when executing.
-* Cassandra::Statements::Batch#add signature has changed in how one specifies query parameters. Specify the query parameters array as the value of the arguments key:
+* Statement execution no longer retried on timeouts, unless the statement is marked as idempotent in the call to `Cassandra::Session#execute*` or when creating a `Cassandra::Statement` object. 
+* `Cassandra::Statements::Batch#add` and `Cassandra::Session#execute*` signatures have changed in how one specifies query parameters. Specify the query parameters array as the value of the arguments key:
 
 ```ruby
 batch.add(query, ['val1', 'val2'])
@@ -128,19 +133,24 @@ batch.add(query, {p1: 'val1'})
 # becomes
 batch.add(query, arguments: {p1: 'val1'})
 ```
+* The Datacenter-aware load balancing policy (`Cassandra::LoadBalancing::Policies::DCAwareRoundRobin`) defaults to using
+  nodes in the local DC only. In prior releases, the policy would fall back to remote nodes after exhausting local nodes.
+  Specify a positive value (or nil for unlimited) for `max_remote_hosts_to_use` when initializing the policy to allow remote node use.
+* Unspecified variables in statements previously resulted in an exception. Now they are essentially ignored or treated as null.
 
 ### Bug Fixes:
 
 * [[RUBY-120](https://datastax-oss.atlassian.net/browse/RUBY-120)] Tuples and UDTs can be used in sets and hash keys.
 * [[RUBY-143](https://datastax-oss.atlassian.net/browse/RUBY-143)] Retry querying system table for metadata of new hosts when prior attempts fail, ultimately enabling use of new hosts.
 * [[RUBY-150](https://datastax-oss.atlassian.net/browse/RUBY-150)] Fixed a protocol decoding error that occurred when multiple messages are available in a stream.
 * [[RUBY-151](https://datastax-oss.atlassian.net/browse/RUBY-151)] Decode incomplete UDTs properly.
-* [[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.    
+* [[RUBY-155](https://datastax-oss.atlassian.net/browse/RUBY-155)] Request timeout timer should not include request queuing time.
+* [[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.
+* [[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.
 
 ## Feedback Requested
 
-*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).
+*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).
 
 ## Code examples
 

Rakefile

@@ -35,7 +35,8 @@ Rake::TestTask.new(:integration => :compile) do |t|
                   'integration/security/*_test.rb',
                   'integration/load_balancing/*_test.rb',
                   'integration/types/*_test.rb',
-                  'integration/functions/*_test.rb']
+                  'integration/functions/*_test.rb',
+                  'integration/indexes/*_test.rb']
   t.verbose = true
 end
 

docs.yaml

@@ -37,12 +37,10 @@ links:
   - title: Releases
     href:  https://github.com/datastax/ruby-driver/releases
 versions:
-  - name: v3.0.0.rc.1
-    ref:  c8ed32ce85b608f172e72133dd68c3e2af34db00
-  - name: v3.0.0.beta.1
-    ref:  a0a5f7a5cc308497e5e865f008130441722208e5
-  - name: v2.1.5
-    ref:  bbb7084d11be701ff42f298373c0255b9a3e2b7f
+  - name: v3.0.0
+    ref:  0ef47aaac0253c2cdd23ab487b3a66789416f1cb
+  - name: v2.1.6
+    ref:  474568501e5ef771a496c3a901f3cbdc3854f512
   - name: v2.0.1
     ref:  80cab0ad188511ec16eb39111c0b67329c754729
   - name: v1.2.0

features/basics/client_side_timestamps.feature

@@ -23,7 +23,15 @@ Feature: Client-side Timestamps
       require 'cassandra'
       require 'delorean'
 
-      cluster = Cassandra.cluster(client_timestamps: true)
+      # Enable client-side timestamps. Valid values:
+      # nil / false : don't enable client-side timestamps. This is the default.
+      # true : enable client-side timestamps and use the default timestamp generator for the Ruby flavor being used:
+      #     JRuby - Cassandra::TimestampGenerator::TickingOnDuplicate
+      #     MRI/Rubinius - Cassandra::TimestampGenerator::Simple
+      # :simple : enable client-side timestamps and use a Cassandra::TimestampGenerator::Simple generator.
+      # :monotonic : enable client-side timestamps and use a Cassandra::TimestampGenerator::TickingOnDuplicate generator.
+
+      cluster = Cassandra.cluster(client_timestamps: :simple)
       session = cluster.connect("simplex")
 
       # Insert in the present

features/basics/schema_metadata.feature

@@ -71,7 +71,7 @@ Feature: Schema Metadata
       Clustering order: asc
       Num columns: 4
 
-      CREATE TABLE simplex.users (
+      CREATE TABLE simplex."users" (
         user_id bigint,
         last text,
         age int,