This repository contains the third generation of the official Couchbase SDK for Ruby (aka. SDKv3)
Support and Feedback
Please attach version information to ticket/post. To obtain this information use the following command:
$ ruby -r couchbase -e 'p Couchbase::VERSION'
The library tested with the MRI 2.5, 2.6 and 2.7. Supported platforms are Linux and MacOS.
Add this line to your application's Gemfile:
# rubygems.org version (does not have precompiled binarie) gem "couchbase", "3.0.0.beta.1" # source version from official repository gem "couchbase", "3.0.0.beta.1", :source => "https://packages.couchbase.com/clients/ruby/2.7.0/" ## precompiled binaries (uncomment line with effective ABI version of ruby) # gem "couchbase", "3.0.0.beta.1", :platforms => :mri_27, :source => "https://packages.couchbase.com/clients/ruby/2.7.0/" # gem "couchbase", "3.0.0.beta.1", :platforms => :mri_26, :source => "https://packages.couchbase.com/clients/ruby/2.6.0/" # gem "couchbase", "3.0.0.beta.1", :platforms => :mri_25, :source => "https://packages.couchbase.com/clients/ruby/2.5.0/"
And then execute:
$ bundle install
Or install it yourself as:
$ gem install --pre couchbase
For some platforms we precompile binary packages. When, for some reason, binary package cannot be used, pass
gem install command (or check
force_ruby_platform options of Bundler). In latter case, see Development section for build dependencies.
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 build environment, it uses
cmake. When these tools installed, the build process is easy:
$ rake compile
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 web browser (where
VERSION is 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.