Class: HBase
- Inherits:
-
Object
- Object
- HBase
- Includes:
- Admin
- Defined in:
- lib/hbase-jruby/hbase.rb,
lib/hbase-jruby/cell.rb,
lib/hbase-jruby/util.rb,
lib/hbase-jruby/admin.rb,
lib/hbase-jruby/table.rb,
lib/hbase-jruby/result.rb,
lib/hbase-jruby/scoped.rb,
lib/hbase-jruby/version.rb,
lib/hbase-jruby/byte_array.rb,
lib/hbase-jruby/column_key.rb,
lib/hbase-jruby/dependency.rb,
lib/hbase-jruby/table/admin.rb,
lib/hbase-jruby/table/inspection.rb,
lib/hbase-jruby/scoped/aggregation.rb
Overview
HBase connection
Defined Under Namespace
Modules: Admin, JRuby, Util Classes: ByteArray, Cell, ColumnKey, Result, Scoped, Table
Constant Summary collapse
- SUPPORTED_PROFILES =
{ # Prefix => Latest version 'cdh4.1' => 'cdh4.1.3', 'cdh3' => 'cdh3u5', '0.94' => '0.94.3', '0.92' => '0.92.1', }
Instance Attribute Summary collapse
- #cf ⇒ Object readonly
- #config ⇒ Object readonly
- #java ⇒ Object readonly
- #name ⇒ Object readonly
- #table ⇒ Object (also: #[]) readonly
Class Method Summary collapse
-
.ByteArray(*values) ⇒ Object
Shortcut method to HBase::ByteArray.new.
-
.ColumnKey(cf, cq) ⇒ Object
Shortcut method to HBase::ColumnKey.new.
-
.import_java_classes! ⇒ Array<String>
Import Java classes (Prerequisite for classes in hbase-jruby).
- .log4j=(arg) ⇒ Object
- .resolve_dependency!(dist, options = {}) ⇒ Object
Instance Method Summary collapse
-
#admin {|admin| ... } ⇒ org.apache.hadoop.hbase.client.HBaseAdmin
Returns an HBaseAdmin object for administration.
-
#close ⇒ nil
Closes HTablePool and connection.
-
#closed? ⇒ Boolean
Returns whether if the connection is closed.
-
#initialize(config = {}) ⇒ HBase
constructor
Connects to HBase.
-
#table_names ⇒ Array<String>
(also: #list)
Returns the list of table names.
-
#tables ⇒ Array<HBase::Table>
Returns the list of HBase::Table instances.
Constructor Details
#initialize(config = {}) ⇒ HBase
Connects to HBase
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/hbase-jruby/hbase.rb', line 37 def initialize config = {} begin org.apache.hadoop.conf.Configuration rescue NameError raise NameError.new( "Required Java classes not loaded. Set up CLASSPATH or try `HBase.resolve_dependency!`") end HBase.import_java_classes! @config = case config when org.apache.hadoop.conf.Configuration config else HBaseConfiguration.create.tap do |hbcfg| config.each do |k, v| hbcfg.set k.to_s, v.to_s end end end @htable_pool = HTablePool.new @config, java.lang.Integer::MAX_VALUE @closed = false end |
Instance Attribute Details
#cf ⇒ Object (readonly)
|
# File 'lib/hbase-jruby/column_key.rb', line 11
|
#config ⇒ Object (readonly)
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/hbase-jruby/hbase.rb', line 6 class HBase attr_reader :config include Admin # @overload HBase.log4j=(filename) # Configure Log4j logging with the given file # @param [String] filename Path to log4j.properties file # @return [nil] # @overload HBase.log4j=(hash) # Configure Log4j logging with the given Hash # @param [Hash] hash Log4j properties in Ruby Hash # @return [nil] # @overload HBase.log4j=(props) # Configure Log4j logging with the given Properties # @param [java.util.Properties] props Properties object # @return [nil] def self.log4j= arg if arg.is_a?(Hash) props = java.util.Properties.new arg.each do |k, v| props.setProperty k.to_s, v.to_s end arg = props end org.apache.log4j.PropertyConfigurator.configure arg end # Connects to HBase # @param [Hash] config A key-value pairs to build HBaseConfiguration from def initialize config = {} begin org.apache.hadoop.conf.Configuration rescue NameError raise NameError.new( "Required Java classes not loaded. Set up CLASSPATH or try `HBase.resolve_dependency!`") end HBase.import_java_classes! @config = case config when org.apache.hadoop.conf.Configuration config else HBaseConfiguration.create.tap do |hbcfg| config.each do |k, v| hbcfg.set k.to_s, v.to_s end end end @htable_pool = HTablePool.new @config, java.lang.Integer::MAX_VALUE @closed = false end # Returns an HBaseAdmin object for administration # @yield [admin] An HBaseAdmin object # @yieldparam [org.apache.hadoop.hbase.client.HBaseAdmin] admin # @return [org.apache.hadoop.hbase.client.HBaseAdmin] def admin check_closed if block_given? with_admin { |admin| yield admin } else HBaseAdmin.new @config end end # Closes HTablePool and connection # @return [nil] def close unless @closed @htable_pool.close HConnectionManager.deleteConnection(@config, true) @closed = true end end # Returns whether if the connection is closed # @return [Boolean] def closed? @closed end # Returns the list of HBase::Table instances # @return [Array<HBase::Table>] def tables check_closed table_names.map { |tn| table(tn) } end # Returns the list of table names # @return [Array<String>] def table_names check_closed with_admin { |admin| admin.list_tables.map(&:name_as_string) } end alias list table_names # Creates an HBase::Table instance for the specified name # @param [#to_s] table_name The name of the table # @return [HBase::Table] def table table_name check_closed ht = HBase::Table.send :new, self, @config, @htable_pool, table_name if block_given? yield ht else ht end end alias [] table private def check_closed raise RuntimeError, "Connection already closed" if closed? end end |
#java ⇒ Object (readonly)
|
# File 'lib/hbase-jruby/cell.rb', line 3
|
#name ⇒ Object (readonly)
|
# File 'lib/hbase-jruby/table.rb', line 5
|
Class Method Details
.ByteArray(*values) ⇒ Object
Shortcut method to HBase::ByteArray.new
5 6 7 |
# File 'lib/hbase-jruby/byte_array.rb', line 5 def ByteArray *values ByteArray.new(*values) end |
.ColumnKey(cf, cq) ⇒ Object
Shortcut method to HBase::ColumnKey.new
6 7 8 |
# File 'lib/hbase-jruby/column_key.rb', line 6 def ColumnKey cf, cq ColumnKey.new cf, cq end |
.import_java_classes! ⇒ Array<String>
Import Java classes (Prerequisite for classes in hbase-jruby)
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/hbase-jruby/dependency.rb', line 114 def import_java_classes! imp = lambda { |hash| hash.map { |base, classes| base.class_eval do classes.map { |klass| begin java_import klass nil rescue NameError => e klass end }.compact end }.flatten } imp.call( HBase => %w[ org.apache.hadoop.hbase.HBaseConfiguration org.apache.hadoop.hbase.client.HBaseAdmin org.apache.hadoop.hbase.client.HConnectionManager org.apache.hadoop.hbase.client.HTablePool ], HBase::Util => %w[ java.nio.ByteBuffer org.apache.hadoop.hbase.KeyValue org.apache.hadoop.hbase.util.Bytes ], HBase::ByteArray => %w[ java.util.Arrays org.apache.hadoop.hbase.util.Bytes ], HBase::Cell => %w[ org.apache.hadoop.hbase.KeyValue ], HBase::Result => %w[ org.apache.hadoop.hbase.util.Bytes ], HBase::ColumnKey => %w[ java.util.Arrays org.apache.hadoop.hbase.util.Bytes ], HBase::Table => %w[ org.apache.hadoop.hbase.HColumnDescriptor org.apache.hadoop.hbase.HTableDescriptor org.apache.hadoop.hbase.client.Delete org.apache.hadoop.hbase.client.Increment org.apache.hadoop.hbase.client.Put org.apache.hadoop.hbase.io.hfile.Compression org.apache.hadoop.hbase.regionserver.StoreFile ], HBase::Scoped => %w[ org.apache.hadoop.hbase.client.Get org.apache.hadoop.hbase.client.Scan org.apache.hadoop.hbase.filter.BinaryComparator org.apache.hadoop.hbase.filter.ColumnPaginationFilter org.apache.hadoop.hbase.filter.ColumnRangeFilter org.apache.hadoop.hbase.filter.CompareFilter org.apache.hadoop.hbase.filter.FilterBase org.apache.hadoop.hbase.filter.FilterList org.apache.hadoop.hbase.filter.KeyOnlyFilter org.apache.hadoop.hbase.filter.FirstKeyOnlyFilter org.apache.hadoop.hbase.filter.MultipleColumnPrefixFilter org.apache.hadoop.hbase.filter.PrefixFilter org.apache.hadoop.hbase.filter.RegexStringComparator org.apache.hadoop.hbase.filter.RowFilter org.apache.hadoop.hbase.filter.SingleColumnValueFilter org.apache.hadoop.hbase.filter.WhileMatchFilter org.apache.hadoop.hbase.client.coprocessor.AggregationClient org.apache.hadoop.hbase.client.coprocessor.LongColumnInterpreter ]).tap { |not_found| if not_found.empty? self.instance_eval do def import_java_classes! [] end end end } end |
.HBase.log4j=(filename) ⇒ nil .HBase.log4j=(hash) ⇒ nil .HBase.log4j=(props) ⇒ nil
23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/hbase-jruby/hbase.rb', line 23 def self.log4j= arg if arg.is_a?(Hash) props = java.util.Properties.new arg.each do |k, v| props.setProperty k.to_s, v.to_s end arg = props end org.apache.log4j.PropertyConfigurator.configure arg end |
.resolve_dependency!(dist, options) ⇒ Array<String> .resolve_dependency!(pom_path, options) ⇒ Array<String>
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/hbase-jruby/dependency.rb', line 32 def resolve_dependency! dist, = {} # Backward-compatibility = { :verbose => } if [true, false].include?() = { :verbose => false }.merge() dist = dist.to_s verbose = [:verbose] silencer = verbose ? '' : '> /dev/null' tempfiles = [] jars = if %w[hbase local].include?(dist) # Check for hbase executable hbase = `which hbase` raise RuntimeError, "Cannot find `hbase` executable" if hbase.empty? `hbase classpath`.split(':') else # Check for Maven executable mvn = `which mvn` raise RuntimeError, "Cannot find `mvn` executable" if mvn.empty? # POM file path given (with optional profile) if File.exists?(dist) path = dist profile = [:profile] && "-P #{[:profile]}" # Predefined dependencies else matched_profiles = SUPPORTED_PROFILES.keys.select { |pf| dist.start_with? pf } if matched_profiles.length != 1 raise ArgumentError, "Invalid profile: #{dist}" end matched_profile = matched_profiles.first profiles = SUPPORTED_PROFILES.dup profiles[matched_profile] = dist if dist != matched_profile tempfiles << tf = Tempfile.new('hbase-jruby-pom') erb = ERB.new(File.read File.("../pom/pom.xml.erb", __FILE__)) tf << erb.result(binding) tf.close(false) path = tf.path profile = "-P #{matched_profile}" end # Download dependent JAR files and build classpath string tempfiles << tf = Tempfile.new('hbase-jruby-classpath') tf.close(false) system "mvn org.apache.maven.plugins:maven-dependency-plugin:2.5.1:resolve org.apache.maven.plugins:maven-dependency-plugin:2.5.1:build-classpath -Dsilent=true -Dmdep.outputFile=#{tf.path} #{profile} -f #{path} #{silencer}" raise RuntimeError.new("Error occurred. Set verbose option to see the log.") unless $?.exitstatus == 0 if File.read(tf.path).empty? desc = if [:profile] "#{dist} (#{[:profile]})" else dist end raise ArgumentError.new("Invalid profile: #{desc}") end File.read(tf.path).split(':') end # Load jars jars_loaded = jars.select { |jar| File.exists?(jar) && File.extname(jar) == '.jar' && require(jar) } # Try importing Java classes again not_found = HBase.import_java_classes! if verbose && !not_found.empty? warn "Java classes not found: #{not_found.join(', ')}" end return jars_loaded ensure tempfiles.each { |tempfile| tempfile.unlink rescue nil } end |
Instance Method Details
#admin {|admin| ... } ⇒ org.apache.hadoop.hbase.client.HBaseAdmin
Returns an HBaseAdmin object for administration
66 67 68 69 70 71 72 73 |
# File 'lib/hbase-jruby/hbase.rb', line 66 def admin check_closed if block_given? with_admin { |admin| yield admin } else HBaseAdmin.new @config end end |
#close ⇒ nil
Closes HTablePool and connection
77 78 79 80 81 82 83 |
# File 'lib/hbase-jruby/hbase.rb', line 77 def close unless @closed @htable_pool.close HConnectionManager.deleteConnection(@config, true) @closed = true end end |
#closed? ⇒ Boolean
Returns whether if the connection is closed
87 88 89 |
# File 'lib/hbase-jruby/hbase.rb', line 87 def closed? @closed end |
#table_names ⇒ Array<String> Also known as: list
Returns the list of table names
100 101 102 103 |
# File 'lib/hbase-jruby/hbase.rb', line 100 def table_names check_closed with_admin { |admin| admin.list_tables.map(&:name_as_string) } end |
#tables ⇒ Array<HBase::Table>
Returns the list of HBase::Table instances
93 94 95 96 |
# File 'lib/hbase-jruby/hbase.rb', line 93 def tables check_closed table_names.map { |tn| table(tn) } end |