cassanity 0.3.0 → 0.4.0

data/Changelog.md

@@ -2,6 +2,16 @@
 
 Not all changes will be here, but the important ones will be for sure.
 
+## 0.4.0
+
+* Added Cassanity::Client to make setup easier ([pull request](https://github.com/jnunemaker/cassanity/pull/8))
+* Added easy instrumenting of CQL calls and a log subscriber ([pull request](https://github.com/jnunemaker/cassanity/pull/9))
+* Added prettier inspecting of all the things
+* Added #batch to Keyspace and ColumnFamily [commit](https://github.com/jnunemaker/cassanity/commit/1a6393b)
+* Allow setting default keyspace and column family names when performing a batch
+* Added Cassanity::Range and Cassanity.range shortcuts for range queries. [commit](5834d9e)
+* Allow passing hash as schema instead of forcing Cassanity::Schema instance
+
 ## 0.3.0
 
 * Changed [update counter value API](https://github.com/jnunemaker/cassanity/commit/a0f5a76)

data/Gemfile

@@ -3,9 +3,11 @@ gemspec
 
 gem 'rake'
 gem 'rspec', '~> 2.8'
+gem 'activesupport', :require => false
 
 group(:guard) do
-  gem 'guard',          '~> 1.0.0'
-  gem 'guard-rspec',    '~> 0.6.0'
-  gem 'guard-bundler',  '~> 0.1.0'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
 end

data/README.md

@@ -21,25 +21,16 @@ Or install it yourself as:
 ```ruby
 require 'cassanity'
 
-# cassandra-cql connection
-client = CassandraCQL::Database.new('127.0.0.1:9160', {
-  cql_version: '3.0.0',
-})
-
-# what is going to execute the cql queries?
-executor = Cassanity::Executors::CassandraCql.new({
-  client: client,
-})
-
-# setup connection with something that can execute queries
-connection = Cassanity::Connection.new({
-  executor: executor,
-})
+# client does the heavy lifting of setting up a cassandra cql database instance,
+# a cassanity executor for that database, and a cassanity connection
+client = Cassanity::Client.new
 
 # get keyspace instance
-keyspace = connection[:my_app]
+keyspace = client[:my_app]
 
 # tell client to use keyspace for future queries
+# this is optional as cassanity always sends the keyspace and column family name
+# whenever they are needed
 keyspace.use
 
 # schema for apps column family
@@ -61,6 +52,22 @@ apps = keyspace.column_family({
   schema: apps_schema,
 })
 
+# you can also just pass a hash for the schema
+apps = keyspace.column_family({
+  name: :apps,
+  schema: {
+    primary_key: :id,
+    columns: {
+      id: :text,
+      name: :text,
+      created_at: :timestamp,
+    },
+    with: {
+      comment: 'For storing apps',
+    }
+  },
+})
+
 # create column family based on name and schema
 apps.create
 

data/examples/_shared.rb

@@ -2,8 +2,12 @@
 # Sets up load path for examples and requires some stuff
 require 'pp'
 require 'pathname'
-require 'logger'
 
 root_path = Pathname(__FILE__).dirname.join('..').expand_path
 lib_path  = root_path.join('lib')
 $:.unshift(lib_path)
+
+require 'logger'
+require 'cassanity/instrumentation/log_subscriber'
+
+Cassanity::Instrumentation::LogSubscriber.logger = Logger.new(STDOUT, Logger::DEBUG)

data/examples/batch.rb

@@ -1,40 +1,34 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160', {
-  cql_version: '3.0.0',
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
 })
 
-executor = Cassanity::Executors::CassandraCql.new(client: client)
-
-connection = Cassanity::Connection.new(executor: executor)
-keyspace = connection['cassanity_examples']
+keyspace = client['cassanity_examples']
 keyspace.recreate
 
 # setting up the apps column family
-apps_schema = Cassanity::Schema.new({
-  primary_key: :id,
-  columns: {
-    id: :text,
-    name: :text,
+apps = keyspace.column_family('apps', {
+  schema: {
+    primary_key: :id,
+    columns: {
+      id: :text,
+      name: :text,
+    },
   },
 })
-apps = keyspace.column_family('apps', schema: apps_schema)
 apps.create
 
-# passing in keyspace and column family names by default
-default_arguments = {
-  keyspace_name: keyspace.name,
-  name: apps.name,
-}
-
 # batch several operations in one network call
-connection.batch({
+client.batch({
+  keyspace_name: keyspace.name,
+  column_family_name: apps.name,
   modifications: [
-    [:insert, default_arguments.merge(data: {id: '1', name: 'github'})],
-    [:insert, default_arguments.merge(data: {id: '2', name: 'gist'})],
-    [:update, default_arguments.merge(set: {name: 'github.com'}, where: {id: '1'})],
-    [:delete, default_arguments.merge(where: {id: '2'})],
+    [:insert, data: {id: '1', name: 'github'}],
+    [:insert, data: {id: '2', name: 'gist'}],
+    [:update, set: {name: 'github.com'}, where: {id: '1'}],
+    [:delete, where: {id: '2'}],
   ],
 })
 

data/examples/column_families.rb

@@ -1,26 +1,24 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160', {
-  cql_version: '3.0.0',
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
 })
-executor = Cassanity::Executors::CassandraCql.new(client: client)
 
-connection = Cassanity::Connection.new(executor: executor)
-keyspace = connection['cassanity_examples']
+keyspace = client['cassanity_examples']
 keyspace.recreate
 
-apps_schema = Cassanity::Schema.new({
-  primary_key: :id,
-  columns: {
-    id: :text,
-    name: :text,
+# get an instance of a column family, providing schema means it can create itself
+apps = keyspace.column_family('apps', {
+  schema: {
+    primary_key: :id,
+    columns: {
+      id: :text,
+      name: :text,
+    },
   },
 })
 
-# get an instance of a column family, providing schema means it can create itself
-apps = keyspace.column_family('apps', schema: apps_schema)
-
 # create column family based on schema
 apps.create
 
@@ -65,5 +63,6 @@ begin
 
 # All errors inherit from Cassanity::Error so you can catch everything easily
 rescue Cassanity::Error => e
+  puts "\n\nError should be raised here."
   puts e.inspect
 end

data/examples/counters.rb

@@ -1,31 +1,23 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160', {
-  cql_version: '3.0.0',
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
 })
 
-executor = Cassanity::Executors::CassandraCql.new({
-  client: client,
-  logger: Logger.new(STDOUT),
-})
-
-connection = Cassanity::Connection.new(executor: executor)
-keyspace = connection['cassanity_examples']
+keyspace = client['cassanity_examples']
 keyspace.recreate
 
-rollups_schema = Cassanity::Schema.new({
-  primary_key: :id,
-  columns: {
-    id: :text,
-    value: :counter,
-  },
-})
-
 # get an instance of a column family, providing schema means it can create itself
 rollups = keyspace.column_family({
   name: :rollups,
-  schema: rollups_schema,
+  schema: {
+    primary_key: :id,
+    columns: {
+      id: :text,
+      value: :counter,
+    },
+  },
 })
 
 # create column family based on schema

data/examples/keyspaces.rb

@@ -1,23 +1,20 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160', {
-  cql_version: '3.0.0',
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
 })
-executor = Cassanity::Executors::CassandraCql.new(client: client)
-
-connection = Cassanity::Connection.new(executor: executor)
 
 # gets instance of keyspace
-keyspace = connection['cassanity_examples']
+keyspace = client['cassanity_examples']
 
 # or you can do this...
-keyspace = connection.keyspace('cassanity_examples')
+keyspace = client.keyspace('cassanity_examples')
 
 pp keyspace
 
 # you can also provide options
-keyspace = connection.keyspace('cassanity_examples', {
+keyspace = client.keyspace('cassanity_examples', {
   strategy_class: 'SimpleStrategy',
   strategy_options: {
     replication_factor: 1,
@@ -37,16 +34,14 @@ keyspace.use
 apps = keyspace.column_family('apps')
 
 # you can also pass a schema so the column family is all knowing
-apps_schema = Cassanity::Schema.new({
-  primary_key: :id,
-  columns: {
-    id: :text,
-    name: :text,
-  },
-})
-
 apps = keyspace.column_family('apps', {
-  schema: apps_schema,
+  schema: {
+    primary_key: :id,
+    columns: {
+      id: :text,
+      name: :text,
+    },
+  },
 })
 pp apps
 

data/examples/select_range.rb

@@ -1,32 +1,24 @@
 require_relative '_shared'
 require 'cassanity'
 
-client = CassandraCQL::Database.new('127.0.0.1:9160', {
-  cql_version: '3.0.0',
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
 })
 
-executor = Cassanity::Executors::CassandraCql.new({
-  client: client,
-  logger: Logger.new(STDOUT),
-})
-
-connection = Cassanity::Connection.new(executor: executor)
-keyspace = connection['cassanity_examples']
+keyspace = client['cassanity_examples']
 keyspace.recreate
 
-rollups_schema = Cassanity::Schema.new({
-  primary_key: [:id, :timestamp],
-  columns: {
-    id: :text,
-    timestamp: :int,
-    value: :counter,
-  },
-})
-
 # get an instance of a column family, providing schema means it can create itself
 rollups = keyspace.column_family({
   name: :rollups,
-  schema: rollups_schema,
+  schema: {
+    primary_key: [:id, :timestamp],
+    columns: {
+      id: :text,
+      timestamp: :int,
+      value: :counter,
+    },
+  },
 })
 
 # create column family based on schema
@@ -66,6 +58,24 @@ pp rollups.select({
   }
 })
 
+# you can also use cassanity range
+# returns timestamps 1, 2 and 3
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity::Range.new(1, 3),
+  }
+})
+
+# or the shortcut for it
+# returns timestamps 1, 2 and 3
+pp rollups.select({
+  where: {
+    id: :views,
+    timestamp: Cassanity.range(1, 3),
+  }
+})
+
 # also works with operators
 # returns 3, 4 and 5
 pp rollups.select({

data/lib/cassanity/argument_generators/batch.rb

@@ -34,6 +34,14 @@ module Cassanity
           command_name, command_arguments = modification
           command = @commands.fetch(command_name)
 
+          if args[:column_family_name]
+            command_arguments[:column_family_name] ||= args[:column_family_name]
+          end
+
+          if args[:keyspace_name]
+            command_arguments[:keyspace_name] ||= args[:keyspace_name]
+          end
+
           modification_cql, *modification_variables = command.call(command_arguments)
           modifications << modification_cql
           variables.concat(modification_variables)

data/lib/cassanity/argument_generators/column_family_alter.rb

@@ -11,7 +11,7 @@ module Cassanity
 
       # Internal
       def call(args = {})
-        name = args.fetch(:name)
+        name = args.fetch(:column_family_name)
         with = args[:with] || {}
 
         variables = []

data/lib/cassanity/argument_generators/column_family_create.rb

@@ -11,7 +11,7 @@ module Cassanity
 
       # Internal
       def call(args = {})
-        name         = args.fetch(:name)
+        name         = args.fetch(:column_family_name)
         schema       = args.fetch(:schema)
         columns      = schema.columns
         primary_keys = schema.primary_keys

data/lib/cassanity/argument_generators/column_family_delete.rb

@@ -11,29 +11,9 @@ module Cassanity
         @where_clause = args.fetch(:where_clause) { WhereClause.new }
       end
 
-      # Internal: Converts a Hash of arguments to CQL with bound variables.
-      #
-      # args - The Hash of arguments to use.
-      #        :name - The String name of the column family
-      #        :where - The Hash of options to use to filter the delete
-      #        :columns - The Array of columns you would like to delete
-      #                   (default is all columns) (optional).
-      #        :using - The Hash of options for the query ie: consistency, ttl,
-      #                 and timestamp (default: {}) (optional).
-      #
-      # Examples
-      #
-      #   call({
-      #     name: 'apps',
-      #     where: {
-      #       id: '1',
-      #     },
-      #   })
-      #
-      # Returns Array where first element is CQL string and the rest are
-      #   bound values.
+      # Internal
       def call(args = {})
-        name    = args.fetch(:name)
+        name    = args.fetch(:column_family_name)
         where   = args.fetch(:where)
         columns = args.fetch(:columns) { [] }
         using   = args[:using]

data/lib/cassanity/argument_generators/column_family_drop.rb

@@ -4,7 +4,7 @@ module Cassanity
 
       # Internal
       def call(args = {})
-        name = args.fetch(:name)
+        name = args.fetch(:column_family_name)
 
         if (keyspace_name = args[:keyspace_name])
           name = "#{keyspace_name}.#{name}"

data/lib/cassanity/argument_generators/column_family_insert.rb

@@ -2,31 +2,9 @@ module Cassanity
   module ArgumentGenerators
     class ColumnFamilyInsert
 
-      # Internal: Converts a Hash of arguments to CQL with bound variables.
-      #
-      # args - The Hash of arguments to use.
-      #        :name - The String name of the column family
-      #        :data - The Hash of keys and values to insert
-      #        :using - The Hash of options for the query ie: consistency, ttl,
-      #                 and timestamp (optional).
-      #
-      # Examples
-      #
-      #   call({
-      #     name: 'apps',
-      #     data: {id: '1', name: 'GitHub'},
-      #   })
-      #
-      #   call({
-      #     name: 'apps',
-      #     data: {id: '1', name: 'GitHub'},
-      #     using: {consistency: 'quorum'},
-      #   })
-      #
-      # Returns Array where first element is CQL string and the rest are
-      #   bound values.
+      # Internal
       def call(args = {})
-        name    = args.fetch(:name)
+        name    = args.fetch(:column_family_name)
         data    = args.fetch(:data)
         using   = args[:using] || {}
         keys    = data.keys

data/lib/cassanity/argument_generators/column_family_select.rb

@@ -18,7 +18,7 @@ module Cassanity
       # Internal
       def call(args = {})
         select = Array(args.fetch(:select, '*'))
-        name   = args.fetch(:name)
+        name   = args.fetch(:column_family_name)
         where  = args[:where]
         using  = args[:using]
         order  = args[:order]

data/lib/cassanity/argument_generators/column_family_truncate.rb

@@ -4,7 +4,7 @@ module Cassanity
 
       # Internal
       def call(args = {})
-        name = args.fetch(:name)
+        name = args.fetch(:column_family_name)
 
         if (keyspace_name = args[:keyspace_name])
           name = "#{keyspace_name}.#{name}"

data/lib/cassanity/argument_generators/column_family_update.rb

@@ -13,31 +13,9 @@ module Cassanity
         @where_clause = args.fetch(:where_clause) { WhereClause.new }
       end
 
-      # Internal: Converts a Hash of arguments to CQL with bound variables.
-      #
-      # args - The Hash of arguments to use.
-      #        :name - The String name of the column family
-      #        :set - The Hash of data to actually update
-      #        :where - The Hash of options to use to filter the update
-      #        :using - The Hash of options for the query ie: consistency, ttl,
-      #                 and timestamp (optional).
-      #
-      # Examples
-      #
-      #   call({
-      #     name: 'apps',
-      #     set: {
-      #       name: 'GitHub',
-      #     },
-      #     where: {
-      #       :id => '1',
-      #     }
-      #   })
-      #
-      # Returns Array where first element is CQL string and the rest are
-      #   bound values.
+      # Internal
       def call(args = {})
-        name  = args.fetch(:name)
+        name  = args.fetch(:column_family_name)
         set   = args.fetch(:set)
         where = args.fetch(:where)
         using = args[:using] || {}

data/lib/cassanity/argument_generators/keyspace_create.rb

@@ -11,7 +11,7 @@ module Cassanity
       # Internal
       def call(args = {})
         options, variables = [], []
-        name = args.fetch(:name)
+        name = args.fetch(:keyspace_name)
         cql = "CREATE KEYSPACE #{name}"
 
         with = {

data/lib/cassanity/argument_generators/keyspace_drop.rb

@@ -4,7 +4,7 @@ module Cassanity
 
       # Internal
       def call(args = {})
-        name = args.fetch(:name)
+        name = args.fetch(:keyspace_name)
         cql = "DROP KEYSPACE #{name}"
         [cql]
       end

data/lib/cassanity/argument_generators/keyspace_use.rb

@@ -4,7 +4,7 @@ module Cassanity
 
       # Internal
       def call(args = {})
-        name = args.fetch(:name)
+        name = args.fetch(:keyspace_name)
         cql = "USE #{name}"
         [cql]
       end

data/lib/cassanity/argument_generators/where_clause.rb

@@ -4,6 +4,7 @@ require 'cassanity/operators/gt'
 require 'cassanity/operators/gte'
 require 'cassanity/operators/lt'
 require 'cassanity/operators/lte'
+require 'cassanity/range'
 
 module Cassanity
   module ArgumentGenerators

data/lib/cassanity/argument_generators/with_clause.rb

@@ -12,14 +12,20 @@ module Cassanity
         variables, withs = [], []
 
         with.each do |key, value|
-          if value.is_a?(Hash)
-            value.each do |sub_key, sub_value|
-              withs << "#{key}:#{sub_key} = ?"
-              variables << sub_value
+          if key == :compact_storage
+            if value
+              withs << "COMPACT STORAGE"
             end
           else
-            withs << "#{key} = ?"
-            variables << value
+            if value.is_a?(Hash)
+              value.each do |sub_key, sub_value|
+                withs << "#{key}:#{sub_key} = ?"
+                variables << sub_value
+              end
+            else
+              withs << "#{key} = ?"
+              variables << value
+            end
           end
         end
 

data/lib/cassanity/client.rb

@@ -0,0 +1,65 @@
+require 'forwardable'
+require 'cassandra-cql'
+require 'cassanity/executors/cassandra_cql'
+require 'cassanity/connection'
+
+module Cassanity
+  class Client
+    extend Forwardable
+
+    # Public: The instance of the CassandraCQL::Database being used.
+    attr_reader :driver
+
+    # Public: The instance of the Cassanity::Executors::CassandraCQL that will
+    # execute all queries.
+    attr_reader :executor
+
+    # Public: The instance of the Cassanity::Connection that is the entry point
+    # for all operations.
+    attr_reader :connection
+
+    # Public: Initialize an instance of the client.
+    #
+    # servers - The String or Array of Strings representing the servers to
+    #           connect to.
+    # options - The Hash of CassandraCQL::Database options.
+    # thrift_options - The Hash of CassandraCQL::Database thrift client options.
+    def initialize(servers = nil, options = {}, thrift_options = {})
+      @servers        = servers || '127.0.0.1:9160'
+      @options        = options.merge(cql_version: '3.0.0')
+      @thrift_options = thrift_options.dup
+      @instrumenter   = @options.delete(:instrumenter)
+
+      @driver = CassandraCQL::Database.new(@servers, @options, @thrift_options)
+
+      @executor = Cassanity::Executors::CassandraCql.new({
+        client: @driver,
+        instrumenter: @instrumenter,
+      })
+
+      @connection = Cassanity::Connection.new({
+        executor: @executor,
+      })
+    end
+
+    # Methods on client that should be delegated to connection.
+    DelegateToConnectionMethods = [
+      :keyspaces,
+      :keyspace,
+      :[],
+      :batch,
+    ]
+
+    def_delegators :@connection, *DelegateToConnectionMethods
+
+    # Public
+    def inspect
+      attributes = [
+        "driver=#{driver.inspect}",
+        "executor=#{executor.inspect}",
+        "connection=#{connection.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
+  end
+end