Couchbase Ruby Release Notes and Archives

    +
    Release notes, installation instructions, and download archive for the Couchbase Ruby Client.

    These pages cover the 3.0 versions of the Couchbase Ruby SDK.

    SDK Installation

    Ruby SDK supports MRI Ruby versions 2.5, 2.6, and 2.7. The source package is available through https://rubygems.org/gems/couchbase and can be installed with

    gem install couchbase

    Note that --pre is necessary when the SDK in Beta/Preview phase — gem install --pre couchbase — otherwise the latest stable release will be installed.

    In addition to rubygems.org, we also maintain official gem repositories, where we publish not only source version of the package, but also precompiled binaries for Linux and MacOS.

    Ruby ABI version

    Source URL

    2.7

    https://packages.couchbase.com/clients/ruby/2.7.0/

    2.6

    https://packages.couchbase.com/clients/ruby/2.6.0/

    2.5

    https://packages.couchbase.com/clients/ruby/2.5.0/

    To use official repository, it have to be registered in the .gemrc file:

    The example above selects repository with the packages for Ruby 2.7.x. For other version, please refer the table.

    The repository could be also specified in Gemfile for bundler. And in this case the source would be applied only for Couchbase SDK library:

    gem "couchbase", "3.0.2", :source => "https://packages.couchbase.com/clients/ruby/2.7.0/"

    Or run in terminal:

    gem install couchbase --source https://packages.couchbase.com/clients/ruby/2.7.0/

    And finally, it is possible to download the package and install from the file. In the notes below, we specify tables with links to every release package along with precompiled binaries.

    wget https://packages.couchbase.com/clients/ruby/sdk-3.0.2/couchbase-3.0.2-x86_64-linux-2.7.0.gem
    gem install couchbase-3.0.2-x86_64-linux-2.7.0.gem

    Version 3.0.2 (3 November 2020)

    This is the third GA release of 3.0 series.

    Platform

    Ruby ABI

    File

    Checksums

    couchbase-3.0.2.sha256sum

    Source Archive

    couchbase-3.0.2.gem

    Linux x86_64

    2.7.0

    couchbase-3.0.2-x86_64-linux-2.7.0.gem

    Linux x86_64

    2.6.0

    couchbase-3.0.2-x86_64-linux-2.6.0.gem

    Linux x86_64

    2.5.0

    couchbase-3.0.2-x86_64-linux-2.5.0.gem

    macOS 10.15 x84_64

    2.7.0

    couchbase-3.0.2-x86_64-darwin-19-2.7.0.gem

    macOS 10.15 x84_64

    2.6.0

    couchbase-3.0.2-x86_64-darwin-19-2.6.0.gem

    macOS 10.15 x84_64

    2.5.0

    couchbase-3.0.2-x86_64-darwin-19-2.5.0.gem

    macOS 10.13 x84_64

    2.7.0

    couchbase-3.0.2-x86_64-darwin-17-2.7.0.gem

    macOS 10.13 x84_64

    2.6.0

    couchbase-3.0.2-x86_64-darwin-17-2.6.0.gem

    macOS 10.13 x84_64

    2.5.0

    couchbase-3.0.2-x86_64-darwin-17-2.5.0.gem

    Version 3.0.1 (5 October 2020)

    This is the second GA release.

    • RCBC-219, RCBC-252: Implemented diagnostics API.

    • RCBC-272: Allow disabling of scoring in Full-Text Search results.

    • RCBC-229: Geopolygon Search support.

    • RCBC-271: Enhanced user management for collections.

    • RCBC-230: Added query option for flex index.

    • RCBC-233: Updated eviction policy types (now it covers ephemeral buckets).

    • RCBC-274: Skip non-kv nodes when switching networks (fixes warnings in Cloud environment).

    • RCBC-266: Deprecated GetResult.expiry.

    • Fixed Query prepared statements cache for older servers.

    • Build and test system improvements

    Platform

    Ruby ABI

    File

    Checksums

    couchbase-3.0.1.sha256sum

    Source Archive

    couchbase-3.0.1.gem

    Linux x86_64

    2.7.0

    couchbase-3.0.1-x86_64-linux-2.7.0.gem

    Linux x86_64

    2.6.0

    couchbase-3.0.1-x86_64-linux-2.6.0.gem

    Linux x86_64

    2.5.0

    couchbase-3.0.1-x86_64-linux-2.5.0.gem

    macOS 10.15 x84_64

    2.7.0

    couchbase-3.0.1-x86_64-darwin-19-2.7.0.gem

    macOS 10.15 x84_64

    2.6.0

    couchbase-3.0.1-x86_64-darwin-19-2.6.0.gem

    macOS 10.15 x84_64

    2.5.0

    couchbase-3.0.1-x86_64-darwin-19-2.5.0.gem

    macOS 10.13 x84_64

    2.7.0

    couchbase-3.0.1-x86_64-darwin-17-2.7.0.gem

    macOS 10.13 x84_64

    2.6.0

    couchbase-3.0.1-x86_64-darwin-17-2.6.0.gem

    macOS 10.13 x84_64

    2.5.0

    couchbase-3.0.1-x86_64-darwin-17-2.5.0.gem

    Version 3.0.0 (8 September 2020)

    This is the first GA release.

    Platform

    Ruby ABI

    File

    Checksums

    couchbase-3.0.0.sha256sum

    Source Archive

    couchbase-3.0.0.gem

    Linux x86_64

    2.7.0

    couchbase-3.0.0-x86_64-linux-2.7.0.gem

    Linux x86_64

    2.6.0

    couchbase-3.0.0-x86_64-linux-2.6.0.gem

    Linux x86_64

    2.5.0

    couchbase-3.0.0-x86_64-linux-2.5.0.gem

    macOS 10.15 x84_64

    2.7.0

    couchbase-3.0.0-x86_64-darwin-19-2.7.0.gem

    macOS 10.15 x84_64

    2.6.0

    couchbase-3.0.0-x86_64-darwin-19-2.6.0.gem

    macOS 10.15 x84_64

    2.5.0

    couchbase-3.0.0-x86_64-darwin-19-2.5.0.gem

    macOS 10.13 x84_64

    2.7.0

    couchbase-3.0.0-x86_64-darwin-17-2.7.0.gem

    macOS 10.13 x84_64

    2.6.0

    couchbase-3.0.0-x86_64-darwin-17-2.6.0.gem

    macOS 10.13 x84_64

    2.5.0

    couchbase-3.0.0-x86_64-darwin-17-2.5.0.gem

    Version 3.0.0.beta.1 (7 August 2020)

    Older Releases

    Although no longer supported, documentation for older releases continues to be available in our docs archive.