Apache Zeppelin 0.11.2 Documentation: HBase Shell Interpreter for Apache Zeppelin

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Apache Zeppelin 0.11.2 Documentation: HBase Shell Interpreter for Apache Zeppelin</title> <meta name="description" content="HBase Shell is a JRuby IRB client for Apache HBase. This interpreter provides all capabilities of Apache HBase shell within Apache Zeppelin."> <meta name="author" content="The Apache Software Foundation">  <meta name="viewport" content="width=device-width, initial-scale=1.0">   <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">  <link href="/docs/0.11.2/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet"> <link href="/docs/0.11.2/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css"> <link href="/docs/0.11.2/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />    <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script> <script src="/docs/0.11.2/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script> <script src="/docs/0.11.2/assets/themes/zeppelin/js/docs.js"></script> <script src="/docs/0.11.2/assets/themes/zeppelin/js/anchor.min.js"></script> <script src="/docs/0.11.2/assets/themes/zeppelin/js/toc.js"></script> <script src="/docs/0.11.2/assets/themes/zeppelin/js/lunr.min.js"></script> <script src="/docs/0.11.2/assets/themes/zeppelin/js/search.js"></script>  <link href="/docs/0.11.2/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed"> <link href="/docs/0.11.2/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed"> </head> <body> <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation"> <div class="container navbar-container"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <div class="navbar-brand"> <a class="navbar-brand-main" href="http://zeppelin.apache.org"> <img src="/docs/0.11.2/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" style="margin-top: -2px;" alt="I'm zeppelin"> <span style="margin-left: 5px; font-size: 27px;">Zeppelin</span> <a class="navbar-brand-version" href="/docs/0.11.2" style="font-size: 15px; color: white;"> 0.11.2 </a> </a> </div> </div> <nav class="navbar-collapse collapse" role="navigation"> <ul class="nav navbar-nav"> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a> <ul class="dropdown-menu"> <li class="title"><span>Getting Started</span></li> <li><a href="/docs/0.11.2/quickstart/install.html">Install</a></li> <li><a href="/docs/0.11.2/quickstart/explore_ui.html">Explore UI</a></li> <li><a href="/docs/0.11.2/quickstart/tutorial.html">Tutorial</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Run Mode</span></li> <li><a href="/docs/0.11.2/quickstart/kubernetes.html">Kubernetes</a></li> <li><a href="/docs/0.11.2/quickstart/docker.html">Docker</a></li> <li><a href="/docs/0.11.2/quickstart/yarn.html">Yarn</a></li> <li role="separator" class="divider"></li> <li><a href="/docs/0.11.2/quickstart/spark_with_zeppelin.html">Spark with Zeppelin</a></li> <li><a href="/docs/0.11.2/quickstart/flink_with_zeppelin.html">Flink with Zeppelin</a></li> <li><a href="/docs/0.11.2/quickstart/sql_with_zeppelin.html">SQL with Zeppelin</a></li> <li><a href="/docs/0.11.2/quickstart/python_with_zeppelin.html">Python with Zeppelin</a></li> <li><a href="/docs/0.11.2/quickstart/r_with_zeppelin.html">R with Zeppelin</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Usage<b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu"> <li class="title"><span>Dynamic Form</span></li> <li><a href="/docs/0.11.2/usage/dynamic_form/intro.html">What is Dynamic Form?</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Display System</span></li> <li><a href="/docs/0.11.2/usage/display_system/basic.html#text">Text Display</a></li> <li><a href="/docs/0.11.2/usage/display_system/basic.html#html">HTML Display</a></li> <li><a href="/docs/0.11.2/usage/display_system/basic.html#table">Table Display</a></li> <li><a href="/docs/0.11.2/usage/display_system/basic.html#network">Network Display</a></li> <li><a href="/docs/0.11.2/usage/display_system/angular_backend.html">Angular Display using Backend API</a></li> <li><a href="/docs/0.11.2/usage/display_system/angular_frontend.html">Angular Display using Frontend API</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Interpreter</span></li> <li><a href="/docs/0.11.2/usage/interpreter/overview.html">Overview</a></li> <li><a href="/docs/0.11.2/usage/interpreter/interpreter_binding_mode.html">Interpreter Binding Mode</a></li> <li><a href="/docs/0.11.2/usage/interpreter/user_impersonation.html">User Impersonation</a></li> <li><a href="/docs/0.11.2/usage/interpreter/dependency_management.html">Dependency Management</a></li> <li><a href="/docs/0.11.2/usage/interpreter/installation.html">Installing Interpreters</a></li>  <li><a href="/docs/0.11.2/usage/interpreter/execution_hooks.html">Execution Hooks (Experimental)</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Other Features</span></li> <li><a href="/docs/0.11.2/usage/other_features/publishing_paragraphs.html">Publishing Paragraphs</a></li> <li><a href="/docs/0.11.2/usage/other_features/personalized_mode.html">Personalized Mode</a></li> <li><a href="/docs/0.11.2/usage/other_features/customizing_homepage.html">Customizing Zeppelin Homepage</a></li> <li><a href="/docs/0.11.2/usage/other_features/notebook_actions.html">Notebook Actions</a></li> <li><a href="/docs/0.11.2/usage/other_features/cron_scheduler.html">Cron Scheduler</a></li> <li><a href="/docs/0.11.2/usage/other_features/zeppelin_context.html">Zeppelin Context</a></li> <li role="separator" class="divider"></li> <li class="title"><span>REST API</span></li> <li><a href="/docs/0.11.2/usage/rest_api/interpreter.html">Interpreter API</a></li> <li><a href="/docs/0.11.2/usage/rest_api/zeppelin_server.html">Zeppelin Server API</a></li> <li><a href="/docs/0.11.2/usage/rest_api/notebook.html">Notebook API</a></li> <li><a href="/docs/0.11.2/usage/rest_api/notebook_repository.html">Notebook Repository API</a></li> <li><a href="/docs/0.11.2/usage/rest_api/configuration.html">Configuration API</a></li> <li><a href="/docs/0.11.2/usage/rest_api/credential.html">Credential API</a></li> <li><a href="/docs/0.11.2/usage/rest_api/helium.html">Helium API</a></li> <li class="title"><span>Zeppelin SDK</span></li> <li><a href="/docs/0.11.2/usage/zeppelin_sdk/client_api.html">Client API</a></li> <li><a href="/docs/0.11.2/usage/zeppelin_sdk/session_api.html">Session API</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Setup<b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu"> <li class="title"><span>Basics</span></li> <li><a href="/docs/0.11.2/setup/basics/how_to_build.html">How to Build Zeppelin</a></li> <li><a href="/docs/0.11.2/setup/basics/hadoop_integration.html">Hadoop Integration</a></li> <li><a href="/docs/0.11.2/setup/basics/multi_user_support.html">Multi-user Support</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Deployment</span></li>  <li><a href="/docs/0.11.2/setup/deployment/spark_cluster_mode.html#spark-standalone-mode">Spark Cluster Mode: Standalone</a></li> <li><a href="/docs/0.11.2/setup/deployment/spark_cluster_mode.html#spark-on-yarn-mode">Spark Cluster Mode: YARN</a></li> <li><a href="/docs/0.11.2/setup/deployment/spark_cluster_mode.html#spark-on-mesos-mode">Spark Cluster Mode: Mesos</a></li> <li><a href="/docs/0.11.2/setup/deployment/flink_and_spark_cluster.html">Zeppelin with Flink, Spark Cluster</a></li> <li><a href="/docs/0.11.2/setup/deployment/cdh.html">Zeppelin on CDH</a></li> <li><a href="/docs/0.11.2/setup/deployment/virtual_machine.html">Zeppelin on VM: Vagrant</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Security</span></li> <li><a href="/docs/0.11.2/setup/security/authentication_nginx.html">HTTP Basic Auth using NGINX</a></li> <li><a href="/docs/0.11.2/setup/security/shiro_authentication.html">Shiro Authentication</a></li> <li><a href="/docs/0.11.2/setup/security/notebook_authorization.html">Notebook Authorization</a></li> <li><a href="/docs/0.11.2/setup/security/datasource_authorization.html">Data Source Authorization</a></li> <li><a href="/docs/0.11.2/setup/security/http_security_headers.html">HTTP Security Headers</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Notebook Storage</span></li> <li><a href="/docs/0.11.2/setup/storage/storage.html#notebook-storage-in-local-git-repository">Git Storage</a></li> <li><a href="/docs/0.11.2/setup/storage/storage.html#notebook-storage-in-s3">S3 Storage</a></li> <li><a href="/docs/0.11.2/setup/storage/storage.html#notebook-storage-in-azure">Azure Storage</a></li> <li><a href="/docs/0.11.2/setup/storage/storage.html#notebook-storage-in-google-cloud-storage">Google Cloud Storage</a></li> <li><a href="/docs/0.11.2/setup/storage/storage.html#notebook-storage-in-oss">OSS Storage</a></li> <li><a href="/docs/0.11.2/setup/storage/storage.html#notebook-storage-in-mongodb">MongoDB Storage</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Operation</span></li> <li><a href="/docs/0.11.2/setup/operation/configuration.html">Configuration</a></li> <li><a href="/docs/0.11.2/setup/operation/monitoring.html">Monitoring</a></li> <li><a href="/docs/0.11.2/setup/operation/proxy_setting.html">Proxy Setting</a></li> <li><a href="/docs/0.11.2/setup/operation/upgrading.html">Upgrading</a></li> <li><a href="/docs/0.11.2/setup/operation/trouble_shooting.html">Trouble Shooting</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu"> <li class="title"><span>Interpreters</span></li> <li><a href="/docs/0.11.2/usage/interpreter/overview.html">Overview</a></li> <li role="separator" class="divider"></li> <li><a href="/docs/0.11.2/interpreter/spark.html">Spark</a></li> <li><a href="/docs/0.11.2/interpreter/flink.html">Flink</a></li> <li><a href="/docs/0.11.2/interpreter/jdbc.html">JDBC</a></li> <li><a href="/docs/0.11.2/interpreter/python.html">Python</a></li> <li><a href="/docs/0.11.2/interpreter/r.html">R</a></li> <li role="separator" class="divider"></li> <li><a href="/docs/0.11.2/interpreter/alluxio.html">Alluxio</a></li> <li><a href="/docs/0.11.2/interpreter/bigquery.html">BigQuery</a></li> <li><a href="/docs/0.11.2/interpreter/cassandra.html">Cassandra</a></li> <li><a href="/docs/0.11.2/interpreter/elasticsearch.html">Elasticsearch</a></li> <li><a href="/docs/0.11.2/interpreter/groovy.html">Groovy</a></li> <li><a href="/docs/0.11.2/interpreter/hbase.html">HBase</a></li> <li><a href="/docs/0.11.2/interpreter/hdfs.html">HDFS</a></li> <li><a href="/docs/0.11.2/interpreter/hive.html">Hive</a></li> <li><a href="/docs/0.11.2/interpreter/influxdb.html">influxDB</a></li> <li><a href="/docs/0.11.2/interpreter/java.html">Java</a></li> <li><a href="/docs/0.11.2/interpreter/jupyter.html">Jupyter</a></li> <li><a href="/docs/0.11.2/interpreter/livy.html">Livy</a></li> <li><a href="/docs/0.11.2/interpreter/mahout.html">Mahout</a></li> <li><a href="/docs/0.11.2/interpreter/markdown.html">Markdown</a></li> <li><a href="/docs/0.11.2/interpreter/mongodb.html">MongoDB</a></li> <li><a href="/docs/0.11.2/interpreter/neo4j.html">Neo4j</a></li> <li><a href="/docs/0.11.2/interpreter/postgresql.html">Postgresql, HAWQ</a></li> <li><a href="/docs/0.11.2/interpreter/shell.html">Shell</a></li> <li><a href="/docs/0.11.2/interpreter/sparql.html">Sparql</a></li> <li><a href="/docs/0.11.2/interpreter/submarine.html">Submarine</a></li> </ul> </li> <li> <a href="#" data-toggle="dropdown" class="dropdown-toggle">More<b class="caret"></b></a> <ul class="dropdown-menu scrollable-menu" style="right: 0; left: auto;"> <li class="title"><span>Extending Zeppelin</span></li> <li><a href="/docs/0.11.2/development/writing_zeppelin_interpreter.html">Writing Zeppelin Interpreter</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Helium (Experimental)</span></li> <li><a href="/docs/0.11.2/development/helium/overview.html">Overview</a></li> <li><a href="/docs/0.11.2/development/helium/writing_application.html">Writing Helium Application</a></li> <li><a href="/docs/0.11.2/development/helium/writing_spell.html">Writing Helium Spell</a></li> <li><a href="/docs/0.11.2/development/helium/writing_visualization_basic.html">Writing Helium Visualization: Basics</a></li> <li><a href="/docs/0.11.2/development/helium/writing_visualization_transformation.html">Writing Helium Visualization: Transformation</a></li> <li role="separator" class="divider"></li> <li class="title"><span>Contributing to Zeppelin</span></li> <li><a href="/docs/0.11.2/setup/basics/how_to_build.html">How to Build Zeppelin</a></li> <li><a href="/docs/0.11.2/development/contribution/useful_developer_tools.html">Useful Developer Tools</a></li> <li><a href="/docs/0.11.2/development/contribution/how_to_contribute_code.html">How to Contribute (code)</a></li> <li><a href="/docs/0.11.2/development/contribution/how_to_contribute_website.html">How to Contribute (website)</a></li> <li role="separator" class="divider"></li> <li class="title"><span>External Resources</span></li> <li><a target="_blank" rel="noopener noreferrer" href="https://zeppelin.apache.org/community.html">Mailing List</a></li> <li><a target="_blank" rel="noopener noreferrer" href="https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home">Apache Zeppelin Wiki</a></li> <li><a target="_blank" rel="noopener noreferrer" href="http://stackoverflow.com/questions/tagged/apache-zeppelin">Stackoverflow Questions about Zeppelin</a></li> </ul> </li> <li> <a href="/docs/0.11.2/search.html" class="nav-search-link"> <span class="fa fa-search nav-search-icon"></span> </a> </li> </ul> </nav> </div> </div> <div class="content">  <div class="row"> <div class="col-md-12">  <h1>HBase Shell Interpreter for Apache Zeppelin</h1> <div id="toc"></div> <h2>Overview</h2> <p><a href="http://hbase.apache.org/book.html#shell">HBase Shell</a> is a JRuby IRB client for Apache HBase. This interpreter provides all capabilities of Apache HBase shell within Apache Zeppelin. The interpreter assumes that Apache HBase client software has been installed and it can connect to the Apache HBase cluster from the machine on where Apache Zeppelin is installed.<br> To get start with HBase, please see <a href="https://hbase.apache.org/book.html#quickstart">HBase Quickstart</a>.</p> <h2>HBase release supported</h2> <p>By default, Zeppelin is built against HBase 1.0.x releases. To work with HBase 1.1.x releases, use the following build command:</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="c"># HBase 1.1.4</span> ./mvnw clean package -DskipTests -Phadoop-2.6 -Dhadoop.version<span class="o">=</span>2.6.0 -P build-distr -Dhbase.hbase.version<span class="o">=</span>1.1.4 -Dhbase.hadoop.version<span class="o">=</span>2.6.0 </code></pre></div> <p>To work with HBase 1.2.0+, use the following build command:</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="c"># HBase 1.2.0</span> ./mvnw clean package -DskipTests -Phadoop-2.6 -Dhadoop.version<span class="o">=</span>2.6.0 -P build-distr -Dhbase.hbase.version<span class="o">=</span>1.2.0 -Dhbase.hadoop.version<span class="o">=</span>2.6.0 </code></pre></div> <h2>Configuration</h2> <table class="table-configuration"> <tr> <th>Property</th> <th>Default</th> <th>Description</th> </tr> <tr> <td>hbase.home</td> <td>/usr/lib/hbase</td> <td>Installation directory of HBase, defaults to HBASE_HOME in environment</td> </tr> <tr> <td>hbase.ruby.sources</td> <td>lib/ruby</td> <td>Path to Ruby scripts relative to 'hbase.home'</td> </tr> <tr> <td>zeppelin.hbase.test.mode</td> <td>false</td> <td>Disable checks for unit and manual tests</td> </tr> </table> <p>If you want to connect to HBase running on a cluster, you'll need to follow the next step.</p> <h3>Export HBASE_HOME</h3> <p>In <code>conf/zeppelin-env.sh</code>, export <code>HBASE_HOME</code> environment variable with your HBase installation path. This ensures <code>hbase-site.xml</code> can be loaded.</p> <p>For example</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="nb">export </span><span class="nv">HBASE_HOME</span><span class="o">=</span>/usr/lib/hbase </code></pre></div> <p>or, when running with CDH</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash"><span class="nb">export </span><span class="nv">HBASE_HOME</span><span class="o">=</span><span class="s2">"/opt/cloudera/parcels/CDH/lib/hbase"</span> </code></pre></div> <p>You can optionally export <code>HBASE_CONF_DIR</code> instead of <code>HBASE_HOME</code> should you have custom HBase configurations.</p> <h2>Enabling the HBase Shell Interpreter</h2> <p>In a notebook, to enable the <strong>HBase Shell</strong> interpreter, click the <strong>Gear</strong> icon and select <strong>HBase Shell</strong>.</p> <h2>Using the HBase Shell Interpreter</h2> <p>In a paragraph, use <code>%hbase</code> to select the <strong>HBase Shell</strong> interpreter and then input all commands. To get the list of available commands, use <code>help</code>.</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%hbase <span class="nb">help</span> </code></pre></div> <p>For example, to create a table</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%hbase create <span class="s1">'test'</span>, <span class="s1">'cf'</span> </code></pre></div> <p>And then to put data into that table</p> <div class="highlight"><pre><code class="bash language-bash" data-lang="bash">%hbase put <span class="s1">'test'</span>, <span class="s1">'row1'</span>, <span class="s1">'cf:a'</span>, <span class="s1">'value1'</span> </code></pre></div> <p>For more information on all commands available, refer to <a href="https://learnhbase.wordpress.com/2013/03/02/hbase-shell-commands/">HBase shell commands</a>.</p> </div> </div> <hr> <footer>  </footer> </div> <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-45176241-5', 'zeppelin.apache.org'); ga('require', 'linkid', 'linkid.js'); ga('send', 'pageview'); </script> </body> </html>

CINXE.COM

Apache Zeppelin 0.11.2 Documentation: HBase Shell Interpreter for Apache Zeppelin