Getting Started with Couchbase Ruby
1 like2,545 views
This document provides an overview of Couchbase Server and how to use it with Ruby. Couchbase Server is a NoSQL database that supports automatic key sharding and replication. It is used by companies like Heroku and Zynga. The document outlines how to install the Couchbase Ruby gem, perform basic CRUD operations, use optimistic locking, expiration, map/reduce, and integrate Couchbase with Rails and other Ruby frameworks.
![Executing views
Pick up design document:
ddoc = conn.design_docs[”users”]
Iterate over view results
ddoc.all_by_email(:include_docs => true).each do |doc|
puts doc.key
puts doc.doc.inspect
end](https://image.slidesharecdn.com/gswcr-120618075110-phpapp01/85/Getting-Started-with-Couchbase-Ruby-16-320.jpg)
Getting Started with Couchbase Ruby
- 1. Getting Started with Couchbase Ruby Sergey Avseyev [email protected]
- 3. What Is Couchbase Server • NoSQL database solution • No fixed schema • Automatic key sharding • Automatic replication • Low latency optimized • No multi-operation transaction support
- 4. Who Uses Couchbase Server: Heroku • Leading cloud service (PAAS) provider • Over 1,500,000 hosted applications • Couchbase Server serving over 11,800 Heroku customers
- 5. Who Uses Couchbase Server: Zynga • Social game leader — FarmVille, Mafia Wars, Empires and Allies, Café World, FishVille • Over 230 million monthly users • Couchbase Server is the primary database behind key Zynga properties
- 7. Installation Install stable version of libcouchbase-dev with dependencies using instructions at http://www.couchbase.com/develop/c/current $ gem install couchbase Fetching: couchbase-1.1.2.gem (100%) Building native extensions. This could take a while... Successfully installed couchbase-1.1.2 1 gems installed
- 8. Connect to the Cluster Pass connection parameters explicitly conn = Couchbase.connect(:bucket => ’test’) Use thread-local connection instance Couchbase.connection_options = :bucket => ’test’ conn = Couchbase.bucket
- 9. Simple CRUD Write key or fail it it is exists already cas = conn.add(”key”, ”value”) Write key unconditionally cas = conn.set(”key”, ”value”) Write key only if it is exists cas = conn.replace(”key”, ”value”) value = conn.get(”key”)
- 10. Optimistic Locks All mutators accepts CAS value (some kind of version or checksum of the key) value, flags, cas = conn.get(”key”, ”value”, :extended => true) Setting with wrong CAS value will raise Couchbase::Error::KeyExists conn.set(”key”, ”newvalue”, :cas => 1234) #=> Couchbase::Error::KeyExists: failed to store value
- 11. Expiration Write key and set expiration conn.set(”key”, ”value”, :ttl => 1.minute) Read key and set expiration conn.get(”key”, :ttl => 1.minute) Only update expiration conn.touch(”key”, :ttl => 1.minute)
- 12. Miscellaneous Multi get foo, bar = conn.get(”foo”, ”bar”) Multi touch conn.touch(”foo” => 30.seconds, ”bar” => 10.minutes) Increment/Decrement conn.incr(”counter”) conn.decr(”counter”)
- 14. Installation Install next version of libcouchbase-dev with dependencies using instructions at http://www.couchbase.com/develop/c/next $ gem install couchbase --pre Fetching: couchbase-1.2.0.dp5.gem (100%) Building native extensions. This could take a while... Successfully installed couchbase-1.2.0.dp5 1 gems installed
- 15. Map/Reduce Analysis Define design document containing single map function (using admin panel or Bucket#save_design_doc): { ”_id”: ”_design/users”, ”views”: { ”all_by_email”: { ”map”: ”function(doc) { if (doc.type == ”User”) emit(doc.email, null); }” }, } }
- 16. Executing views Pick up design document: ddoc = conn.design_docs[”users”] Iterate over view results ddoc.all_by_email(:include_docs => true).each do |doc| puts doc.key puts doc.doc.inspect end
- 17. Pessimistic Locks value = conn.get(”key”, :lock => 5.seconds) All subsequent mutators are forced to use corresponding CAS value or fail
- 18. Rack Session Storage # config.ru require ’rack/session/couchbase’ use Rack::Session::Couchbase, :expire_after => 5.minutes, :couchbase => {:bucket => ”sessions”}
- 19. Rails Session Storage # config/initializers/session_store.rb require ’action_dispatch/middleware/session/couchbase_store’ Name::Application.config.session_store :couchbase_store, :expire_after => 5.minutes, :couchbase => {:bucket => ”sessions”}
- 20. Rails Cache Storage # config/application.rb cache_options = { :bucket => ’protected’, :username => ’protected’, :password => ’secret’, :expires_in => 2.hours } config.cache_store = :couchbase_store, cache_options
- 21. Even More :)
- 22. ODM (Object Document Model) for Rails https://github.com/couchbaselabs/ruby-couchbase-model $ gem install couchbase-model class Post < Couchbase::Model attribute :title attribute :body attribute :created_at, :default => lambda { Time.now } view :by_created_at end
- 23. Couchbase for EventMachine (experimental) https://github.com/couchbaselabs/couchbase-ruby-client-em $ gem install em-couchbase
- 25. Find these slides at: github.com/avsej/getting-started-with-couchbase-ruby