cassie 1.0.0.beta.26 → 1.0.0.beta.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8c2696d4e1b2aa0bf26d50ba39d4b807084d5f6
-  data.tar.gz: f8b3d4e1d0d9e751beafe23020dfeb9801c7e3b4
+  metadata.gz: cc7caa19b667525c10964c15b1c8c0560280bbb7
+  data.tar.gz: 4c77f29fbdc4fff2693125498ebc00a9497218e7
 SHA512:
-  metadata.gz: 3c56721404043fef6ebe7b8ec7b6c9919fa6fad2649254758aef5c00dc9e5b4589c8f006ee053b60ab2830816a61b2411e701bc5d14ce65207006a4ff04b0209
-  data.tar.gz: 35a13f31e014a3907c5922663b7b8f4727942213c8c48eade9a11e616c328964e9e82908d57b45ff3fb8aa1c849b45d162a154886d4745e3287376931b2cf1f3
+  metadata.gz: 8d8b604b1c52dea54e403534c6d4244464ed22eee9791a432da16a19534c1929358c0f1b5de03fc86c5c3fc7f858f01f45f9a1370f52f4f8c7d06891e5069b79
+  data.tar.gz: 1f09cc8256cdd66eb76b827216008287b8cd9a524ab1349fe3a29b832aeeb1148f3fb3ba5da80ff0ded2abd1cea0ca3798569c8622a61e119dace401d17e97b6

data/lib/cassie/statements/README.md

@@ -88,7 +88,7 @@ Cassie provides 3 base classes for these 3 kinds of queries. Subclass `Cassie::D
     * `result` attribute, populated by execution
     * instrumentation and logging of execution
 
-  Typical use of a `Definition` subclass would be for a static DDL query. Override the `statement` method, returning a CQL statement (`String` or `Cassandra::Statements`) that will be executed with the `Cassandra` driver.
+  A typical use of a `Definition` subclass would be for a static DDL query. Override the `statement` method, returning a CQL statement (`String` or `Cassandra::Statements`) that will be executed with the `Cassandra` driver.
 
 ##### `Cassie::Modification`
   Includes core functionality for prepared statement execution.
@@ -280,9 +280,11 @@ set :id, term: "now()"
 ```
 
 ```ruby
-insert_into :posts
+update :post_counts
+
+set :comments_count, "comments_count + 1"
 
-set :published_at, "toTimestamp(now())"
+non_idempotent
 ```
 
 A value will be fetched and placed as an argument in the statement if the provided term includes a positional marker ('?').
@@ -351,80 +353,6 @@ Arbitrary strings are supported as well in case the DSL gets in the way.
 #=> SELECT cowboy, coder FROM posts_by_author;
 ```
 
-#### Consistency configuration
-
-The [consistency level](http://datastax.github.io/ruby-driver/v2.1.6/api/cassandra/#consistencies-constant) for a query is determined by your `Cassie::configuration` by default, falling to back to the `Cassandra` default if none is given.
-
-```ruby
-Cassie.configuration[:consistency]
-#=> nil
-
-Cassie.cluster.instance_variable_get(:@execution_options).consistency
-#=> :one
-```
-
-Cassie queries allow for a consistency level to be defined on the object, subclass, base class, and global levels. If none is found, it will default to the `cluster` default when the query is executed.
-
-Object writer:
-```ruby
-  query = MyQuery.new
-  query.consistency = :all
-  query.execute
-```
-Override Object reader:
-```ruby
-  select_from :posts_by_author_category
-
-  where :author_id, :eq
-  where :category, :eq, if: :filter_by_category?
-
-  def filter_by_category?
-    #true or false, as makes sense for your query
-  end
-
-  def consistency
-    #dynamically determine a query object's consistency level
-    if filter_by_category?
-      :quorum
-    else
-      super
-    end
-  end
-```
-
-Class writer
-```ruby
-  select_from :posts_by_author_category
-
-  where :author_id, :eq
-  where :category, :eq
-
-  consistency :quorum
-```
-
-Cassie query classes
-```ruby
-# lib/tasks/interesting_task.rake
-require_relative "interesting_worker"
-
-task :interesting_task do
-  Cassie::Modification.consistency = :all
-
-  InterestingWorker.new.perform
-end
-```
-
-Cassie global default
-```ruby
-# lib/tasks/interesting_task.rake
-require_relative "interesting_worker"
-
-task :interesting_task do
-  Cassie::Statements.default_consistency = :all
-
-  InterestingWorker.new.perform
-end
-```
 
 #### Execution and Result
 
@@ -698,6 +626,123 @@ By default, this works for ascending and descending orderings when paging in the
 
 Custom policies can be defined by setting `Query.partition_linker` for more complex schemas. See the `SimplePolicy` source for an example.
 
+#### Consistency configuration
+
+The [consistency level](http://datastax.github.io/ruby-driver/api/cassandra/#consistencies-constant) for a query is determined by your `Cassie::configuration` by default, falling to back to the `Cassandra` default if none is given.
+
+```ruby
+Cassie.configuration[:consistency]
+#=> nil
+
+Cassie.cluster.instance_variable_get(:@execution_options).consistency
+#=> :one
+```
+
+Cassie queries allow for a consistency level to be defined on the object, subclass, base class, and global levels. If none is found, it will default to the `cluster` default when the query is executed.
+
+Object writer:
+```ruby
+  query = MyQuery.new
+  query.consistency = :all
+  query.execute
+```
+Override Object reader:
+```ruby
+  select_from :posts_by_author_category
+
+  where :author_id, :eq
+  where :category, :eq, if: :filter_by_category?
+
+  def filter_by_category?
+    #true or false, as makes sense for your query
+  end
+
+  def consistency
+    #dynamically determine a query object's consistency level
+    if filter_by_category?
+      :quorum
+    else
+      super
+    end
+  end
+```
+
+Class writer
+```ruby
+  select_from :posts_by_author_category
+
+  where :author_id, :eq
+  where :category, :eq
+
+  consistency :quorum
+```
+
+Cassie query classes
+```ruby
+# lib/tasks/interesting_task.rake
+require_relative "interesting_worker"
+
+task :interesting_task do
+  Cassie::Modification.consistency = :all
+
+  InterestingWorker.new.perform
+end
+```
+
+Cassie global default
+```ruby
+# lib/tasks/interesting_task.rake
+require_relative "interesting_worker"
+
+task :interesting_task do
+  Cassie::Statements.default_consistency = :all
+
+  InterestingWorker.new.perform
+end
+```
+
+#### Idempotentcy configuration
+
+Cassie statements are set as [idempotent](http://datastax.github.io/ruby-driver/api/cassandra/statements/simple/) by default. This setting influences how [retries](http://datastax.github.io/ruby-driver/features/retry_policies/) are handled.
+
+Mark queries that are not idempotent, so that the driver won't automatically retry for certain failure scenarios.
+
+Similar to other settings, there is a `Cassie::Statements.default_idempotency`, class level setting, and object level setting.
+
+```ruby
+class MyQuery < Cassie::Modification
+  update :counter_table
+
+  set :counter, term: :counter_val
+
+  def counter_val
+    "counter + 1"
+  end
+end
+```
+```
+MyQuery.idempotent?
+# => true
+```
+
+```ruby
+class MyQuery < Cassie::Modification
+  update :counter_table
+
+  set :counter, term: :counter_val
+
+  non_idempotent
+
+  def counter_val
+    "counter + 1"
+  end
+end
+```
+```
+MyQuery.idempotent?
+# => false
+```
+
 #### Prepared statements
 
 A `Cassie::Query` will use prepared statements by default, cacheing prepared statements across all `Query`, `Modification`, and `Definition` objects, keyed by the unbound CQL string.
@@ -728,6 +773,26 @@ set_1 = query.fetch([1, 2, 3])
 set_2 = query.fetch([7, 8, 9, 10, 11, 12])
 ```
 
+#### Custom queries
+
+For certain queries, it may be more effective to write your own CQL. The recommended way is to override `cql` and `params`.
+
+```ruby
+class MySpecialQuery < Cassandra::Modification
+  map_from :resource
+
+  def cql
+    "UPDATE my_table SET udt.field = ? WHERE id = ?;"
+  end
+
+  def params
+    [field, id]
+  end
+end
+```
+
+This will preserve using other features such as consistency, idempotency, prepared statements, etc.
+
 #### Non-positional (unbound) statements
 
 Cassie Query features are built around using bound statements with positional arguments. However, overriding `#statement`, returning something that a `Cassandra::Session` can execute, will result in an unbound, unprepared statement.

data/lib/cassie/statements/statement.rb

@@ -48,16 +48,16 @@ module Cassie::Statements
         statement.to_s
       end
     end
-    
+
     def logger
       Cassie::Statements.logger
     end
-    
+
     def cql
       return @cql if defined?(@cql)
       ""
     end
-    
+
     def params
       return @params if defined?(@params)
       nil
@@ -69,6 +69,7 @@ module Cassie::Statements
       if self.class.type
         send "build_#{self.class.type}_cql_and_params"
       end
+
       [cql, params]
     end
 

data/lib/cassie/statements/statement/idempotency.rb

@@ -1,7 +1,7 @@
 module Cassie::Statements
   def self.default_idempotency
     return @default_idempotency if defined?(@default_idempotency)
-    false
+    true
   end
 
   def self.default_idempotency=(val)
@@ -34,7 +34,11 @@ module Cassie::Statements
           self.idempotent = val
         end
       end
-      
+
+      def non_idempotent
+        self.idempotent = false
+      end
+
       def idempotent?
         !!idempotent
       end
@@ -44,7 +48,7 @@ module Cassie::Statements
       return @idempotent if defined?(@idempotent)
       self.class.idempotent
     end
-    
+
     def idempotent?
       !!idempotent
     end

data/lib/cassie/version.rb

@@ -1,3 +1,3 @@
 module Cassie
-  VERSION = "1.0.0.beta.26"
+  VERSION = "1.0.0.beta.27"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.26
+  version: 1.0.0.beta.27
 platform: ruby
 authors:
 - Evan Prothro