Skip to content

Commit

Permalink
[ci skip] update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bulat Shakirzyanov committed Feb 23, 2015
1 parent bdff15c commit 4821258
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This driver works exclusively with the Cassandra Query Language v3 (CQL3) and Ca

* Apache Cassandra versions 1.2, 2.0 and 2.1
* DataStax Enterprise 3.1, 3.2, 4.0 and 4.5
* Ruby (MRI) 1.9.3, 2.0 and 2.1
* Ruby (MRI) 1.9.3, 2.0, 2.1 and 2.2
* JRuby 1.7
* Rubinius 2.2

Expand Down Expand Up @@ -96,15 +96,19 @@ Some of the new features added to the driver have unfortunately led to changes i
Features:

* Apache Cassandra native protocol v3
* User-defined types and tuples
* Schema metadata includes user-defined types
* Named arguments
* Public types api for type definition and introspection
* [User-defined types](http://datastax.github.io/ruby-driver/features/basics/user_defined_types/) and [tuples](http://datastax.github.io/ruby-driver/features/basics/datatypes/#using-tuples)
* [Schema metadata includes user-defined types](http://datastax.github.io/ruby-driver/api/keyspace/#type-instance_method)
* [Named arguments](http://datastax.github.io/ruby-driver/features/basics/prepared_statements/#an-insert-statement-is-prepared-with-named-parameters)
* [Public types api for type definition and introspection](http://datastax.github.io/ruby-driver/api/types/)

Breaking Changes:

* Splat style positional arguments support, deprecated in 2.0.0, has been dropped

Bug Fixes:

* [[RUBY-93](https://datastax-oss.atlassian.net/browse/RUBY-93)] Reconnection can overflow the stack

## Code examples

The DataStax Ruby Driver uses the awesome [Cucumber Framework](http://cukes.info/) for both end-to-end, or acceptance, testing and constructing documentation. All of the features supported by the driver have appropriate acceptance tests with easy-to-copy code examples in the `features/` directory.
Expand Down
2 changes: 2 additions & 0 deletions lib/cassandra/statements/prepared.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

module Cassandra
module Statements
# A prepared statement is created by calling {Cassandra::Session#prepare}
# or {Cassandra::Session#prepare_async}.
class Prepared
include Statement

Expand Down
3 changes: 3 additions & 0 deletions lib/cassandra/statements/simple.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ class Simple
# @note Positional arguments for simple statements are only supported
# starting with Apache Cassandra 2.0 and above.
#
# @note Named arguments for simple statements are only supported
# starting with Apache Cassandra 2.1 and above.
#
# @raise [ArgumentError] if cql statement given is not a String
def initialize(cql, params = nil)
Util.assert_instance_of(::String, cql) { "cql must be a string, #{cql.inspect} given" }
Expand Down
2 changes: 2 additions & 0 deletions lib/cassandra/table.rb
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,7 @@ def create_partition_key(values)

private

# @private
def type_to_cql(type, is_frozen)
case type.kind
when :tuple
Expand All @@ -318,6 +319,7 @@ def type_to_cql(type, is_frozen)
end
end

# @private
NULL_BYTE = "\x00".freeze

attr_reader :partition_key, :clustering_columns, :clustering_order
Expand Down
1 change: 1 addition & 0 deletions lib/cassandra/types.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1150,6 +1150,7 @@ def to_cql

private

# @private
def type_to_cql(type)
case type.kind
when :tuple
Expand Down

0 comments on commit 4821258

Please sign in to comment.