<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: HBaseRb::Table</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">HBaseRb::Table</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/hbaserb/table_rb.html">
lib/hbaserb/table.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000020">atomic_increment</a>
<a href="#M000012">column_families</a>
<a href="#M000021">create_scanner</a>
<a href="#M000017">delete</a>
<a href="#M000019">delete_cells</a>
<a href="#M000018">delete_row</a>
<a href="#M000014">get</a>
<a href="#M000015">get_last</a>
<a href="#M000016">get_row</a>
<a href="#M000022">mutate_row</a>
<a href="#M000011">new</a>
<a href="#M000013">regions</a>
<a href="#M000023">to_s</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000011" class="method-detail">
<a name="M000011"></a>
<div class="method-heading">
<a href="#M000011" class="method-signature">
<span class="method-name">new</span><span class="method-args">(client, name)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000011-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 4</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">client</span>, <span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@client</span> = <span class="ruby-identifier">client</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000020" class="method-detail">
<a name="M000020"></a>
<div class="method-heading">
<a href="#M000020" class="method-signature">
<span class="method-name">atomic_increment</span><span class="method-args">(row, column, value=1)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000020-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 44</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">atomic_increment</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">column</span>, <span class="ruby-identifier">value</span>=<span class="ruby-value">1</span>)
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:atomicIncrement</span>, <span class="ruby-identifier">row</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">column</span>, <span class="ruby-identifier">value</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="#M000012" class="method-signature">
<span class="method-name">column_families</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000012-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 9</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">column_families</span>
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:getColumnDescriptors</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000021" class="method-detail">
<a name="M000021"></a>
<div class="method-heading">
<a href="#M000021" class="method-signature">
<span class="method-name">create_scanner</span><span class="method-args">(row=nil, *columns, &block)</span>
</a>
</div>
<div class="method-description">
<p>
pass in no params to scan whole table
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000021-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 49</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_scanner</span>(<span class="ruby-identifier">row</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">columns</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">row</span> <span class="ruby-operator">||=</span> <span class="ruby-value str">""</span>
<span class="ruby-identifier">columns</span> = (<span class="ruby-identifier">columns</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">columns</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">column_families</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-identifier">sid</span> = <span class="ruby-identifier">call</span> <span class="ruby-identifier">:scannerOpen</span>, <span class="ruby-identifier">row</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">columns</span>
<span class="ruby-constant">Scanner</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@client</span>, <span class="ruby-identifier">sid</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="#M000017" class="method-signature">
<span class="method-name">delete</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000017-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 31</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:disableTable</span>
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:deleteTable</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000019" class="method-detail">
<a name="M000019"></a>
<div class="method-heading">
<a href="#M000019" class="method-signature">
<span class="method-name">delete_cells</span><span class="method-args">(row, column)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000019-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 40</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_cells</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">column</span>)
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:deleteAll</span>, <span class="ruby-identifier">row</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">column</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="#M000018" class="method-signature">
<span class="method-name">delete_row</span><span class="method-args">(row)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000018-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 36</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_row</span>(<span class="ruby-identifier">row</span>)
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:deleteAllRow</span>, <span class="ruby-identifier">row</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="#M000014" class="method-signature">
<span class="method-name">get</span><span class="method-args">(row, column)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000014-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 17</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">column</span>)
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:get</span>, <span class="ruby-identifier">row</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">column</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="#M000015" class="method-signature">
<span class="method-name">get_last</span><span class="method-args">(row, column, default=nil)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Table.html#M000014">get</a> the last value for the given row /
column
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000015-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 22</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_last</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">column</span>, <span class="ruby-identifier">default</span>=<span class="ruby-keyword kw">nil</span>)
<span class="ruby-identifier">r</span> = <span class="ruby-identifier">get</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">column</span>)
(<span class="ruby-identifier">r</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">value</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">default</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="#M000016" class="method-signature">
<span class="method-name">get_row</span><span class="method-args">(row)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000016-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 27</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_row</span>(<span class="ruby-identifier">row</span>)
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:getRow</span>, <span class="ruby-identifier">row</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000022" class="method-detail">
<a name="M000022"></a>
<div class="method-heading">
<a href="#M000022" class="method-signature">
<span class="method-name">mutate_row</span><span class="method-args">(row, mutations)</span>
</a>
</div>
<div class="method-description">
<p>
mutations is a key / value pair to insert / update for the given row the
keys are in the form "family:column"
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000022-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 58</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mutate_row</span>(<span class="ruby-identifier">row</span>, <span class="ruby-identifier">mutations</span>)
<span class="ruby-identifier">mutations</span> = <span class="ruby-identifier">mutations</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">Apache</span><span class="ruby-operator">::</span><span class="ruby-constant">Hadoop</span><span class="ruby-operator">::</span><span class="ruby-constant">Hbase</span><span class="ruby-operator">::</span><span class="ruby-constant">Thrift</span><span class="ruby-operator">::</span><span class="ruby-constant">Mutation</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:column</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">k</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">v</span>) }
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:mutateRow</span>, <span class="ruby-identifier">row</span>, <span class="ruby-identifier">mutations</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="#M000013" class="method-signature">
<span class="method-name">regions</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000013-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 13</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">regions</span>
<span class="ruby-identifier">call</span> <span class="ruby-identifier">:getTableRegions</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000023" class="method-detail">
<a name="M000023"></a>
<div class="method-heading">
<a href="#M000023" class="method-signature">
<span class="method-name">to_s</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000023-source">
<pre>
<span class="ruby-comment cmt"># File lib/hbaserb/table.rb, line 63</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">s</span> = <span class="ruby-value str">""</span>
<span class="ruby-identifier">create_scanner</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">cols</span> = <span class="ruby-identifier">r</span>.<span class="ruby-identifier">columns</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-node">"#{k}: #{v.value}"</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-value str">", "</span>)
<span class="ruby-identifier">s</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"#{r.row}: #{cols}\n"</span>
}
<span class="ruby-identifier">s</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>