Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 2.67 KB

README.md

File metadata and controls

78 lines (54 loc) · 2.67 KB
Raw

Riago

Build Status

Riago is a Riak client for Go.

It's fast and stable, currently being used in production at Dotabuff handling a peak of about 5k ops/sec.

Why another client?

Riak is a nuanced data store with an explicit PBC (Protocol Buffers Client) API. Other Go clients make an effort to hide this API behind more friendly abstractions. This tends to make simple operations easy but can cause confusing behavior if your usage patterns don't match that of the client library.

Riago takes a different approach. Based on the assumption that the PBC API is the ideal development interface for Riak, Riago embraces and exposes these structures directly. Riago handles connection pooling, instrumentation, encoding and decoding, socket plumbing and error handling but otherwise gets out of your way.

Features

  • Protocol Buffers interface
  • Connection pooling
  • Instrumentation hooks
  • Customizable retry behavior
  • Sane error handling (operation time errors, minimal and safe type assertions)

Supported Operations

  • KV Get, Put, Del, GetBucket, SetBucket, ListBuckets, ListKeys
  • 2i: Index
  • MR: MapRed
  • Search: SearchQuery
  • Yokozuna: YokozunaIndexGet, YokozunaIndexPut, YokozunaIndexDelete, YokozunaSchemaGet, YokozunaSchemaPut

Usage Example

package main

import (
  "github.com/jcoene/riago"
  "log"
)

func main() {
  // Create a client with up to 10 connections
  client := riago.NewClient("127.0.0.1:8087", 10)

  // Create a Riak KV Get request
  req := &riago.RpbGetReq{
    Bucket: []byte("people"),
    Key:    []byte("bob"),
  }

  // Issue the get request using the Get method
  resp, err := client.Get(req)
  if err != nil {
    log.Fatalf("an error occured: %s", err)
  }

  // See how many records (siblings) were returned
  log.Printf("bob has %d records", len(resp.GetContent()))
}

Running Tests

To run tests, install Riak 2.0 and configure appropriately:

  1. Set the backend to leveldb in riak.conf: storage_backend = leveldb
  2. Create the riago_dt_test data type: riak-admin bucket-type create riago_dt_test '{"props":{"datatype":"counter"}}'
  3. Activate the riago_dt_test data type: riak-admin bucket-type activate riago_dt_test

License and Credits

Riago is licensed under the Apache license, see LICENSE.txt for details.

Riago is heavily inspired by and borrows from the mrb/riakpbc and tpjg/goriakpbc projects. Thank you to the original authors and all their contributors!