Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnunemaker/cassanity
Brings sanity to CQL + Ruby.
https://github.com/jnunemaker/cassanity
Last synced: 17 days ago
JSON representation
Brings sanity to CQL + Ruby.
- Host: GitHub
- URL: https://github.com/jnunemaker/cassanity
- Owner: jnunemaker
- License: mit
- Created: 2012-11-03T16:40:28.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2016-08-02T13:12:29.000Z (over 8 years ago)
- Last Synced: 2024-10-17T02:25:45.519Z (23 days ago)
- Language: Ruby
- Homepage: http://jnunemaker.github.com/cassanity
- Size: 528 KB
- Stars: 25
- Watchers: 6
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cassanity [](http://travis-ci.org/jnunemaker/cassanity)
Layer of goodness on top of the [Cassandra Ruby Driver](https://github.com/datastax/ruby-driver) so you do not have to write CQL strings all over the place.
## Installation
Add this line to your application's Gemfile:
gem 'cassanity'
## Usage
```ruby
require 'cassanity'
# 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 = 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
apps_schema = Cassanity::Schema.new({
primary_key: :id,
columns: {
id: :text,
name: :text,
created_at: :timestamp,
},
with: {
comment: 'For storing apps',
}
})
# get instance of column family with name and schema set
apps = keyspace.column_family({
name: :apps,
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
# insert row
apps.insert(data: {
id: '1',
name: 'GitHub.com',
created_at: Time.now,
})
# update name for row
apps.update(set: {name: 'GitHub'}, where: {id: '1'})
# delete row
apps.delete(where: {id: '1'})
# truncate column family (remove all rows, still can add new stuff)
apps.truncate
# drop column family (no more inserting into it, it is gone)
apps.drop
```
You can also do a lot more. Here are a few more [examples](https://github.com/jnunemaker/cassanity/tree/master/examples):
* [Batch Operations](https://github.com/jnunemaker/cassanity/tree/master/examples/batch.rb)
* [Counters](https://github.com/jnunemaker/cassanity/tree/master/examples/counters.rb)
* [Keyspaces](https://github.com/jnunemaker/cassanity/tree/master/examples/keyspaces.rb)
* [Column Families](https://github.com/jnunemaker/cassanity/tree/master/examples/column_families.rb)
* [Select a Range](https://github.com/jnunemaker/cassanity/tree/master/examples/select_range.rb)
* [Collections](https://github.com/jnunemaker/cassanity/tree/master/examples/collections.rb)
* [Prepared Statements](https://github.com/jnunemaker/cassanity/tree/master/examples/prepared_statements.rb)
## More Reading
* [Instrumentation](https://github.com/jnunemaker/cassanity/tree/master/doc/Instrumentation.md)
* [Migrations](https://github.com/jnunemaker/cassanity/tree/master/doc/Migrations.md)
* [Prepared Statements](https://github.com/jnunemaker/cassanity/tree/master/doc/Prepared_Statements.md)
* [Asynchronous Queries](https://github.com/jnunemaker/cassanity/tree/master/doc/Async_Queries.md)
## Compatibility
* Ruby >= 1.9.3
* Cassandra >= 1.2 with CQL >= 3.1.0
## 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