| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.hadoop.hbase.thrift2 (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.hadoop.hbase.thrift2 (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/thrift/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/thrift2/client/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/thrift2/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.hadoop.hbase.thrift2</h1> |
| <div class="docSummary"> |
| <div class="block">Provides an HBase <a href="http://thrift.apache.org/">Thrift</a> |
| service.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/thrift2/DemoClient.html" title="class in org.apache.hadoop.hbase.thrift2">DemoClient</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/thrift2/ThriftHBaseServiceHandler.html" title="class in org.apache.hadoop.hbase.thrift2">ThriftHBaseServiceHandler</a></td> |
| <td class="colLast"> |
| <div class="block">This class is a glue object that connects Thrift RPC calls to the HBase client API primarily |
| defined in the Table interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/thrift2/ThriftServer.html" title="class in org.apache.hadoop.hbase.thrift2">ThriftServer</a></td> |
| <td class="colLast"> |
| <div class="block">ThriftServer - this class starts up a Thrift server which implements the HBase API specified in |
| the HbaseClient.thrift IDL file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/thrift2/ThriftUtilities.html" title="class in org.apache.hadoop.hbase.thrift2">ThriftUtilities</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/thrift2/ThriftHBaseServiceHandler.TIOErrorWithCause.html" title="class in org.apache.hadoop.hbase.thrift2">ThriftHBaseServiceHandler.TIOErrorWithCause</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.hadoop.hbase.thrift2 Description">Package org.apache.hadoop.hbase.thrift2 Description</h2> |
| <div class="block">Provides an HBase <a href="http://thrift.apache.org/">Thrift</a> |
| service. |
| |
| This package contains a Thrift interface definition file for an HBase RPC |
| service and a Java server implementation. |
| |
| There are currently 2 thrift server implementations in HBase, the packages: |
| |
| <ul> |
| <li>org.apache.hadoop.hbase.thrift: This may one day be marked as depreceated.</li> |
| <li>org.apache.hadoop.hbase.thrift2: i.e. this package. This is intended to closely match to the HTable interface and |
| to one day supercede the older thrift (the old thrift mimics an API HBase no longer has).</li> |
| </ul> |
| |
| <h2><a name="whatisthrift">What is Thrift?</a></h2> |
| |
| |
| <p>"Thrift is a software framework for scalable cross-language services |
| development. It combines a software stack with a code generation engine to |
| build services that work efficiently and seamlessly between C++, Java, Python, |
| PHP, Ruby, Erlang, Perl, Haskell, C#, Cocoa, JavaScript, Node.js, Smalltalk, |
| and OCaml. Originally developed at Facebook, Thrift was open sourced in April |
| 2007 and entered the Apache Incubator in May, 2008". |
| From http://thrift.apache.org/</p> |
| |
| <h2><a name="description">Description</a></h2> |
| |
| <p>The HBase API is defined in the |
| file hbase.thrift. A server-side implementation of the API is in |
| <code>org.apache.hadoop.hbase.thrift2.ThriftHBaseServiceHandler</code> with the |
| server boiler plate in <code>org.apache.hadoop.hbase.thrift2.ThriftServer</code>. |
| The generated interfaces, types, and RPC utility files are checked into SVN under the |
| <code>org.apache.hadoop.hbase.thrift2.generated</code> directory. |
| </p> |
| <p>To stop, use: |
| <pre> |
| ./bin/hbase-daemon.sh stop thrift2 |
| </pre> |
| |
| These are the command line arguments the Thrift server understands in addition to <code>start</code> and <code>stop</code>: |
| <dl> |
| <dt><code>-b, --bind</code></dt> |
| <dd>Address to bind the Thrift server to. Not supported by the Nonblocking and HsHa server [default: <code>0.0.0.0</code>]</dd> |
| |
| <dt><code>-p, --port</code></dt> |
| <dd>Port to bind to [default: <code>9090</code>]</dd> |
| |
| <dt><code>-f, --framed</code></dt> |
| <dd>Use framed transport (implied when using one of the non-blocking servers)</dd> |
| |
| <dt><code>-c, --compact</code></dt> |
| <dd>Use the compact protocol [default: binary protocol]</dd> |
| |
| <dt><code>-h, --help</code></dt> |
| <dd>Displays usage information for the Thrift server</dd> |
| |
| <dt><code>-threadpool</code></dt> |
| <dd>Use the TThreadPoolServer. This is the default.</dd> |
| |
| <dt><code>-hsha</code></dt> |
| <dd>Use the THsHaServer. This implies the framed transport.</dd> |
| |
| <dt><code>-nonblocking</code></dt> |
| <dd>Use the TNonblockingServer. This implies the framed transport.</dd> |
| </dl> |
| |
| <h3><a name="details">Details</a></h3> |
| |
| <p>HBase currently uses version 0.9.0 of Apache Thrift.</p> |
| <p>The files were generated by running the commands under the hbase checkout dir: |
| <pre> |
| mvn compile -Pcompile-thrift |
| </pre> |
| |
| <p>The 'thrift' binary is the Thrift compiler, and it is distributed separately from HBase |
| in a Thrift release. Additionally, specific language runtime libraries are a |
| part of a Thrift release. A version of the Java runtime is included in HBase via maven. |
| </p></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/thrift/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/thrift2/client/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/thrift2/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
