Guide list

Welle documentation is organized as a number of guides, covering all kinds of topics.

The guides try to provide an overview of Riak features and why they exist. They, however, focus on Welle first and foremost and by no means are comprehensive; consult Riak documentation for more information.

We recommend that you read these guides, if possible, in this order:

Getting started

An overview of Welle with a quick tutorial that helps you to get started with it. It should take about 10 minutes to read and study the provided code examples

Connecting to Riak

This guide covers:

  • Using Riak's HTTP transport with Welle
  • Using Protocol Buffers (PB) transport
  • Checking connection health

Working with buckets

This guide covers:

  • What are Riak buckets
  • How to set/update bucket properties with Welle
  • How to list buckets
  • Bucket properties, what do they mean
  • How to fetch bucket properties
  • How to update bucket properties

Key/Value Operations

This guide covers:

  • How to store data in Riak with Welle
  • How to fetch data
  • How to delete data

Secondary indexes

This guide covers:

  • What are secondary indexes (2i)
  • Riak's approach to secondary indexes
  • Indexing stored values with Welle
  • Secondary index queries

This guide covers:

  • Riak Search Overview
  • Indexing
  • Querying

This guide covers:

  • What are Riak links
  • Storing links with values
  • Link walking


This guide covers:

  • What is map/reduce
  • Performing Map/reduce queries with Welle

Integration with 3rd party libraries

This guide covers:

  • Why integrate with other libraries?
  • Using Ring session store implementation on top of Riak
  • Using welle.cache: core.cache implementation on top of Riak

Tell Us What You Think!

Please take a moment to tell us what you think about this guide on Twitter or the Welle mailing list

Let us know what was unclear or what has not been covered. Maybe you do not like the guide style or grammar or discover spelling mistakes. Reader feedback is key to making the documentation better.

comments powered by Disqus