Merge pull request #2383 from basho/ej/kv/2i

Add note on backend choice to secondary index section in dev querying

Author: Lauren

content/riak/kv/2.0.0/developing/getting-started/csharp/querying.md

@@ -124,6 +124,12 @@ intrinsic relationships.
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from an SQL world, Secondary Indexes (2i) are a lot
 like SQL indexes. They are a way to quickly look up objects based on a
 secondary key, without scanning through the whole dataset. This makes it

content/riak/kv/2.0.0/developing/getting-started/erlang/querying.md

@@ -214,6 +214,12 @@ intrinsic relationships.
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from an SQL world, Secondary Indexes (2i) are a lot
 like SQL indexes. They are a way to quickly look up objects based on a
 secondary key, without scanning through the whole dataset. This makes it

content/riak/kv/2.0.0/developing/getting-started/golang/querying.md

@@ -18,7 +18,7 @@ aliases:
 
 ## Go Version Setup
 
-For the Go version, please download the source from GitHub by either [cloning](https://github.com/basho/taste-of-riak) the source code repository or downloading the [current zip of the master branch](https://github.com/basho/taste-of-riak/archive/master.zip). Ensure that the source is located in your `GOPATH`. The code for this chapter is in `go/ch02/ch02.go`. You may import this code into your favorite editor, or just run it from the command line using the `Makefile` if you are running on a *nix OS.
+For the Go version, please download the source from GitHub by either [cloning](https://github.com/basho/taste-of-riak) the source code repository or downloading the [current zip of the master branch](https://github.com/basho/taste-of-riak/archive/master.zip). Ensure that the source is located in your `GOPATH`. The code for this chapter is in `go/ch02/ch02.go`. You may import this code into your favorite editor, or just run it from the command line using the `Makefile` if you are running on a *nix* OS.
 
 >A Quick Note on Querying and Schemas:
 >
@@ -340,7 +340,7 @@ func createOrderSummary(customerId string, orders []*Order) *OrderSummary {
 }
 ```
 
-While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often. It will do double duty by acting as an index for all a customer's orders and also holding some relevant data, such as the order total, etc. If we showed this information in our application often, it's only one extra request to get all the info. 
+While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often. It will do double duty by acting as an index for all a customer's orders and also holding some relevant data, such as the order total, etc. If we showed this information in our application often, it's only one extra request to get all the info.
 
 ```golang
 util.Log.Println("Fetching related data by shared key")
@@ -415,6 +415,12 @@ While this pattern is very easy and extremely fast with respect to queries and c
 
 ### Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from a SQL world, Secondary Indexes (2i) are a lot like SQL indexes. They are a way to quickly look up objects based on a secondary key, without scanning through the whole dataset. This makes it very easy to find groups of related data by values or ranges of values. To properly show this off, we will add some more data to our application, and add some secondary index entries at the same time:
 
 ```golang
@@ -496,7 +502,7 @@ wg.Wait()
 close(doneChan)
 ```
 
-As you may have noticed, ordinary key/value data is opaque to 2i, so we have to add entries to the indexes at the application level. 
+As you may have noticed, ordinary key/value data is opaque to 2i, so we have to add entries to the indexes at the application level.
 
 Now let's find all of Jane Appleseed's processed orders. We'll lookup the orders by searching the `saleperson_id_int` index for Jane's id of `9000`:
 
@@ -564,7 +570,7 @@ Easy!  We used 2i's range feature to search for a range of values, and demonstra
 
 So to recap:
 
-* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key. 
+* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key.
 * Indexes can have either Integer or Binary(String) keys.
 * You can search for specific values or a range of values.
 * Riak will return a list of keys that match the index query.

content/riak/kv/2.0.0/developing/getting-started/java/querying.md

@@ -25,7 +25,7 @@ branch](https://github.com/basho/taste-of-riak/archive/master.zip).
 The code for this chapter is in `/java/Ch02-Schemas-and-Indexes`. You
 may import this code into your favorite editor, or just run it from the
 command line using the commands in `BuildAndRun.sh` if you are running
-on a *nix OS.
+on a *nix* OS.
 
 ## A Quick Note on Querying and Schemas
 
@@ -193,6 +193,12 @@ intrinsic relationships.
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from an SQL world, Secondary Indexes (2i) are a lot
 like SQL indexes. They are a way to quickly look up objects based on a
 secondary key, without scanning through the whole dataset. This makes it

content/riak/kv/2.0.0/developing/getting-started/nodejs/querying.md

@@ -86,6 +86,12 @@ intrinsic relationships.
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from an SQL world, Secondary Indexes (2i) are a lot
 like SQL indexes. They are a way to quickly look up objects based on a
 secondary key, without scanning through the whole dataset. This makes it

content/riak/kv/2.0.0/developing/getting-started/php/querying.md

@@ -94,7 +94,7 @@ class Item
 
 class OrderSummary
 {
-    public function __construct() 
+    public function __construct()
     {
         $this->summaries = array();
     }
@@ -104,7 +104,7 @@ class OrderSummary
 
 class OrderSummaryItem
 {
-    public function __construct(Order $order) 
+    public function __construct(Order $order)
     {
         $this->orderId = $order->orderId;
         $this->total = $order->total;
@@ -141,8 +141,8 @@ $order1->items = [
         15.99
     ),
     new Item(
-        'PEG10BBF2PP', 
-        'eTablet Pro; 24GB; Grey', 
+        'PEG10BBF2PP',
+        'eTablet Pro; 24GB; Grey',
         399.99
     )
 ];
@@ -231,7 +231,7 @@ $storeSummary = (new Command\Builder\StoreObject($riak))
 $storeSummary->execute();
 ```
 
- While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often.  It will do double duty by acting as an index for all a customer's orders, and also holding some relevant data such as the order total, etc.  If we showed this information in our application often, it's only one extra request to get all the info. 
+ While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often.  It will do double duty by acting as an index for all a customer's orders, and also holding some relevant data such as the order total, etc.  If we showed this information in our application often, it's only one extra request to get all the info.
 
 ```php
 // Fetching related data by shared key
@@ -297,6 +297,12 @@ While this pattern is very easy and extremely fast with respect to queries and c
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from a SQL world, Secondary Indexes (2i) are a lot like SQL indexes.  They are a way to quickly lookup objects based on a secondary key, without scanning through the whole dataset.  This makes it very easy to find groups of related data by values, or even ranges of values.  To properly show this off, we will now add some more data to our application, and add some secondary index entries at the same time.
 
 ```php
@@ -323,7 +329,7 @@ unset($key);
 
 ```
 
-As you may have noticed, ordinary Key/Value data is opaque to 2i, so we have to add entries to the indexes at the application level. 
+As you may have noticed, ordinary Key/Value data is opaque to 2i, so we have to add entries to the indexes at the application level.
 Now let's find all of Jane Appleseed's processed orders, we'll lookup the orders by searching the `saleperson_id_int` index for Jane's id of `9000`.
 
 ```php
@@ -354,7 +360,7 @@ Jane processed orders 1 and 3.  We used an "integer" index to reference Jane's i
 Now, let's say that the VP of Sales wants to know how many orders came in during October 2013.  In this case, we can exploit 2i's range queries.  Let's search the `order_date_bin` index for entries between `20131001` and `20131031`.  
 
 ```php
-// Query for orders where the OrderDate bin index is 
+// Query for orders where the OrderDate bin index is
 // between 2013-10-01 and 2013-10-31
 $fetchOctoberOrders = (new Command\Builder\QueryIndex($riak))
                         ->inBucket($ordersBucket)
@@ -392,7 +398,7 @@ Boom, easy-peasy.  We used 2i's range feature to search for a range of values, a
 
 So to recap:
 
-* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key. 
+* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key.
 * Indexes can have either Integer or Binary(String) keys
 * You can search for specific values, or a range of values
 * Riak will return a list of keys (and terms if needed) that match the index query

content/riak/kv/2.0.0/developing/getting-started/python/querying.md

@@ -150,7 +150,7 @@ os = order_summary_bucket.new(str(order_summary['customer_id']),
 os.store()
 ```
 
- While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often.  It will do double duty by acting as an index for all customer orders, and also holding some relevant data such as the order total, etc.  If we showed this information in our application often, it's only one extra request to get all the info. 
+ While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often.  It will do double duty by acting as an index for all customer orders, and also holding some relevant data such as the order total, etc.  If we showed this information in our application often, it's only one extra request to get all the info.
 
 ```python
 customer = customer_bucket.get('1').data
@@ -162,15 +162,15 @@ Which returns our amalgamated objects:
 
 ```python
 {
-  u'city': u'Columbus', u'name': u'John Smith', u'zip': u'43210', 
-  u'created_date': u'2013-10-01 14:30:26', 
-  'order_summary': { 
+  u'city': u'Columbus', u'name': u'John Smith', u'zip': u'43210',
+  u'created_date': u'2013-10-01 14:30:26',
+  'order_summary': {
     u'customer_id': 1, u'summaries': [
-      {u'order_id': 1, u'order_date': u'2013-10-01 14:42:26', u'total': 415.98}, 
-      {u'order_id': 2, u'order_date': u'2013-10-15 16:43:16', u'total': 359.99}, 
+      {u'order_id': 1, u'order_date': u'2013-10-01 14:42:26', u'total': 415.98},
+      {u'order_id': 2, u'order_date': u'2013-10-15 16:43:16', u'total': 359.99},
       {u'order_id': 3, u'order_date': u'2013-11-03 17:45:28', u'total': 74.98}
-    ]}, 
-  u'phone': u'+1-614-555-5555', u'state': u'Ohio', u'address': u'123 Main Street', 
+    ]},
+  u'phone': u'+1-614-555-5555', u'state': u'Ohio', u'address': u'123 Main Street',
   u'customer_id': 1
 }
 ```
@@ -180,6 +180,12 @@ While this pattern is very easy and extremely fast with respect to queries and c
 
 ### Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from a SQL world, Secondary Indexes (2i) are a lot like SQL indexes.  They are a way to quickly lookup objects based on a secondary key, without scanning through the whole dataset.  This makes it very easy to find groups of related data by values, or even ranges of values.  To properly show this off, we will now add some more data to our application, and add some secondary index entries at the same time.
 
 ```python
@@ -191,7 +197,7 @@ for i in range(1, 4):
     order.store()
 ```
 
-As you may have noticed, ordinary Key/Value data is opaque to 2i, so we have to add entries to the indexes at the application level. 
+As you may have noticed, ordinary Key/Value data is opaque to 2i, so we have to add entries to the indexes at the application level.
 Now let's find all of Jane Appleseed's processed orders, we'll lookup the orders by searching the `saleperson_id_int` index for Jane's id of `9000`.
 
 ```python
@@ -224,7 +230,7 @@ Boom, easy-peasy.  We used 2i's range feature to search for a range of values, a
 
 So to recap:
 
-* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key. 
+* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key.
 * Indexes can have either Integer or Binary(String) keys
 * You can search for specific values, or a range of values
 * Riak will return a list of keys that match the index query

content/riak/kv/2.0.0/developing/getting-started/ruby/querying.md

@@ -149,7 +149,7 @@ os.data = order_summary
 os.store
 ```
 
- While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often.  It will do double duty by acting as an index for all a customer's orders, and also holding some relevant data such as the order total, etc.  If we showed this information in our application often, it's only one extra request to get all the info. 
+ While individual `Customer` and `Order` objects don't change much (or shouldn't change), the `Order Summaries` object will likely change often.  It will do double duty by acting as an index for all a customer's orders, and also holding some relevant data such as the order total, etc.  If we showed this information in our application often, it's only one extra request to get all the info.
 
 ```ruby
 shared_key = '1'
@@ -190,6 +190,12 @@ While this pattern is very easy and extremely fast with respect to queries and c
 
 ### Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.0/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.0/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.0/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.0/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from a SQL world, Secondary Indexes (2i) are a lot like SQL indexes.  They are a way to quickly lookup objects based on a secondary key, without scanning through the whole dataset.  This makes it very easy to find groups of related data by values, or even ranges of values.  To properly show this off, we will now add some more data to our application, and add some secondary index entries at the same time.
 
 ```ruby
@@ -206,7 +212,7 @@ If you're coming from a SQL world, Secondary Indexes (2i) are a lot like SQL ind
 end
 ```
 
-As you may have noticed, ordinary Key/Value data is opaque to 2i, so we have to add entries to the indexes at the application level. 
+As you may have noticed, ordinary Key/Value data is opaque to 2i, so we have to add entries to the indexes at the application level.
 Now let's find all of Jane Appleseed's processed orders, we'll lookup the orders by searching the `saleperson_id_int` index for Jane's id of `9000`.
 
 ```ruby
@@ -240,7 +246,7 @@ Boom, easy-peasy.  We used 2i's range feature to search for a range of values, a
 
 So to recap:
 
-* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key. 
+* You can use Secondary Indexes to quickly lookup an object based on a secondary id other than the object's key.
 * Indexes can have either Integer or Binary(String) keys
 * You can search for specific values, or a range of values
 * Riak will return a list of keys that match the index query

content/riak/kv/2.0.1/developing/getting-started/csharp/querying.md

@@ -124,6 +124,12 @@ intrinsic relationships.
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.1/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.1/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.1/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.1/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from an SQL world, Secondary Indexes (2i) are a lot
 like SQL indexes. They are a way to quickly look up objects based on a
 secondary key, without scanning through the whole dataset. This makes it

content/riak/kv/2.0.1/developing/getting-started/erlang/querying.md

@@ -214,6 +214,12 @@ intrinsic relationships.
 
 ## Secondary Indexes
 
+{{% note %}}
+Secondary indexes in Riak KV require a sorted backend: [Memory](/riak/kv/2.0.1/setup/planning/backend/memory) or [LevelDB](/riak/kv/2.0.1/setup/planning/backend/leveldb). [Bitcask](/riak/kv/2.0.1/setup/planning/backend/bitcask) does not support secondary indexes.
+
+See [Using Secondary Indexes (2i)](/riak/kv/2.0.1/developing/usage/secondary-indexes) for more information on developing with secondary indexes.
+{{% /note %}}
+
 If you're coming from an SQL world, Secondary Indexes (2i) are a lot
 like SQL indexes. They are a way to quickly look up objects based on a
 secondary key, without scanning through the whole dataset. This makes it