Couchbase Ruby Client

This repository contains the third generation of the official Couchbase SDK for Ruby (aka. SDKv3)

Support and Feedback

If you find an issue, please file it in our JIRA issue tracker. Also you are always welcome on our forum and Discord.

Please attach version information to the ticket/post. To obtain this information, use the following command:

$ ruby -r couchbase -e 'p Couchbase::VERSION'


The library has been tested with MRI 3.0, 3.1 and 3.2. Supported platforms are Linux and MacOS.

Add this line to your application's Gemfile:

# version (does not have precompiled binaries)
gem "couchbase", "3.4.3"

# use official repository
gem "couchbase", "3.4.3", :source => ""

## precompiled binaries (uncomment line with effective ABI version of ruby)
# gem "couchbase", "3.4.3", :platforms => :mri_32, :source => ""
# gem "couchbase", "3.4.3", :platforms => :mri_31, :source => ""
# gem "couchbase", "3.4.3", :platforms => :mri_30, :source => ""

And then execute:

$ bundle install

Or install it yourself as:

$ gem install couchbase

For some platforms we precompile binary packages. When, for some reason, binary packages cannot be used, pass --platform=ruby to the gem install command (or check the specific_platform and force_ruby_platform options of Bundler). In latter case, see the Development section for build dependencies.


Here are some basic steps demonstrating basic operations with data:

require "couchbase"
include Couchbase # include Couchbase module for brevity

# initialize library
cluster = Cluster.connect("couchbase://", "Administrator", "password")

# open bucket and collection for data operations
bucket = cluster.bucket("my_bucket")
collection = bucket.default_collection

# update or insert the document
res = collection.upsert("foo", {"bar" => 42})
#=> 22120998714646

# retrieve document from the collection
res = collection.get("foo")
#=> 22120998714646
#=> {"bar"=>42}

# remove document
res = collection.remove("foo")
#=> 47891154812182

# fetch top-3 cities by number of hotels in the collection
res = cluster.query("
          SELECT city, COUNT(*) AS cnt FROM `travel-sample`
          WHERE type = $type
          GROUP BY city
          ORDER BY cnt DESC
          LIMIT 3",
        Options::Query(named_parameters: {type: "hotel"}, metrics: true))
res.rows.each do |row|
  p row
#=> {"city"=>"San Francisco", "cnt"=>132}
#   {"city"=>"London", "cnt"=>67}
#   {"city"=>"Paris", "cnt"=>64}


After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.


Part of the library is written in C++, and requires both C and C++ compilers installed on the system. To configure the build environment it uses cmake. When these tools are installed, the build process is easy:

$ bundle exec rake compile


By default, a mock cluster is used for testing. If you wish to use a real cluster, you can define the TEST_CONNECTION_STRING environment variable (e.g. TEST_CONNECTION_STRING=couchbase://localhost). You might also need to set the values for the TEST_USERNAME, TEST_PASSWORD, and TEST_BUCKET environment variables.

To run the tests:

$ bundle exec rake test


We use the RuboCop linter. To run it:

$ bundle exec rubocop


To build and install the Ruby gem (where VERSION is the current version of the SDK):

$ gem build couchbase.gemspec
$ gem install couchbase-VERSION.snapshot.gem

Generate Documentation

To generate documentation yard library is highly recommended.

$ gem install yard

The following steps will generate API reference for selected git tag:

$ rake doc

Now the API reference is accessible using a web browser (where VERSION is the current version of the SDK)

$ firefox doc/couchbase-ruby-client-VERSION/index.html


The gem is available as open source under the terms of the Apache2 License.

Copyright 2011-Present Couchbase, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.