cassandra_store 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55cc964c9acca186677f0a9de4ea89d62526c050e50e52c09735c5948c5d7dd8
+  data.tar.gz: 63ae9aac6d672d2d45779a78fe7b911014ec752e4c878dc6f6e5c062f3bbe8a5
+SHA512:
+  metadata.gz: a24dc8c1517c235b4c0a406199a3048e92724554f4072d34a106ac42e21d0778e02ff372fd17af5be0a0aae6a113b3340bad0bb06f3014d3ddbcb3afbf5eea74
+  data.tar.gz: 04c4394a2c87fab0cbfd947931f9602f600d04d4642a4ee9264ea087da861f75c17c2749805efb065c6fba5d04600d0ede89f12a314c09db71059cb1eb176cf5

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+gemfiles/*.lock

data/.rubocop.yml

@@ -0,0 +1,123 @@
+AllCops:
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - lib/cassandra-record.rb
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/ClassLength:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Layout/RescueEnsureAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/OptionalArguments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+rvm:
+  - 2.5.7
+  - 2.6.3
+  - 2.7.1
+
+before_install:
+  - docker-compose up -d
+  - sleep 10
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+
+sudo: false

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activesupport"
+gem "cassandra-driver"
+gem "hooks"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Vetter
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,282 @@
+[![Build Status](https://secure.travis-ci.org/mrkamel/cassandra-store.png?branch=master)](http://travis-ci.org/mrkamel/cassandra-store)
+
+# CassandraStore
+
+CassandraStore is a fun to use ORM for Cassandra with a chainable,
+ActiveStore like DSL for querying, inserting, updating and deleting records
+plus built-in migration support. It is built on-top of the cassandra-driver
+gem, using its built-in automated paging what is drastically reducing the
+complexity of the code base.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+    gem 'cassandra-store'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cassandra-store
+
+# Usage
+
+## Connecting
+
+First and foremost, you need to connect to your cassandra cluster like so:
+
+```ruby
+CassandraStore::Base.configure(
+  hosts: ["127.0.0.1"],
+  keyspace: "my_keyspace",
+  cluster_settings: { consistency: :quorum }
+)
+```
+
+When using rails, you want to do that in an initializer. If you do not yet have
+a keyspace, you additionally want to pass `replication` settings:
+
+```ruby
+CassandraStore::Base.configure(
+  hosts: ["127.0.0.1"],
+  keyspace: "my_keyspace",
+  cluster_settings: { consistency: :quorum },
+  replication: { class: 'SimpleStrategy', replication_factor: 1 }
+)
+```
+
+Afterwards, you can create/drop the specified keyspace:
+
+```ruby
+rake cassandra:keyspace:create
+rake cassandra:keyspace:drop
+```
+
+## Migrations
+
+If you are on rails and you don't have any tables yet, you can add migrations
+now. There is no generator yet, so you have to create them manually:
+
+```ruby
+# cassandra/migrate/1589896040_create_posts.rb
+
+class CreatePosts < CassandraStore::Migration
+  def up
+    execute <<-CQL
+      CREATE TABLE posts (
+        user TEXT,
+        domain TEXT,
+        id TIMEUUID,
+        message TEXT,
+        PRIMARY KEY ((user, domain), id)
+      )
+    CQL
+  end
+
+  def down
+    execute "DROP TABLE posts"
+  end
+end
+```
+
+Afterwards, simply run `rake cassandra:migrate`.
+
+## Models
+
+Creating models couldn't be easier:
+
+```ruby
+class Post < CassandraStore::Base
+  column :user, :text, partition_key: true
+  column :domain, :text, partition_key: true
+  column :id, :timeuuid, clustering_key: true
+  column :message, :text
+
+  validates_presence_of :user, :domain, :message
+
+  before_create do
+    self.id ||= generate_timeuuid
+  end
+end
+```
+
+Let's check this out in detail:
+
+```ruby
+  column :user, :text, partition_key: true
+  column :domain, :text, partition_key: true
+```
+
+tells CassandraStore that your partition key is comprised of the `user` column
+as well as the `domain` column. For more information regarding partition keys
+and the data model of cassandra, please check out the cassandra docs. Afterwards,
+the clustering/sorting key is specified via:
+
+```ruby
+column :id, :timeuuid, clustering_key: true
+```
+
+The `id` is assigned here:
+
+```ruby
+  self.id ||= generate_timeuuid
+```
+
+Please note, CassandraStore never auto-assigns any values for you, but you
+have to assign them. You can pass a timestamp to `generate_timeuuid` as well:
+
+```ruby
+  generate_timeuuid(Time.now)
+```
+
+This is desirable when you have timestamp columns as well and you want them
+to match with your timeuuid key.
+
+Similarly, when using `UUID` instead of `TIMEUUID` you have to use
+`generate_uuid` instead.
+
+In addition, you can of course use all kinds of validations, hooks, etc.
+
+## Querying
+
+The interface for dealing with records and querying them is very similar
+to the interface of `ActiveRecord`:
+
+```ruby
+Post.create!(user: "mrkamel", ...)
+Post.create(...)
+Post.new(...).save
+Post.new(...).save!
+Post.first.delete
+Post.first.destroy
+```
+
+CassandraStore supports comprehensive query methods in a chainable way:
+
+* `all`
+
+```ruby
+  Post.all
+```
+
+* `where`
+
+```ruby
+  Post.where(user: "mrkamel", domain: "example.com")
+```
+
+* `where_cql`
+
+```ruby
+  Post.where_cql("user = :user", user: "mrkamel")
+```
+
+* `limit`
+
+```ruby
+  Post.where(...).limit(10)
+```
+
+* `order`
+
+```ruby
+  Post.where(...).order(id: "asc")
+```
+
+* `distinct`
+
+```ruby
+  Post.select(:user, :domain).distinct
+```
+
+* `select`
+
+```ruby
+  Post.select(:user, :domain)
+```
+
+Please note, when using `select` in the end an array of hashes will be returned
+instead of an array of `Post` objects.
+
+* `count`
+
+```ruby
+  Post.where(...).count
+```
+
+* `first`
+
+```ruby
+  Post.where(...).first
+```
+
+* `find_each`
+
+```ruby
+  Post.where(...).find_each(batch_size: 100) do |post|
+    # ...
+  end
+```
+
+* `find_in_batches`
+
+```ruby
+  Post.where(...).find_in_batches(batch_size: 100) do |batch|
+    # ...
+  end
+```
+
+* `update_all`
+
+```ruby
+  Post.where(...).update_all("message = 'test'")
+  Post.where(...).update_all(message: "test")
+```
+
+* `delete_all`
+
+```ruby
+  Post.where(...).delete_all
+```
+
+Please note, that `delete_in_batches` will run `find_in_batches` iteratively
+and then delete each batch. When dealing with large amounts of records to
+delete you usually want to use `delete_in_batches` instead of `delete_all`, as
+`delete_all` can time out.
+
+* `delete_in_batches`
+
+```ruby
+  Post.where(...).delete_in_batches
+```
+
+Again, please note, that `delete_in_batches` will run `find_in_batches` iteratively
+and then delete each batch. When dealing with large amounts of records to
+delete you usually want to use `delete_in_batches` instead of `delete_all`, as
+`delete_all` can time out.
+
+* `truncate_table`
+
+```ruby
+  Post.truncate_table
+```
+
+Deletes all records from the table. This is much faster than `delete_all` or
+`delete_in_batches`.  However, it is not chainable, such that your only option
+is to remove all records from the table.
+
+## Semantic Versioning
+
+CassandraStore is using Semantic Versioning: [SemVer](http://semver.org/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+