To generate config you can use rails generate couchbase_orm:config:
$ rails generate couchbase_orm:config
create config/couchbase.yml
It will generate this config/couchbase.yml for you:
common: &common
hosts: localhost
password:
development:
<<: *common
bucket: default
test:
<<: *common
bucket: app_name_test
password: for_test_bucket
# set these environment variables on your production server
production:
hosts: <%= ENV['COUCHBASE_HOST'] || ENV['COUCHBASE_HOSTS'] %>
bucket: <%= ENV['COUCHBASE_BUCKET'] %>
password: <%= ENV['COUCHBASE_PASSWORD'] %>
require 'couchbase-orm'
class Post < CouchbaseOrm::Base
attribute :title, type: String
attribute :body, type: String
attribute :draft, type: Boolean
end
p = Post.new(id: 'hello-world',
title: 'Hello world',
draft: true)
p.save
p = Post.find('hello-world')
p.body = "Once upon the times...."
p.save
p.update(draft: false)
Post.bucket.get('hello-world') #=> {"title"=>"Hello world", "draft"=>false,
# "body"=>"Once upon the times...."}You can also let the library generate the unique identifier for you:
p = Post.create(title: 'How to generate ID',
body: 'Open up the editor...')
p.id #=> "post-abcDE34"You can define connection options on per model basis:
class Post < CouchbaseOrm::Base
attribute :title, type: String
attribute :body, type: String
attribute :draft, type: Boolean
connect bucket: 'blog', password: ENV['BLOG_BUCKET_PASSWORD']
endThere are all methods from ActiveModel::Validations accessible in context of rails application. You can also enforce types using ruby conversion methods
class Comment < Couchbase::Model
attribute :author, :body, type: String
validates_presence_of :author, :body
endViews are defined in the model and typically just emit an attribute that can then be used for filtering results or ordering.
class Comment < CouchbaseOrm::Base
attribute :author, :body, type: String
view :all # => emits :id and will return all comments
view :by_author, emit_key: :author
# Generates two functions:
# * the by_author view above
# * def find_by_author(author); end
index_view :author
validates_presence_of :author, :body
endYou can use Comment.find_by_author('name') to obtain all the comments by
a particular author. The same thing, using the view directly would be:
Comment.by_author(key: 'name')
There are common active record helpers available for use belongs_to and has_many
class Comment < CouchbaseOrm::Base
belongs_to :author
end
class Author < CouchbaseOrm::Base
has_many :comments, dependent: :destroy
# You can ensure an attribute is unique for this model
attribute :email, type: String
ensure_unique :email
endBasically we migrated an application from Couchbase Ruby Model to Couchbase-ORM (this project)
- Rails 5 production
- Puma as the webserver
- Running on a 2015 Macbook Pro
- Performance test:
siege -c250 -r10 http://localhost:3000/auth/authority
The request above pulls the same database document each time and returns it. A simple O(1) operation.
| Stat | Couchbase Ruby Model | Couchbase-ORM |
|---|---|---|
| Transactions | 2500 hits | 2500 hits |
| Elapsed time | 12.24 secs | 8.20 secs |
| Response time | 0.88 secs | 0.47 secs |
| Transaction rate | 204.25 trans/sec | 304.88 trans/sec |
| Request Code | ruby-model-app | couch-orm-app |