hallelujah-cassandra 0.12.3

data/CHANGELOG

@@ -0,0 +1,111 @@
+v0.12.3
+- Add 1.1
+
+v0.12.2
+- Respect the start_key in get_range. Resolves Issue #127.
+- Fix issue with differences in gemspec and what is required. Resolves Issue #125.
+- Update to Cassandra 0.8.7 and 1.0.2.
+
+v0.12.1
+- Fix issue with simple_uuid dependency.
+- Fix issue with get_range & get_range_batch keeping all results when a block is given. Resolves Issue# 112.
+
+v0.12.0 Changed thrift_client dependency to 0.7.0
+
+v0.11.4
+- Fix get_range to invoke blocks
+- Fix current distribution urls in Rakfile. Resolves Issue# 97.
+
+v0.11.3
+- Fix login after reconnect
+
+v0.11.2
+- Update thrift_client gem to deal with failover bug.
+
+v0.11.1
+- Add counter support for Cassandra 0.8. (Thanks Swrve team!)
+- Add additional rake tasks to start and stop cassandra in the background.
+- Fix issue with non-utf8 column names not being encoded/decoded properly.
+- Add way to specify a default read/write consistency.
+- Consolidate 0.7 and 0.8 functions, and move 0.6 specific functions into lib/cassandra/0.6/
+- Use 0.8-rc1 as 0.8 install target.
+- Updated get_index_slices API to allow passing an array of hashes instead of IndexClause instance. (Maintains backward compatibility.)
+- Fix permissions issue.
+
+v0.11.0
+- Remove direct thrift dependency. Allow thrift_client to require it.
+- Add functions for each and each_key to iterate through key ranges.
+- Add function for get_range_keys which returns an array of keys in a given range.
+- Changed the return value of get_range to an OrderedHash.
+- Change get_range to accept both a range of keys and a range of columns.
+- Add batched range support to get_range and add get_range_batch.
+
+v0.10.0 Major Update (rjackson)
+- Update Rakefile to install 0.6.13, 0.7.4, 0.8.0-beta1 to ~/cassandra/cassandra-VERSION
+- Add data:load task to Rakefile for creating the schema required for the tests
+- Default the Rakefile to use 0.8-beta1
+- Setup test suite to work on 0.6.13, 0.7.4, and 0.8.0-beta1
+- All tests pass for all supported (0.6.13, 0.7.4, 0.8.0-beta1) versions.
+- Added Support for 0.8-beta1
+- Changed get_index_slices to return a hash of rows
+- Updated Cassandra::Mock to pass all tests for each Cassandra version
+
+v0.9.2 fix bug with deletions in batch mutations
+
+v0.9.1 Support for secondary indexing. (jhermes)
+Fix bug in mock where we didn't support range queries. (therealadam)
+Support deletes in batch mutations. [blanquer]
+
+v0.9.0 cassandra 0.7 compat
+
+v0.8.2 Renamed :thrift_client_class option, UUID fix, 0.6 update, fixing cassanda install, much Mock fixes
+
+v0.8.1 Adding the ability to compose ThriftClient classes.
+
+v0.8.0 Compatibility with Cassandra 0.6 betas (no longer compatible with 0.5); assorted bugfixes.
+
+v0.7.6 Bugfixes.
+
+v0.7.5 Another packaging error.
+
+v0.7.4 Fix thrift_client dependency
+
+v0.7.3 New Cassandra::Mock - a pure ruby mock of cassanra; bugfixes.
+
+v0.7.2 Switch to newly-extraced simple_uuid gem, minor bugfixes.
+
+v0.7.1 update thrift-generated code to 0.5
+
+v0.7 Various improvements.
+- Compatibility with Cassandra 0.5.
+- performance improvements
+
+v0.6. Use thrift_client gem.
+
+v0.5.6.2. Release process was busted.
+
+v0.5.6. Real multiget.
+
+v0.5.5. to_guid for Long. Don't continually re-checkout the Git mirror. Use curl instead of wget, sigh. Use new unified insert API.
+
+v0.5.4. Use wget instead of curl.
+
+v0.5.3. Update Multiblog sample schema.
+
+v0.5.2. Update server version so CommitLog replay is fixed.
+
+v0.5.1. Add bin/cassandra_helper script, to build and start the server for you. Improve build error reporting.
+
+v0.5. More API changes. Working temporal comparators.
+
+v0.4. Use new comparator API. Namespace Thrift bindings; rename gem and class to Cassandra. Make tokens and limits actually work. Retry UnavailableExceptions.
+
+v0.3. Use new Thrift API.
+
+v0.2.2. Use nil for empty byte array, not empty string. Improves API.
+
+v0.2.1. Don't write serialization overhead on nulls.
+
+v0.2. Re-factor table vs. column family interface per discussion with jbellis.
+
+v0.1. First release.

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'echoe'
+  gem 'eventmachine'
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Manifest

@@ -0,0 +1,91 @@
+CHANGELOG
+Gemfile
+LICENSE
+Manifest
+README.md
+Rakefile
+bin/cassandra_helper
+conf/0.6/cassandra.in.sh
+conf/0.6/log4j.properties
+conf/0.6/schema.json
+conf/0.6/storage-conf.xml
+conf/0.7/cassandra.in.sh
+conf/0.7/cassandra.yaml
+conf/0.7/log4j-server.properties
+conf/0.7/schema.json
+conf/0.7/schema.txt
+conf/0.8/cassandra.in.sh
+conf/0.8/cassandra.yaml
+conf/0.8/log4j-server.properties
+conf/0.8/schema.json
+conf/0.8/schema.txt
+conf/1.0/cassandra.in.sh
+conf/1.0/cassandra.yaml
+conf/1.0/log4j-server.properties
+conf/1.0/schema.json
+conf/1.0/schema.txt
+conf/1.1/cassandra.in.sh
+conf/1.1/cassandra.yaml
+conf/1.1/log4j-server.properties
+conf/1.1/schema.json
+conf/1.1/schema.txt
+hallelujah-cassandra.gemspec
+lib/cassandra.rb
+lib/cassandra/0.6.rb
+lib/cassandra/0.6/cassandra.rb
+lib/cassandra/0.6/columns.rb
+lib/cassandra/0.6/protocol.rb
+lib/cassandra/0.7.rb
+lib/cassandra/0.7/cassandra.rb
+lib/cassandra/0.7/columns.rb
+lib/cassandra/0.7/protocol.rb
+lib/cassandra/0.8.rb
+lib/cassandra/0.8/cassandra.rb
+lib/cassandra/0.8/columns.rb
+lib/cassandra/0.8/protocol.rb
+lib/cassandra/1.0.rb
+lib/cassandra/1.0/cassandra.rb
+lib/cassandra/1.0/columns.rb
+lib/cassandra/1.0/protocol.rb
+lib/cassandra/1.1.rb
+lib/cassandra/1.1/cassandra.rb
+lib/cassandra/1.1/columns.rb
+lib/cassandra/1.1/protocol.rb
+lib/cassandra/array.rb
+lib/cassandra/cassandra.rb
+lib/cassandra/column_family.rb
+lib/cassandra/columns.rb
+lib/cassandra/comparable.rb
+lib/cassandra/composite.rb
+lib/cassandra/constants.rb
+lib/cassandra/debug.rb
+lib/cassandra/helpers.rb
+lib/cassandra/keyspace.rb
+lib/cassandra/long.rb
+lib/cassandra/mock.rb
+lib/cassandra/ordered_hash.rb
+lib/cassandra/protocol.rb
+lib/cassandra/time.rb
+test/cassandra_client_test.rb
+test/cassandra_mock_test.rb
+test/cassandra_test.rb
+test/comparable_types_test.rb
+test/composite_type_test.rb
+test/eventmachine_test.rb
+test/ordered_hash_test.rb
+test/test_helper.rb
+vendor/0.6/gen-rb/cassandra.rb
+vendor/0.6/gen-rb/cassandra_constants.rb
+vendor/0.6/gen-rb/cassandra_types.rb
+vendor/0.7/gen-rb/cassandra.rb
+vendor/0.7/gen-rb/cassandra_constants.rb
+vendor/0.7/gen-rb/cassandra_types.rb
+vendor/0.8/gen-rb/cassandra.rb
+vendor/0.8/gen-rb/cassandra_constants.rb
+vendor/0.8/gen-rb/cassandra_types.rb
+vendor/1.0/gen-rb/cassandra.rb
+vendor/1.0/gen-rb/cassandra_constants.rb
+vendor/1.0/gen-rb/cassandra_types.rb
+vendor/1.1/gen-rb/cassandra.rb
+vendor/1.1/gen-rb/cassandra_constants.rb
+vendor/1.1/gen-rb/cassandra_types.rb

data/README.md

@@ -0,0 +1,352 @@
+# cassandra
+A Ruby client for the Cassandra distributed database.
+
+Supports 1.8.7, 1.9.2, and rubinius on Cassandra 0.6.13, 0.7.9, 0.8.6, 1.0.0-rc2.
+
+## Getting Started
+
+Here is a quick sample of the general use (more details in Read/Write
+API below):
+
+    require 'cassandra'
+    client = Cassandra.new('Twitter', '127.0.0.1:9160')
+    client.insert(:Users, "5", {'screen_name' => "buttonscat"})
+
+## License
+
+Copyright 2009-2011 Twitter, Inc. See included LICENSE file. Portions copyright 2004-2009 David Heinemeier Hansson, and used with permission.
+
+## Cassandra Version
+
+The Cassandra project is under very active development, and as such
+there are a few different versions that you may need to use this gem
+with.  We have set up an easy sure fire mechanism for selecting the
+specific version that you are connecting to while requiring the gem.
+
+#### Require Method
+The default version is the currently stable release of cassandra.  (0.8
+at this time.)
+
+To use the default version simply use a normal require:
+
+    require 'cassandra'
+
+To use a specific version (1.0 in this example) you would use a
+slightly differently formatted require:
+
+    require 'cassandra/1.0'
+
+#### Environment Variable Method
+These mechanisms work well when you are using the cassandra gem in your
+own projects or irb, but if you would rather not hard code your app to a
+specific version you can always specify an environment variable with the
+version you are using:
+
+    export CASSANDRA_VERSION=0.8
+
+Then you would use the default require as listed above:
+
+    require 'cassandra'
+
+## Read/Write API Method Reference
+
+### insert
+
+* column\_family - The column\_family that you are inserting into.
+* key - The row key to insert.
+* hash - The columns or super columns to insert.
+* options - Valid options are:
+  * :timestamp - Uses the current time if none specified.
+  * :consistency - Uses the default write consistency if none specified.
+  * :ttl - If specified this is the number of seconds after the insert that this value will be available.
+
+This is the main method used to insert rows into cassandra. If the
+column\_family that you are inserting into is a SuperColumnFamily then
+the hash passed in should be a nested hash, otherwise it should be a
+flat hash.
+
+This method can also be called while in batch mode. If in batch mode
+then we queue up the mutations (an insert in this case) and pass them to
+cassandra in a single batch at the end of the block.
+
+Example:
+
+    @client.insert(:Statuses, key, {'body' => 'v', 'user' => 'v'})
+
+    columns = {@uuids[1] => 'v1', @uuids[2] => 'v2'}
+    @client.insert(:StatusRelationships, key, {'user_timelines' => columns})
+
+
+### remove
+
+* column\_family - The column\_family that you are working with.
+* key - The row key to remove (or remove columns from).
+* columns - Either a single super_column or a list of columns to remove.
+* sub_columns - The list of sub\_columns to remove.
+* options - Valid options are:
+  * :timestamp - Uses the current time if none specified.
+  * :consistency - Uses the default write consistency if none specified.
+
+This method is used to delete (actually marking them as deleted with a
+tombstone) rows, columns, or super columns depending on the parameters
+passed.  If only a key is passed the entire row will be marked as deleted.
+If a column name is passed in that column will be deleted.
+
+Example:
+
+    @client.insert(:Statuses, key, {'body' => 'v', 'subject' => 'v'})
+
+    @client.remove(:Statuses, key, 'body')    # removes the 'body' column
+    @client.remove(:Statuses, key)            # removes the row
+
+### count\_columns
+
+Count the columns for the provided parameters.
+
+* column\_family - The column\_family that you are working with.
+* key - The row key.
+* columns - Either a single super_column or a list of columns.
+* sub_columns - The list of sub\_columns to select.
+* options - Valid options are:
+  * :start - The column name to start from.
+  * :stop - The column name to stop at.
+  * :count - The maximum count of columns to return. (By default cassandra will count up to 100 columns)
+  * :consistency - Uses the default read consistency if none specified.
+
+Example:
+
+    @client.insert(:Statuses, key, {'body' => 'v1', 'user' => 'v2'})
+    @client.count_columns(:Statuses, key)     # returns 2
+
+### get
+
+Return a hash (actually, a Cassandra::OrderedHash) or a single value
+representing the element at the column_family:key:[column]:[sub_column]
+path you request.
+
+* column\_family - The column\_family that you are working with.
+* key - The row key to select.
+* columns - Either a single super\_column or a list of columns.
+* sub\_columns - The list of sub\_columns to select.
+* options - Valid options are:
+  * :count    - The number of columns requested to be returned.
+  * :start    - The starting value for selecting a range of columns.
+  * :finish   - The final value for selecting a range of columns.
+  * :reversed - If set to true the results will be returned in
+                reverse order.
+  * :consistency - Uses the default read consistency if none specified.
+
+Example:
+
+    @client.insert(:Users, key, {'body' => 'v', 'user' => 'v'})
+    @client.get(:Users, key))           # returns {'body' => 'v', 'user' => 'v'}
+
+### multi\_get
+
+Multi-key version of Cassandra#get.
+
+This method allows you to select multiple rows with a single query.
+If a key that is passed in doesn't exist an empty hash will be
+returned.
+
+Supports the same parameters as Cassandra#get.
+
+* column_family - The column_family that you are working with.
+* key - An array of keys to select.
+* columns - Either a single super_column or a list of columns.
+* sub_columns - The list of sub\_columns to select.
+* options - Valid options are:
+  * :count    - The number of columns requested to be returned.
+  * :start    - The starting value for selecting a range of columns.
+  * :finish   - The final value for selecting a range of columns.
+  * :reversed - If set to true the results will be returned in reverse order.
+  * :consistency - Uses the default read consistency if none specified.
+
+Example:
+
+    @client.insert(:Users, '1', {'body' => 'v1', 'user' => 'v1'})
+    @client.insert(:Users, '2', {'body' => 'v2', 'user' => 'v2'})
+
+    expected = OrderedHash[
+                  '1', {'body' => 'v1', 'user' => 'v1'},
+                  '2', {'body' => 'v2', 'user' => 'v2'},
+                  'bogus', {}
+              ]
+    result = @client.multi_get(:Users, ['1', '2', 'bogus'])
+
+### exists?
+
+Return true if the column\_family:key:[column]:[sub\_column] path you
+request exists.
+
+If passed in only a row key it will query for any columns (limiting
+to 1) for that row key. If a column is passed in it will query for
+that specific column/super column.
+
+This method will return true or false.
+
+* column\_family - The column\_family that you are working with.
+* key - The row key to check.
+* columns - Either a single super\_column or a list of columns.
+* sub\_columns - The list of sub\_columns to check.
+* options - Valid options are:
+  * :consistency - Uses the default read consistency if none specified.
+
+Example:
+
+    @client.insert(:Statuses, 'key', {'body' => 'v'})
+    @client.exists?(:Statuses, 'key')                   # returns true
+    @client.exists?(:Statuses, 'bogus')                 # returns false
+    @client.exists?(:Statuses, 'key', 'body')           # returns true
+    @client.exists?(:Statuses, 'key', 'bogus')          # returns false
+
+### get\_range
+Return an Cassandra::OrderedHash containing the columns specified for the given
+range of keys in the column\_family you request.
+
+This method is just a convenience wrapper around Cassandra#get_range_single
+and Cassandra#get\_range\_batch. If :key\_size, :batch\_size, or a block
+is passed in Cassandra#get\_range\_batch will be called. Otherwise
+Cassandra#get\_range\_single will be used.
+
+The start\_key and finish\_key parameters are only useful for iterating of all records
+as is done in the Cassandra#each and Cassandra#each\_key methods if you are using the
+RandomPartitioner.
+
+If the table is partitioned with OrderPreservingPartitioner you may
+use the start\_key and finish\_key params to select all records with
+the same prefix value.
+
+If a block is passed in we will yield the row key and columns for
+each record returned.
+
+Please note that Cassandra returns a row for each row that has existed in the
+system since gc\_grace\_seconds. This is because deleted row keys are marked as
+deleted, but left in the system until the cluster has had resonable time to replicate the deletion.
+This function attempts to suppress deleted rows (actually any row returned without
+columns is suppressed).
+
+* column\_family - The column\_family that you are working with.
+* options - Valid options are:
+  * :start\_key    - The starting value for selecting a range of keys (only useful with OPP).
+  * :finish\_key   - The final value for selecting a range of keys (only useful with OPP).
+  * :key\_count    - The total number of keys to return from the query. (see note regarding deleted records)
+  * :batch\_size   - The maximum number of keys to return per query. If specified will loop until :key\_count is obtained or all records have been returned.
+  * :columns      - A list of columns to return.
+  * :count        - The number of columns requested to be returned.
+  * :start        - The starting value for selecting a range of columns.
+  * :finish       - The final value for selecting a range of columns.
+  * :reversed     - If set to true the results will be returned in reverse order.
+  * :consistency  - Uses the default read consistency if none specified.
+
+Example:
+
+    10.times do |i|
+      @client.insert(:Statuses, i.to_s, {'body' => '1'})
+    end
+
+    @client.get_range_keys(:Statuses, :key_count => 4)
+
+    # returns:
+    #{
+    #  '0' => {'body' => '1'},
+    #  '1' => {'body' => '1'},
+    #  '2' => {'body' => '1'},
+    #  '3' => {'body' => '1'}
+    #}
+
+### count\_range
+
+Return an Array containing all of the keys within a given range.
+
+This method just calls Cassandra#get\_range and returns the
+row keys for the records returned.
+
+See Cassandra#get\_range for options.
+
+### get\_range\_keys
+
+Return an Array containing all of the keys within a given range.
+
+This method just calls Cassandra#get\_range and returns the
+row keys for the records returned.
+
+See Cassandra#get\_range for options.
+
+### each\_key
+Iterate through each key within the given range parameters. This function can be
+used to iterate over each key in the given column family.
+
+This method just calls Cassandra#get\_range and yields each row key.
+
+See Cassandra#get\_range for options.
+
+Example:
+    10.times do |i|
+      @client.insert(:Statuses, k + i.to_s, {"body-#{i.to_s}" => 'v'})
+    end
+
+    @client.each_key(:Statuses) do |key|
+      print key
+    end
+
+    # returns 0123456789
+
+### each
+Iterate through each row within the given column\_family.
+
+This method just calls Cassandra#get\_range and yields the key and
+columns.
+
+See Cassandra#get\_range for options.
+
+### get\_index\_slices
+This method is used to query a secondary index with a set of
+provided search parameters
+
+Please note that you can either specify a
+CassandraThrift::IndexClause or an array of hashes with the
+format as below.
+
+* column\_family     - The Column Family this operation will be run on.
+* index\_clause      - This can either be a CassandraThrift::IndexClause or an array of hashes with the following keys:
+  * :column\_name - Column to be compared
+  * :value       - Value to compare against
+  * :comparison  - Type of comparison to do.
+* options
+  * :key\_count    - Set maximum number of rows to return. (Only works if CassandraThrift::IndexClause is not passed in.)
+  * :key\_start    - Set starting row key for search. (Only works if CassandraThrift::IndexClause is not passed in.)
+  * :consistency
+
+Example:
+
+    @client.create_index('Twitter', 'Statuses', 'x', 'LongType')
+
+    @client.insert(:Statuses, 'row1', { 'x' => [0,10].pack("NN")  })
+
+    (2..10).to_a.each do |i|
+      @twitter.insert(:Statuses, 'row' + i.to_s, { 'x' => [0,20].pack("NN"), 'non_indexed' => [i].pack('N*') })
+    end
+
+    @client.insert(:Statuses, 'row11', { 'x' => [0,30].pack("NN")  })
+
+    expressions = [{:column_name => 'x', :value => [0,20].pack("NN"), :comparison => "=="}]
+
+    # verify multiples will be returned
+    @client.get_indexed_slices(:Statuses, expressions).length       # returns 9
+
+    # verify that GT and LT queries perform properly
+    expressions   =  [
+                      { :column_name => 'x',
+                        :value => [0,20].pack("NN"),
+                        :comparison => "=="},
+                      { :column_name => 'non_indexed',
+                        :value => [5].pack("N*"),
+                        :comparison => ">"}
+                    ]
+
+    @client.get_indexed_slices(:Statuses, expressions).length       # returns 5
+
+## Reporting Problems
+
+The Github issue tracker is [here](http://github.com/twitter/cassandra/issues). If you have problems with this library or Cassandra itself, please use the [cassandra-user mailing list](http://mail-archives.apache.org/mod_mbox/incubator-cassandra-user/).