Skip to content

Latest commit

 

History

History
256 lines (171 loc) · 15.5 KB

RELNOTES.md

File metadata and controls

256 lines (171 loc) · 15.5 KB
Raw

Release Notes

2.5.0

  • Add support for Riak TS 1.5

v2.4.0

  • Add support for Riak 2.2.0 and the HyperLogLog data type.
  • Add support of encoding Store and Query Riak TS commands in Erlang term format. Compatible with Riak TS 1.3 and above.
  • Add useTtbEncoding cluster and node configuration option. Set useTtbEncoding=false to disable Erlang term format encoding when connecting to a Riak TS 1.2 cluster.

v2.3.0

  • Add support for external load balancers via the externalLoadBalancer node option.
  • Fix issue where offline state of node not getting passed corectly.
  • Add Riak Timeseries support

v2.2.0

v2.1.1

v2.1.0

v2.0.0

Overview

  • Renamed project to "Riak .NET Client".
  • Renamed namespaces from "CorrugatedIron." to "RiakClient."
  • Removed checks for slashes in key and bucket names (#184).
  • Add extensive list of Riak 2.0 features GH Issue 200
  • Many modifications due to source code checking by StyleCop and FxCop.
  • Added Quorum class to represent quorums rather than uint / string types.

v1.4.2

Protocol Buffers fix

  • Fixed (#171) where protobuf messages weren't making it through GetObject<T>
  • In the process of implementing the fix, found a memory leak in GetObject<T> and another in SetObject<T>

v1.4.1

Maintenance release - just some API clean up, really

  • Support added to bucket properties for Replication Mode (#132)
  • Support added to bucket properties for big_vclock and little_vclock (#131)
  • IRiakClient.Delete accepts a RiakObject (#158) - it's now possible to pass in a full RiakObject and have CorrugatedIron generate the correct RiakObjectId for deletion.

v1.4.0

  • Support for Riak 1.4
  • Bucket properties calls have been moved entirely to the Protocol Buffers interface. Riak 1.3 and earlier users should make sure to set the useHttp parameter to true. This won't make any difference for setting bucket properties - extended was renamed to useHttp.
  • Index pagination (#127)
  • Reseting bucket properties through PB API (#126) - no API change here, we just do it the official way.
  • Counters are available via RiakClient.IncrementCounter and RiakClient.GetCounter. Various counter options are supplied via RiakCounterUpdateOptions and RiakCounterGetOptions. (#125)
  • Removed Either<uint, string> in many Riak*Options classes. Users can still set options quorum options using a string or an integer, but the internal representation has changed. New code should use RiakConstants.QuorumOptions for setting and comparing quorum options.
  • Created RiakIndexResult to deal with new possible riak index results containing either a list of keys or list of key + term pairs. (#142, #128) N.B. this will break CI 1.3.x and earlier range query operations.
    • Existing queries will need to use results.Value.IndexKeyTerms to enumerate through the results of an 2i query.
    • An IndexKeyTerm contains a key and term. term will be empty unless the return_terms query option is used.

v1.3.3

Fixes

  • Issue 123 - Added RiakGetOptions to the IRiakClient interface. This breaks the previous Get methods that relied on the old mechanism using uint for R (the methods were marked as obsolete anyway, so nobody should have been using them.

v1.3.2

Features

  • Enabled the setting of Vector Clock values via an explicit interface implementation. The property was not made writeable as it wasn't something that we felt that most users should use. Casting a RiakObject to an IWriteableVclock interface allows the Vclock to be set.

Fixes

  • Issue 120 - Update both RiakBucketKeyInput and RiakBucketKeyKeyDataInput classes so that their APIs are a little nicer to use. This also results in a bug fix in RiakBucketKeyKeyDataInput where the serialisation was (rather horribly) incorrect.
  • Issue 115 - Fix problem where secondary indexes are not forced to lower case (like they are in Riak).

v1.3.1

This is a small bug fix release.

Fixes

  • Issue 118 - Fix problem where the Riak Search API didn't provide all the fields available when doing searches in Riak.

v1.3.0

This release of CorrugatedIron includes support for all features of Riak 1.3 except for the inclusion of IPv6.

This version also includes a change which "breaks" the interface to integer secondary indexes. This was introduced beacuse integer 2i's in Riak are much bigger than a 32-bit int. This might result in some fun if any of your code is storing your 2i value in a 32-bit integer field. However, in most cases, direct usage of integer literals or comparisons with integer values will work as is because of the built-in implicit conversion from int to BigInteger.

Features

  • Issue 111 - Add support for per-node on-the-fly connections.
  • Issue 109 - Add Binary to the CharSet constants and add some docs.

Fixes

  • Issue 112 - Prevent invalid bucket/keys names.
  • Issue 106 - Fix problem where the arg parameter for Map/Reduce jobs was only supporting string elements. Now supports value types, collections and complex objects.
  • Issue 105 - Fixed 2i implementation to use BigInteger instead of int.

Thanks

This release includes code that has been influenced at least in part by the following community members:

Thanks to all!

v1.2.1

Fixes

  • Issue 103 - Add ListKeysFromIndex to IRiakClient.
  • Issue 100 - Slight refactor of Batch() to use TPL.
  • Issue 94 - Riak 1.3 Reset Bucket Properties functionality.

v1.2.0

Features

We have made significant improvements in working with indexes as well as adding the following API changes:

  • We added two new APIs to the RiakIndex for Map/Reduce inputs - AllKeys and Keys. AllKeys uses the $bucket index to pass all keys into a Map/Reduce job. Keys uses the $key index to pass a list of keys in a range into an Map/Reduce job.
  • We added four IndexGet methods that are wrappers around protocol buffer requests to secondary indices - these make it easy to pull back a list of keys that match a specific index (int, bin, int range, or bin range).
  • GetIndex has been deprecated and will be removed in v1.3, adjust your client calls accordingly to use IndexGet.
  • RiakGetOptions and RiakPutOptions accept either an unsigned integer or one of a set of known strings for R, W, DW, etc. This brings these objects in line with other areas of the API.

Fixes

In addition to the issues listed below, we also fixed a bug where some Riak MapReduce results were being discarded by CorrugatedIron; this made it appear like Riak was exhibiting non-deterministic behavior on all Map/Reduce queries.

We were incorrectly handling Map/Reduce results when multiple tuples were returned within the same protocol buffer message from Riak. CorrugatedIron would only consume a single tuple from each message. This has been fixed within CI.

  • Issue 91 - Remove evidence of LastModifiedDate munging.
  • Issue 90 - Remove minor perf issue in WalkLinks.
  • Issue 89 - Remove unused code CondenseResult.
  • Issue 80 - $key is auto-mucked to $key_bin .
  • Issue 78 - Enabling search via SetBucketProperties() now correctly enabled the search pre-commit hook.
  • Issue 72 - XML documentation is now included in the Nuget package for better support from Intellisense.
  • Issue 71 - Getting extended properties on a new bucket no longer throws exceptions.
  • Issue 67 - Finally added support for the Either<TLeft, TRight> on all options.

Thanks

We have had some great discussion from members of the community which is starting to drive out more interesting ideas and some extended goals for the future of CorrugatedIron. We're grateful for this involvement and hope to see more of it.

v1.1.0

Fixes

  • Issue 69 - Multiple values can now be stored in Secondary Indexes .

v1.0.0

Features

  • Full Riak v1.2 support.
  • Up-to-date PBC interface. If Riak v1.2 can do it, we support it. And we send the correct message format, too.
  • Better secondary index support. We've updated secondary indexes to be first class citizens of CorrugatedIron and not just a manually configured MapReduce input phase.
  • Riak Search support. Our original support for Riak Search was a bit of a mess - users had to write their search queries as strings. We spent a lot of time focusing on getting our Riak Search interface right. Users can create searches using a fluent API. Because we know string mucking is neither fast nor fun we also added the option to compile your searches in CorrugatedIron. Compiling your searches will save a lot of CPU and memory during execution, so start compiling today!
  • Fluent interface all the things! Wherever we could make a fluent interface, we did. Even when it hurt. You're welcome.
  • Even more documentation. We've been on a documentation blitz both on the site and in the code base. We aren't done, but we're getting closer to having 100% API documentation up on the site and present in the code so you can read the docs while your IntelliSense goes crazy.
  • Messy ClientID behavior. There are a lot of crazy things that users can do with a client ID. Originally we punted on the decision and relied on developers to supply a client ID. The default behavior for Riak is to use vnode vector clocks, which removes the need to set a client ID. This removes a lot of pain from a developer's standpoint and we decided to support removing your pain. No more client IDs!
  • Test Coverage. CorrugatedIron v1.0.0 - now with more unit tests.
  • TPL Support. Better support for the Task Parallel Library has been added to the async client interfaces.
  • Custom serializers, deserializers, and sibling resolution. You can supply your own logic to muck with your data and resolve siblings.
  • Clean up. There are too many minor fixes to mention, but you can rest assured that we've been going through the code base cleaning house and trying to make our code presentable and free of comments like HAX GO HERE.
  • Upgraded dependencies. Our protobuf.net and JSON dependencies have been moved to the current versions.
  • Code removal. We marked a number of methods in RiakAsyncClient as obsolete. In addition, while tidying up the interfaces, we updated the Get method to use the RiakGetOptions class. Make sure you check your code for these APIs - we'll be removing them from the code base in a few releases.

Fixes

  • Issue 57 - Set<T>() operations no longer require a content type.
  • Issue 53 - Linux & OSX builds now correctly resolve their deps.

Thanks

While OJ Reeves and Jeremiah Peschka are responsible for the majority of the code, we couldn't have done it without the support of the community. In no particular order, thanks to the following people for their code, ideas, and conversation:

v0.2.1

Features

TCP_NODELAY

We've set TCP_NODELAY on the sockets communicating with Riak. This forces CorrugatedIron into behavior where it won't buffer many small messages (very common when using Protocol Buffers). Instead, CorrugatedIron is going to send data as quickly as it can to Riak.

You can read more about Basho's recommendations and a deeper explanation of Nagle's algorithm

GetIndex

To make life easier for developers we've added a GetIndex method. Developers who want to use this can create a RiakIndexInput object and pass that to the GetIndex method. Under the covers, GetIndex creates a MapReduce job to query the secondary index and then returns a RiakBucketKeyInput object, perfect for feeding to additional MapReduce phases.

var rbki = new RiakIntIndexRangeInput("people", "age", 18, 35);
var targetMarketKeys = client.GetIndex(rbki);

var mr = new RiakMapReduceQuery { ContentType = RiakConstants.ContentTypes.ApplicationJson };

mr.Inputs(targetMarketyKeys);

We think that this will make it easier for developers to work with secondary indexes in Riak.

Configuration

After a bit of work and time on OJ's part (everybody thank OJ), we've pushed out fluent configuration code. The relevant code is in RiakClusterConfiguration, RiakNodeConfiguration, and RiakExternalLoadBalancerConfiguration.

Fixes

Lots that we can't remember! Sorry. We've only just started to make sure we're on top of our release notes as of v1.0.0.