Riak Go Client

The Riak Go Client is a client which makes it easy to communicate with Riak, an open source, distributed database that focuses on high availability, horizontal scalability, and predictable latency. Both Riak and this code is maintained by Basho.

The latest version of the client supports both Riak KV 2.0+, and Riak TS 1.0+.

Build Status

Installation

go get github.com/basho/riak-go-client

Documentation

• API documentation on Godoc
• Wiki
• Release Notes.

Testing / Contributing

This repository's maintainers are engineers at Basho and we welcome your contribution to the project! Review the details in CONTRIBUTING.md in order to give back to this project.

Note: Please clone this repository in such a manner that submodules are also cloned:

git clone --recursive https://github.com/basho/riak-go-client

OR:

git clone https://github.com/basho/riak-go-client
git submodule init --update

Unit Tests

make unit-test

Integration Tests

You have two options to run Riak locally - either build from source, or use a pre-installed Riak package.

Source

To setup the default test configuration, build a Riak node from a clone of github.com/basho/riak:

# check out latest release tag
git checkout riak-2.1.4
make locked-deps
make rel

Source build documentation.

When building from source, the protocol buffers port will be 8087 and HTTP will be 8098.

Package

Install using your platform's package manager (docs)

When installing from a package, the protocol buffers port will be 8087 and HTTP will be 8098.

Running Integration Tests

• Ensure you've initialized this repo's submodules:

git submodule update --init

• Run the following:

./tools/setup-riak
make integration-test

This repository's maintainers are engineers at Basho and we welcome your contribution to the project! Review the details in CONTRIBUTING.md in order to give back to this project.

An honest disclaimer

Due to our obsession with stability and our rich ecosystem of users, community updates on this repo may take a little longer to review.

The most helpful way to contribute is by reporting your experience through issues. Issues may not be updated while we review internally, but they're still incredibly appreciated.

Thank you for being part of the community! We love you for it.

Roadmap

• 1.0.0 - Full Riak 2 support with command queuing and retries.

License

The Riak Go Client is Open Source software released under the Apache 2.0 License. Please see the LICENSE file for full license details.

These excellent community projects inspired this client and parts of their code are in riak-go-client as well:

• goriakpbc
• riaken-core
• backoff

Authors

• Luke Bakken
• Christopher Mancini

Contributors

Thank you to all of our contributors!

• Ian Lozinski
• Sergio C. Arteaga
• Andrew Zeneski
• Кирилл Александрович Журавлев
• Paul Guelpa
• Xabier Larrakoetxea Gallego
• Paul Maseberg
• Weerasak Chongnguluam
• Hawk Newton
• Beau Brewer