Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A .NET client for Basho's Riak database

README.md

Riak .NET Client - a .NET client for Riak

Riak .NET Client is a .NET library which makes it easy to communicate with Riak, Basho's fault-tolerante, distributed KV store.

The easiest way to get hold of it is to install the Nuget package.

Building From Source

GUI

Note: git must be in your PATH when doing a Release-configuration build.

Open RiakClient.sln and build. This will generate the required src/CommonAssemblyInfo.cs file.

Command Line

Note: git must be in your PATH when doing a Release-configuration build.

  • Windows
    • Execute make.cmd either via double-click in the file explorer, or by opening a shell in your cloned repository and running .\make.cmd. This will use powershell.exe to run make.ps1 and create a Debug build. Running make.ps1 has much more flexibility. Use the Get-Help .\make.ps1 -Full command in Powershell for more information.
  • Mono
    • Execute make (GNU Make required)

Travis-CI Build Status

  • Master: Build Status
  • Develop: Build Status

Authors

Documentation

Documentation for the project can be found on the project website.

Release Notes

Please see the Release Notes document.

License

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

Regenerating .proto files

  • Ensure submodules are checked out
  • In Powershell: .\make.ps1 -Target ProtoGen

Riak .NET Client Deployment Process

  • Merge all required feature branches into develop.
  • Verify that all tests succeed.
  • Make sure that the TravisCI build succeeds.
  • run git flow release start vA.B.C
  • Edit RiakClient.nuspec and VersionInfo.cs so that the version numbers are up to date.
  • To produce a new release build open a command prompt, change to the CI folder and run: make
  • Verify that two nupkg files were created, one for the library and one for the symbols. The version number should match that which you are releasing.
  • Finish the release by running: git flow release finish vA.B.C
  • Push all the branches/tags up: git push origin master:master && git push origin develop:develop && git push --tags
  • Push to Nuget by running (from the same command prompt): .nuget\Nuget.exe push RiakClient.VERSION.nupkg (it should also push up the symbols).
  • Make any changes to samples that might be required.
  • Make any changes to documentation that might be required.

Give yourself a pat on the back and have some tea.

Riak .NET Client Roadmap

Cluster and node info

Github Issue 10 This would be looking for ways to get the results of riak_admin status and other commands through the Riak Client API

SOLR Interface

Github Issue 20 Create an HTTP interface for Faceted queries vi the Solr Interface

Improved Riak Search API

Github Issue 23 Additional development should be undertaken to make it easier for developers to use this.

Thanks

The following people have contributed to Riak .NET Client, it's predecessor CorrugatedIron, or one of the related libraries or applications that make it work:

  • Jeremiah Peschka
  • OJ Reeves
  • Matthew Whitfield
  • Kevin Pullin
  • Tiago Margalho
  • Marc Gravell (protobuf-net)
  • James Newton-King (Json.NET)
  • Alex Moore
  • Luke Bakken
Something went wrong with that request. Please try again.