Repository: incubator-zeppelin Updated Branches: refs/heads/master a4e81ade6 -> a959cbc53
[DOC] Update doc for HBase interpreter ### What is this PR for? Update HBase interpreter for style and additional info ### What type of PR is it? Documentation ### Todos * [x] - Update doc ### Is there a relevant Jira issue? N/A ### How should this be tested? N/A ### Screenshots (if appropriate) N/A ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? This is Author: Felix Cheung <[email protected]> Closes #686 from felixcheung/hbasedoc and squashes the following commits: cd124c5 [Felix Cheung] fix wording c79f46e [Felix Cheung] doc update Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/a959cbc5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/a959cbc5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/a959cbc5 Branch: refs/heads/master Commit: a959cbc533d3954e3537ca3809dabaed422e494c Parents: a4e81ad Author: Felix Cheung <[email protected]> Authored: Tue Feb 2 21:46:22 2016 -0800 Committer: Felix Cheung <[email protected]> Committed: Wed Feb 3 17:16:03 2016 -0800 ---------------------------------------------------------------------- docs/interpreter/hbase.md | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/a959cbc5/docs/interpreter/hbase.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/hbase.md b/docs/interpreter/hbase.md index 30cec44..05031f2 100644 --- a/docs/interpreter/hbase.md +++ b/docs/interpreter/hbase.md @@ -6,15 +6,13 @@ group: manual --- {% include JB/setup %} - ## HBase Shell Interpreter for Apache Zeppelin -[HBase Shell](http://hbase.apache.org/book.html#shell) 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 its possible to -connect to the Apache HBase cluster from the machine on where Apache Zeppelin is installed. +[HBase Shell](http://hbase.apache.org/book.html#shell) 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. +To get start with HBase, please see [HBase Quickstart](https://hbase.apache.org/book.html#quickstart) + +> Note: currently only HBase 1.0.x releases are supported. -<br /> -## 1. Configuration +## Configuration <table class="table-configuration"> <tr> @@ -39,19 +37,31 @@ connect to the Apache HBase cluster from the machine on where Apache Zeppelin is </tr> </table> -## 2. Enabling the HBase Shell Interpreter +## Enabling the HBase Shell Interpreter + +In a notebook, to enable the **HBase Shell** interpreter, click the **Gear** icon and select **HBase Shell**. + +## Using the HBase Shell Interpreter + +In a paragraph, use `%hbase` to select the **HBase Shell** interpreter and then input all commands. To get the list of available commands, use `help`. -In a notebook, to enable the **HBase Shell** interpreter, click the **Gear** icon and select -**HBase Shell**. +```bash +%hbase +help +``` + +For example, to create a table -## 3. Using the HBase Shell Interpreter +```bash +%hbase +create 'test', 'cf' +``` -In a paragraph, use `%hbase` to select the **HBase Shell** interpreter and then input all commands. - To get the list of available commands, use `help`. +And then to put data into that table ```bash -| %hbase -| help +%hbase +put 'test', 'row1', 'cf:a', 'value1' ``` -For more information on all commands available, refer to [HBase Shell Documentation](http://hbase.apache.org/book.html#shell) \ No newline at end of file +For more information on all commands available, refer to [HBase shell commands](https://learnhbase.wordpress.com/2013/03/02/hbase-shell-commands/)
