blob: 1300c145f8556172e18e1dfb56d029e96bd4e43b [file] [log] [blame]
<!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>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>BasicExample xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../target/site/apidocs/org/apache/omid/examples/BasicExample.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <strong class="jxr_keyword">package</strong> org.apache.omid.examples;
<a class="jxr_linenumber" name="19" href="#19">19</a>
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.client.Connection;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.client.ConnectionFactory;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.client.Put;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.hadoop.hbase.util.Bytes;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.omid.transaction.HBaseTransactionManager;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.omid.transaction.TTable;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.omid.transaction.Transaction;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.omid.transaction.TransactionManager;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="31" href="#31">31</a>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * ****************************************************************************************************</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Example code which demonstrates an atomic write into two different rows in HBase</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * ****************************************************************************************************</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * After building the package with 'mvn clean package' find the resulting examples-{version}-bin.tar.gz file in the</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * 'examples/target' folder. Copy it to the target host and expand with 'tar -zxvf examples-{version}-bin.tar.gz'.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Make sure that 'hbase-site.xml' and 'core-site.xml' are either in classpath (see run.sh) or explicitly referenced in</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * configuration file. If a secure HBase deployment is needed, make sure to specify the principal (user) and keytab file.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * The example requires a user table to perform transactional read/write operations. A table is already specified in</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * the default configuration, and can be created with the following command using the 'hbase shell':</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * create 'MY_TX_TABLE', {NAME =&amp;gt; 'MY_CF', VERSIONS =&amp;gt; '2147483647', TTL =&amp;gt; '2147483647'}</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Make sure that the principal/user has RW permissions for the given table using also the 'hbase shell':</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * grant '{principal/user}', 'RW', 'MY_TX_TABLE'</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Alternatively, a table with a column family already created can be used by specifying the table name and column</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * family identifiers using the command line arguments (see details also in 'run.sh') If a table namespace is required,</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * specify it like this: 'namespace:table_name'</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Finally, run the example using the 'run.sh' script without arguments or specifying the necessary configuration</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * parameters.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/omid/examples/BasicExample.html">BasicExample</a> {
<a class="jxr_linenumber" name="65" href="#65">65</a>
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(BasicExample.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="67" href="#67">67</a>
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> main(String[] args) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="69" href="#69">69</a>
<a class="jxr_linenumber" name="70" href="#70">70</a> LOG.info(<span class="jxr_string">"Parsing command line arguments"</span>);
<a class="jxr_linenumber" name="71" href="#71">71</a> String userTableName = <span class="jxr_string">"MY_TX_TABLE"</span>;
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> (args != <strong class="jxr_keyword">null</strong> &amp;&amp; args.length &gt; 0 &amp;&amp; StringUtils.isNotEmpty(args[0])) {
<a class="jxr_linenumber" name="73" href="#73">73</a> userTableName = args[0];
<a class="jxr_linenumber" name="74" href="#74">74</a> }
<a class="jxr_linenumber" name="75" href="#75">75</a> byte[] family = Bytes.toBytes(<span class="jxr_string">"MY_CF"</span>);
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">if</strong> (args != <strong class="jxr_keyword">null</strong> &amp;&amp; args.length &gt; 1 &amp;&amp; StringUtils.isNotEmpty(args[1])) {
<a class="jxr_linenumber" name="77" href="#77">77</a> family = Bytes.toBytes(args[1]);
<a class="jxr_linenumber" name="78" href="#78">78</a> }
<a class="jxr_linenumber" name="79" href="#79">79</a> LOG.info(<span class="jxr_string">"Table '{}', column family '{}'"</span>, userTableName, Bytes.toString(family));
<a class="jxr_linenumber" name="80" href="#80">80</a>
<a class="jxr_linenumber" name="81" href="#81">81</a> byte[] exampleRow1 = Bytes.toBytes(<span class="jxr_string">"EXAMPLE_ROW1"</span>);
<a class="jxr_linenumber" name="82" href="#82">82</a> byte[] exampleRow2 = Bytes.toBytes(<span class="jxr_string">"EXAMPLE_ROW2"</span>);
<a class="jxr_linenumber" name="83" href="#83">83</a> byte[] qualifier = Bytes.toBytes(<span class="jxr_string">"MY_Q"</span>);
<a class="jxr_linenumber" name="84" href="#84">84</a> byte[] dataValue1 = Bytes.toBytes(<span class="jxr_string">"val1"</span>);
<a class="jxr_linenumber" name="85" href="#85">85</a> byte[] dataValue2 = Bytes.toBytes(<span class="jxr_string">"val2"</span>);
<a class="jxr_linenumber" name="86" href="#86">86</a>
<a class="jxr_linenumber" name="87" href="#87">87</a> LOG.info(<span class="jxr_string">"Creating access to Omid Transaction Manager &amp; Transactional Table '{}'"</span>, userTableName);
<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">try</strong> (TransactionManager tm = HBaseTransactionManager.newInstance();
<a class="jxr_linenumber" name="89" href="#89">89</a> Connection conn = ConnectionFactory.createConnection();
<a class="jxr_linenumber" name="90" href="#90">90</a> <a href="../../../../org/apache/omid/transaction/TTable.html">TTable</a> txTable = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/omid/transaction/TTable.html">TTable</a>(conn, userTableName))
<a class="jxr_linenumber" name="91" href="#91">91</a> {
<a class="jxr_linenumber" name="92" href="#92">92</a> <a href="../../../../org/apache/omid/transaction/Transaction.html">Transaction</a> tx = tm.begin();
<a class="jxr_linenumber" name="93" href="#93">93</a> LOG.info(<span class="jxr_string">"Transaction {} STARTED"</span>, tx);
<a class="jxr_linenumber" name="94" href="#94">94</a>
<a class="jxr_linenumber" name="95" href="#95">95</a> Put row1 = <strong class="jxr_keyword">new</strong> Put(exampleRow1);
<a class="jxr_linenumber" name="96" href="#96">96</a> row1.addColumn(family, qualifier, dataValue1);
<a class="jxr_linenumber" name="97" href="#97">97</a> txTable.put(tx, row1);
<a class="jxr_linenumber" name="98" href="#98">98</a> LOG.info(<span class="jxr_string">"Transaction {} trying to write a new value in [TABLE:ROW/CF/Q] =&gt; {}:{}/{}/{} = {} "</span>,
<a class="jxr_linenumber" name="99" href="#99">99</a> tx, userTableName, Bytes.toString(exampleRow1), Bytes.toString(family),
<a class="jxr_linenumber" name="100" href="#100">100</a> Bytes.toString(qualifier), Bytes.toString(dataValue1));
<a class="jxr_linenumber" name="101" href="#101">101</a>
<a class="jxr_linenumber" name="102" href="#102">102</a> Put row2 = <strong class="jxr_keyword">new</strong> Put(exampleRow2);
<a class="jxr_linenumber" name="103" href="#103">103</a> row2.addColumn(family, qualifier, dataValue2);
<a class="jxr_linenumber" name="104" href="#104">104</a> txTable.put(tx, row2);
<a class="jxr_linenumber" name="105" href="#105">105</a> LOG.info(<span class="jxr_string">"Transaction {} trying to write a new value in [TABLE:ROW/CF/Q] =&gt; {}:{}/{}/{} = {} "</span>,
<a class="jxr_linenumber" name="106" href="#106">106</a> tx, userTableName, Bytes.toString(exampleRow2), Bytes.toString(family),
<a class="jxr_linenumber" name="107" href="#107">107</a> Bytes.toString(qualifier), Bytes.toString(dataValue2));
<a class="jxr_linenumber" name="108" href="#108">108</a>
<a class="jxr_linenumber" name="109" href="#109">109</a> tm.commit(tx);
<a class="jxr_linenumber" name="110" href="#110">110</a> LOG.info(<span class="jxr_string">"Transaction {} COMMITTED"</span>, tx);
<a class="jxr_linenumber" name="111" href="#111">111</a> }
<a class="jxr_linenumber" name="112" href="#112">112</a>
<a class="jxr_linenumber" name="113" href="#113">113</a> }
<a class="jxr_linenumber" name="114" href="#114">114</a>
<a class="jxr_linenumber" name="115" href="#115">115</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>