hbase-adapter 0.0.1

data/LICENSE.txt

@@ -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 2010 Andrew O'Brien
+
+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/README.textile

@@ -0,0 +1,52 @@
+h1. HBase Adapter
+
+Wrapping up all of that HBase Thrift stuff so you can use it.
+
+h2. Dependencies
+
+Install HBase and Thrift normally (for some definition of "normally" for your platform).  This code was developed against HBase 0.20.5
+
+gem install hbase-thrift
+
+h2. Alpha
+
+This is very alpha and may not be production ready.  Contributions are welcome though.
+
+h2. TODO
+
+h3. Thrift
+
+All Thrift structures and services (even redundant ones) are represented as more idiomatic Ruby classes and methods except the following:
+
+Thrift data structures:
+
+* Some of the attributes on ColumnDescriptor
+* TRegionInfo: probably just going to wrap in something with Ruby style attribute names.
+
+Thrift service methods:
+
+* atomicIncrement (spec'd & implemented, but there's a Java error)
+* scannerOpen
+* scannerOpenWithStop 
+* scannerOpenWithPrefix
+* scannerOpenTs 
+* scannerOpenWithStopTs
+* scannerGet
+* scannerGetList
+* scannerClose
+
+h3. Documentation
+
+Some documentation would be good...
+
+h3. Other
+
+A lot of the code could be DRYer.  Also, I'd like to make it so we don't have to keep dropping and creating tables in tests.
+
+h2. Contributing
+
+Fork the repository at http://github.com/AndrewO/hbase-adapter and send me a pull request.
+
+Happy hacking.
+
+–Andrew O'Brien

data/lib/core_ext/time_ext.rb

@@ -0,0 +1,5 @@
+class Time
+  def to_i64
+    (self.to_f * 1000).to_i
+  end
+end

data/lib/hbase-adapter.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'hbase-thrift'
+
+module HbaseAdapter
+  IOError = Apache::Hadoop::Hbase::Thrift::IOError
+  IllegalArgument = Apache::Hadoop::Hbase::Thrift::IllegalArgument
+  TableAlreadyExists = Apache::Hadoop::Hbase::Thrift::AlreadyExists
+end
+
+require 'core_ext/time_ext'
+
+require 'hbase_adapter/connection'
+require 'hbase_adapter/table'
+require 'hbase_adapter/column_family'
+require 'hbase_adapter/row'
+require 'hbase_adapter/mutation'

data/lib/hbase_adapter/cell.rb

@@ -0,0 +1,24 @@
+module HbaseAdapter
+  class Cell
+    attr_reader :connection, :row, :col_name, :cell
+
+    def initialize(connection, row, col_name, cell)
+      @connection, @row, @col_name, @cell = connection, row, col_name.to_sym, cell
+    end
+
+    def timestamp
+      cell.timestamp
+    end
+    
+    def value
+      cell.value
+    end
+    
+    # Causes HBase to freak out with an ArrayIndexOutOfBoundsException.  Have no idea if it's my fault, but ignoring for now
+    # def incr!(incr_val = 1)
+    #   connection.client.atomicIncrement(row.table.name.to_s, row.key.to_s, col_name.to_s, incr_val)
+    # end
+    
+    # TODO: easy version access
+  end
+end

data/lib/hbase_adapter/column_family.rb

@@ -0,0 +1,35 @@
+module HbaseAdapter
+  class ColumnFamily
+    KEY_MAP = {
+      :name => :name,
+      :max_versions => :maxVersions
+    }
+    
+    class << self
+      def translate_hash(hash)
+        Hash[*(hash.map {|(k,v)| [KEY_MAP[k.to_sym], v]}.flatten)]
+      end
+    end
+    
+    attr_reader :column_descriptor
+    def initialize(args = {})
+      @column_descriptor = case args
+      when Apache::Hadoop::Hbase::Thrift::ColumnDescriptor
+        args
+      when Hash
+        Apache::Hadoop::Hbase::Thrift::ColumnDescriptor.new(self.class.translate_hash(args))
+      end
+    end
+    
+    def name
+      column_descriptor.name
+    end
+    
+    def max_versions
+      column_descriptor.maxVersions
+    end
+    
+    # TODO: support other keys
+    # TODO: use delegator
+  end
+end

data/lib/hbase_adapter/connection.rb

@@ -0,0 +1,52 @@
+require 'hbase_adapter/table'
+
+module HbaseAdapter
+  class Connection
+    attr_reader :host, :port
+
+    def initialize(options)
+      @host = options[:host] || options["host"]
+      @port = options[:port] || options["port"]
+      
+      @client = nil
+    end
+
+    def connected? 
+      @client
+    end
+
+    def client
+      connect! unless connected?
+      @client
+    end
+
+    def connect!
+      t = Thrift::BufferedTransport.new(Thrift::Socket.new(host, port))
+      p = Thrift::BinaryProtocol.new(t)
+      c = Apache::Hadoop::Hbase::Thrift::Hbase::Client.new(p)
+      t.open
+      
+      @client = c
+    end
+
+    def table_names
+      client.getTableNames
+    end
+    
+    def tables
+      table_names.inject({}) do|hash, table_name|
+        hash[table_name.to_sym] = HbaseAdapter::Table.new(client, table_name)
+        hash
+      end
+    end
+    
+    def create_table!(table_name, *column_families)
+      client.createTable(table_name.to_s, column_families.map {|cd| cd.column_descriptor})
+    end
+    
+    def delete_table!(table_name)
+      client.disableTable(table_name.to_s)
+      client.deleteTable(table_name.to_s)
+    end
+  end
+end

data/lib/hbase_adapter/mutation.rb

@@ -0,0 +1,85 @@
+module HbaseAdapter
+  class Mutation
+    attr_reader :column, :value
+    
+    def initialize(column)
+      @column = column
+      @value = nil
+    end
+    
+    def is_delete?
+      false
+    end
+    
+    def to_thrift
+      Apache::Hadoop::Hbase::Thrift::Mutation.new(
+        :isDelete => is_delete?,
+        :column => column,
+        :value => value
+      )
+    end
+  end
+  
+  class UpdateMutation < Mutation
+    def initialize(column, value)
+      super(column)
+      @value = value
+    end
+  end
+  
+  class DeleteMutation < Mutation
+    def is_delete?
+      true
+    end
+  end
+  
+  class MutationList
+    def initialize(&blk)
+      @mutations = []
+      
+      self.instance_eval(&blk)
+    end
+    
+    def batch_mutation(key, &blk)
+      @mutations << BatchMutation.new(key, &blk)
+    end
+    
+    def update(column, value)
+      @mutations << UpdateMutation.new(column, value)
+    end
+    
+    def delete(column)
+      @mutations << DeleteMutation.new(column)
+    end
+    
+    def to_thrift
+      @mutations.map {|m| m.to_thrift}
+    end
+  end
+  
+  class BatchMutation
+    attr_reader :key, :mutations
+    
+    def initialize(key, &blk)
+      @key = key
+      @mutations = []
+      
+      self.instance_eval(&blk)
+    end
+
+    def update(column, value)
+      @mutations << UpdateMutation.new(column, value)
+    end
+    
+    def delete(column)
+      @mutations << DeleteMutation.new(column)
+    end
+    
+    def to_thrift
+      Apache::Hadoop::Hbase::Thrift::BatchMutation.new(
+        :row => key,
+        :mutations => mutations.map {|m| m.to_thrift}
+      )
+    end
+  end
+end

data/lib/hbase_adapter/row.rb

@@ -0,0 +1,88 @@
+require 'hbase_adapter/cell'
+require 'hbase_adapter/mutation'
+
+module HbaseAdapter
+  class Row
+    attr_reader :connection, :table, :key
+
+    def initialize(connection, table, key)
+      @connection = connection
+      @table = table
+      @key = key
+    end
+
+    def [](column, options = {})
+      num_versions = options[:num_versions]
+      timestamp = options[:timestamp]
+
+      if num_versions.nil? && timestamp.nil?
+        # One column, no options.  Simple get.  Return a single cell
+        tcell = connection.client.get(table.name, key, column).first
+        HbaseAdapter::Cell.new(connection, self, column, tcell) if tcell
+      else
+        if timestamp.nil?
+          # One column, versions specified.  getVer
+          tcells = connection.client.getVer(table.name, key, column, num_versions)
+        else
+          # One column, versions specified, max time specified.  getVerTs
+          tcells = connection.client.getVerTs(table.name, key, column, timestamp.to_i64, num_versions)
+        end
+        
+        tcells.compact.map {|tcell| HbaseAdapter::Cell.new(connection, self, column, tcell)}
+      end
+    end
+    
+    def cells(*columns)
+      options = columns.pop if columns.last.is_a?(Hash)
+      options ||= {}
+      timestamp = options[:timestamp]
+      
+      if columns.empty?
+        if timestamp.nil?
+          # getRow
+          trow_results = connection.client.getRow(table.name, key)
+        else
+          # getRowTs
+          trow_results = connection.client.getRowTs(table.name, key, timestamp.to_i64)
+        end
+      else
+        if timestamp.nil?
+          # getRowWithColumns
+          trow_results = connection.client.getRowWithColumns(table.name, key, columns)
+        else
+          # getRowWithColumnsTs
+          trow_results = connection.client.getRowWithColumnsTs(table.name, key, columns, timestamp.to_i64)
+        end
+      end
+
+      unless trow_results.empty?
+        trow_results.first.columns.inject({}) do |hash, (col_name, tcell)|
+          hash[col_name.to_sym] = HbaseAdapter::Cell.new(connection, self, col_name, tcell) if tcell
+          hash
+        end
+      end
+    end
+    
+    def delete!(col, options = {})
+      timestamp = options[:timestamp]
+      
+      if timestamp.nil?
+        connection.client.deleteAll(table.name, key.to_s, col.to_s)
+      else
+        connection.client.deleteAllTs(table.name, key.to_s, col.to_s, timestamp.to_i64)
+      end
+    end
+    
+    def mutate!(options = {}, &blk)
+      timestamp = options[:timestamp]
+      
+      ml = HbaseAdapter::MutationList.new(&blk)
+      
+      if timestamp.nil?
+        connection.client.mutateRow(table.name, key, ml.to_thrift)
+      else
+        connection.client.mutateRowTs(table.name, key, ml.to_thrift, timestamp.to_i64)
+      end
+    end
+  end
+end

data/lib/hbase_adapter/table.rb

@@ -0,0 +1,74 @@
+require 'hbase_adapter/column_family'
+require 'hbase_adapter/mutation'
+
+module HbaseAdapter
+  class Table
+    attr_reader :connection, :table_name
+    
+    def initialize(connection, table_name)
+      @connection = connection
+      @table_name = table_name
+    end
+    
+    def name
+      table_name
+    end
+    
+    def enable!
+      connection.client.enableTable(table_name)
+    end
+
+    def disable!
+      connection.client.disableTable(table_name)
+    end
+
+    def enabled?
+      connection.client.isTableEnabled(table_name)
+    end
+
+    def compact!
+      connection.client.compact(table_name)
+    end
+
+    def major_compact!
+      connection.client.majorCompact(table_name)
+    end
+
+    def columns
+      connection.client.getColumnDescriptors(table_name).inject({}) do|hash, (col_name, col)|
+        hash[col_name.to_sym] = HbaseAdapter::ColumnFamily.new(col)
+        hash
+      end
+    end
+    
+    def regions
+      connection.client.getTableRegions(table_name)
+    end
+    
+    def [](row_key)
+      HbaseAdapter::Row.new(connection, self, row_key)
+    end
+    
+    def delete_row!(key, options = {})
+      timestamp = options[:timestamp]
+      
+      if timestamp.nil?
+        connection.client.deleteAllRow(table_name, key.to_s)
+      else
+        connection.client.deleteAllRowTs(table_name, key.to_s, timestamp.to_i64)
+      end
+    end
+    
+    def mutate!(options = {}, &blk)
+      timestamp = options[:timestamp]
+      
+      ml = HbaseAdapter::MutationList.new(&blk)
+      
+      if timestamp.nil?
+        connection.client.mutateRows(table_name, ml.to_thrift)
+      else
+        connection.client.mutateRowsTs(table_name, ml.to_thrift, timestamp.to_i64)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: hbase-adapter
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrew O'Brien
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hbase-thrift
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 69
+        segments: 
+        - 0
+        - 20
+        - 5
+        version: 0.20.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Wrapping up all of that HBase Thrift stuff so you can use it.
+email: 
+- obrien.andrew@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/core_ext/time_ext.rb
+- lib/hbase-adapter.rb
+- lib/hbase_adapter/cell.rb
+- lib/hbase_adapter/column_family.rb
+- lib/hbase_adapter/connection.rb
+- lib/hbase_adapter/mutation.rb
+- lib/hbase_adapter/row.rb
+- lib/hbase_adapter/table.rb
+- LICENSE.txt
+- README.textile
+has_rdoc: true
+homepage: http://github.com/AndrewO/hbase-adapter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: hbase-adapter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the HBase Thrift interface.
+test_files: []
+